semantic-release-github-milestones
v2.0.5
Published
<h1 align="center" style="border-bottom: none;"> semantic-release-github-milestones🚩🚀</h1> <h2 align="center">Sync <a href="https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones">Github milestones</a> with <a href=
Downloads
144
Maintainers
Readme
| Step | Description |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| verifyConditions
| Verify github tokens are present and valid. |
| verifyRelease
| Display information regarding the github milestone. |
Highlights
- Shows Github milestones summary information when releasing a new version.
- Matches milestones either by:
- Next release version (
v1.1.0
,2.2.0
, ...) - Channel name (
next
,beta
, ...) - Branch name (
master
,next-major
, ...)
- Next release version (
Future versions
- Appends milestone data to Github Releases
- Automatically closes milestones after releasing
- Protects against releasing milestones with open issues
Examples
Milestone with open issues
[semantic-release-github-milestones] › ℹ 🚩 Github Milestone: v1.0.1 🚩
[semantic-release-github-milestones] › ℹ (https://github.com/owner1/repo1/milestone/1)
[semantic-release-github-milestones] › ℹ 6 total issues
[semantic-release-github-milestones] › ℹ ⚠️ ⚠️ 2 open issues ⚠️ ⚠️
Milestone without open issues
[semantic-release-github-milestones] › ℹ 🚩 Github Milestone: next 🚩
[semantic-release-github-milestones] › ℹ (https://github.com/owner1/repo1/milestone/7)
[semantic-release-github-milestones] › ℹ 15 total issues
[semantic-release-github-milestones] › ℹ No open issues ✔️
Install
npm install --save-dev semantic-release-github-milestones
Usage
The plugin can be configured in the semantic-release configuration file:
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"semantic-release-github-milestones",
]
}
Configuration
Github authentication is required and can be set via environment variables.
Environment variables
| Variable | Description |
| -------------------------------------------------- | --------------------------------------------------------- |
| GH_TOKEN
or GITHUB_TOKEN
| Required. The token used to authenticate with GitHub. |