https://github.com/nitzano/semantic-release-github-milestones

Sync github milestones with semantic release 🚩🚀
https://github.com/nitzano/semantic-release-github-milestones

github semantic-release semantic-release-plugin

Last synced: 3 months ago
JSON representation

Sync github milestones with semantic release 🚩🚀

• Host: GitHub
• URL: https://github.com/nitzano/semantic-release-github-milestones
• Owner: nitzano
• License: mit
• Created: 2021-09-18T10:06:14.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-06T05:25:30.000Z (over 1 year ago)
• Last Synced: 2025-01-30T16:52:44.074Z (12 months ago)
• Topics: github, semantic-release, semantic-release-plugin
• Language: TypeScript
• Homepage:
• Size: 1.82 MB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
 semantic-release-github-milestones🚩🚀

Sync Github milestones with semantic-release





[![npm latest version](https://img.shields.io/npm/v/semantic-release-github-milestones/latest.svg)](https://www.npmjs.com/package/semantic-release-github-milestones)

[![npm next version](https://img.shields.io/npm/v/semantic-release-github-milestones/next.svg)](https://www.npmjs.com/package/semantic-release-github-milestones)

[![npm beta version](https://img.shields.io/npm/v/semantic-release-github-milestones/beta.svg)](https://www.npmjs.com/package/@semantic-release/github)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)



| Step               | Description                                                                                                                        |

| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |

| `verifyConditions` | Verify github tokens are present and valid.                                                                                         |

| `verifyRelease`    | Display information regarding the github milestone.                                                               |

## Highlights

*  Shows [Github milestones](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-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`, ...)

### 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](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):

```json

{

  "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).

### Environment variables

| Variable                                           | Description                                               |

| -------------------------------------------------- | --------------------------------------------------------- |

| `GH_TOKEN` or `GITHUB_TOKEN`                       | **Required.** The token used to authenticate with GitHub. |