Conventional Release Labels
Action that automatically adds labels to pull requests based on Conventional Commits. These labels can be used in conjunction GitHub's automatically generated release notes:
Setting up action
Create a .github/workflows/conventional-label.yaml:
# Warning, do not check out untrusted code with
# the pull_request_target event.
on:
pull_request_target:
types: [ opened, edited ]
name: conventional-release-labels
jobs:
label:
runs-on: ubuntu-latest
steps:
- uses: bcoe/conventional-release-labels@v1Create a .github/release.yaml:
changelog:
exclude:
labels:
- ignore-for-release
authors:
- octocat
categories:
- title: Breaking Changes π
labels:
- breaking
- title: Exciting New Features π
labels:
- feature
- title: Fixes π§
labels:
- fix
- title: Other Changes
labels:
- "*"Configuration
| input | description |
|---|---|
token |
A GitHub secret token, the action defaults to using the special, default: secrets.GITHUB_TOKEN |
type_labels |
Mapping from Conventional Commit types to pull request labels, default: {"feat": "feature", "fix": "fix", "breaking": "breaking"} |
ignored_types |
Conventional commit types that should have ignore_label applied, default: ["chore"] |
ignore_label |
label to apply for ignored commits, default: ignore-for-release |
Enjoy π
Related Tools
| tool | description |
|---|---|
| release-please-action | Fully automated releases with Conventional Commits |
License
Apache Version 2.0