README.md

Conventional Release Labels

Automatically adds labels to pull requests based on Conventional Commits. These labels can be used with GitHub's automatically generated release notes.

Configuration

Create a .github/workflows/conventional-label.yaml:

on:
  pull_request:
    types: [ opened, edited ]
name: conventional-release-labels
jobs:
  label:
    runs-on: ubuntu-latest
    steps:
      - uses: bcoe/conventional-release-labels@v1

Create 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:
        - "*"

Enjoy!

License

Apache Version 2.0