https://github.com/instantish/milestone-closer
A GitHub Action that closes milestones that are 100% done 🚮
https://github.com/instantish/milestone-closer
automation close-milestones fabric github-action instantish milestones project-management prs
Last synced: 23 days ago
JSON representation
A GitHub Action that closes milestones that are 100% done 🚮
- Host: GitHub
- URL: https://github.com/instantish/milestone-closer
- Owner: instantish
- License: other
- Created: 2020-04-30T22:08:59.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T23:13:44.000Z (over 3 years ago)
- Last Synced: 2026-05-01T10:06:05.217Z (about 1 month ago)
- Topics: automation, close-milestones, fabric, github-action, instantish, milestones, project-management, prs
- Language: TypeScript
- Homepage: https://tryfabric.com
- Size: 18.1 MB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Close milestones that are done
Automatically closes milestones that have more than one issue/pr and all issues/prs are marked closed.
### Usage
Basic (runs every 20 minutes):
```yaml
name: "Close finished milestones"
on:
schedule:
- cron: "*/20 * * * *"
jobs:
milestone-closer:
runs-on: ubuntu-latest
steps:
- uses: instantish/milestone-closer@v1
```
Runs on issue and PR updates:
```yaml
name: "Close finished milestones"
on:
issues:
types: [opened, deleted, closed, reopened, milestoned, demilestoned]
pull_request:
types: [opened, closed, reopened]
jobs:
milestone-closer:
runs-on: ubuntu-latest
steps:
- uses: instantish/milestone-closer@v1
```
Uses a different minimum number of issues:
```yaml
name: "Close finished milestones"
on:
schedule:
- cron: "*/20 * * * *"
jobs:
milestone-closer:
runs-on: ubuntu-latest
steps:
- uses: instantish/milestone-closer@v1
with:
min-issues: 3
```
See [action.yml](./action.yml) for the full list of options.
### Debugging
To see debug ouput from this action, you must set the secret `ACTIONS_STEP_DEBUG` to `true` in your repository. You can run this action in debug only mode (no actions will be taken on your milestones) by passing `debug-only` `true` as an argument to the action.
### Building and testing
Install the dependencies
```bash
$ npm install
```
Build the package
```bash
$ npm run build
```
Run the tests :heavy_check_mark:
```bash
$ npm test
```
### More Resources
For more resources or tools to make issue tracking easier, check out [Instantish](https://itsinstantish.com) ⚡️
If you have questions about setting this up, feel free to reach out to hi@itsinstantish.com with subject line "Question about GitHub Action" 😊