https://github.com/hebilicious/reproduire
Github Action that comments on incomplete issues.
https://github.com/hebilicious/reproduire
Last synced: about 1 year ago
JSON representation
Github Action that comments on incomplete issues.
- Host: GitHub
- URL: https://github.com/hebilicious/reproduire
- Owner: Hebilicious
- License: mit
- Created: 2023-08-02T10:29:42.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T23:27:33.000Z (over 1 year ago)
- Last Synced: 2024-10-30T01:51:54.031Z (over 1 year ago)
- Language: JavaScript
- Size: 421 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Reproduire
GitHub action that adds a custom message to incomplete issues.
This action is intended to be in repositories where contributors needs to submit issues with a reproduction.
It enables an automated message to be added to issues that are missing a reproduction, based on a defined label.
## Add a message when an issue is flagged as incomplete
Setup the Reproduire action with a workflow file in your repository (e.g. `.github/workflows/reproduire.yml`) :
```yaml
name: Reproduire
on:
issues:
types: [labeled]
permissions:
issues: write
jobs:
reproduire:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: Hebilicious/reproduire@v1
with:
label: needs-reproduction # Optional, will default to this value.
```
You can create a custom markdown message by creating a `.github/reproduire/needs-reproduction.md` in your repository.
## Automatically close incomplete issues
You can use another action to automatically close labeled issues after a certain amount of time.
Setup a [stale](https://github.com/actions/stale) action in your repository (e.g. `.github/workflows/reproduire-close.yml`) :
```yaml
name: Close incomplete issues
on:
workflow_dispatch:
schedule:
- cron: '30 1 * * *' # run every day
permissions:
issues: write
jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v8
with:
days-before-stale: -1 # Issues and PR will never be flagged stale automatically.
stale-issue-label: needs-reproduction # Label that flags an issue as stale.
only-labels: needs-reproduction # Only process these issues
days-before-issue-close: 7
ignore-updates: true
remove-stale-when-updated: false
close-issue-message: This issue was closed because it was open for 7 days without a valid reproduction.
close-issue-label: closed-by-reproduire
```