https://github.com/ory/milestone-action
https://github.com/ory/milestone-action
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/ory/milestone-action
- Owner: ory
- License: apache-2.0
- Created: 2020-08-19T07:32:37.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-30T12:53:27.000Z (5 months ago)
- Last Synced: 2025-04-25T04:30:27.684Z (about 1 month ago)
- Language: JavaScript
- Size: 6.96 MB
- Stars: 6
- Watchers: 8
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# milestone-action
Generates a markdown document based on milestones, issues, pull requets, and
labels.
## Inputs
### `GITHUB_TOKEN`
**Required** The GitHub Token
### `outputFile`:
The file to write the output to
Default: `MILESTONES.md`
### `labelMilestonePrefix`
Prefix of labels that identify a milestone, for example `/cloud` becomes
`cloud/M1`. Only effective in combination with `input.orgs`.
Default: corp/
### `orgs`
Instead of checking this single repository, also check all the repositories of
the given orgs (use comma-separated values - `foo,bar,baz`) for issues with
prefixed `labelMilestonePrefix` labels.
### `ingoreMilestones`
Ignore milestones with the given names. Ignore multiple milestones with
comma-separated values (`foo,bar,baz`).
Default: unplanned
### `onlyLabels`
Only include issues and pull requests with the given labels.
Default:
bug,feat,blocking,breaking-change,good-first-issue,docs,ci,rfc,help-wanted
## Example usage
### Multi-org
```yaml
name: Generate and Publish Milestone Document
on:
schedule:
- cron: "*/5 * * * *"
workflow_dispatch:
jobs:
milestone:
name: Generate and Publish Milestone Document
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
token: ${{ secrets.TOKEN_PRIVILEGED }}
- name: Milestone Documentation Generator
uses: ory/milestone-action@v0
with:
GITHUB_TOKEN: ${{ secrets.TOKEN_PRIVILEGED }}
outputFile: docs/docs/milestones.md
orgs: ory,ory-corp
- name: Commit Milestone Documentation
uses: EndBug/[email protected]
with:
message: "autogen(docs): update milestone document"
author_name: aeneasr
author_email: "[email protected]"
env:
GITHUB_TOKEN: ${{ secrets.TOKEN_PRIVILEGED }}
```
### Single repository
```yaml
name: Generate and Publish Milestone Document
on:
workflow_dispatch:
issues:
types:
[
opened,
closed,
edited,
demilestoned,
milestoned,
reopened,
assigned,
unassigned,
labeled,
unlabeled,
]
pull_request:
types:
[
opened,
closed,
edited,
demilestoned,
milestoned,
reopened,
assigned,
unassigned,
labeled,
unlabeled,
]
jobs:
milestone:
name: Generate and Publish Milestone Document
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
token: ${{ secrets.TOKEN_PRIVILEGED }}
- name: Milestone Documentation Generator
uses: ory/milestone-action@v0
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
outputFile: docs/docs/milestones.md
- name: Commit Milestone Documentation
uses: EndBug/[email protected]
with:
message: "autogen(docs): update milestone document"
author_name: aeneasr
author_email: "[email protected]"
env:
GITHUB_TOKEN: ${{ secrets.TOKEN_PRIVILEGED }}
```
## Releasing
```
git tag -a -m "v0" v0
git push --tags
```