This action creates a draft release for the next version to be released. It reads the release file in .github/release.yml and creates a draft release with the next version number based on the current version number and the labels of the pull requests merged since the last release.

To use this action, you need to create a release file in .github/release.yml as shown in the GitHub documentation for creating a release file.

To decide whether the next release should be a major or minor release, the action looks at the labels of the pull requests merged since the last release. If there is at least one pull request with the label specified in the major-label input, the next release will be a major release. Otherwise, if there is at least one pull request with the label specified in the minor-label input, the next release will be a minor release. Otherwise, the next release will be a patch release.

name: Draft Release

on:
  push:
    branches:
      - main

jobs:
  draft-release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: lucacome/draft-release@v0.1.0
        with:
          minor-label: 'enhancement'
          major-label: 'change'

The header and footer have two special placeholders that will be replaced with the version number of the next release:

• {{version}} will be replaced with the version number of the next release.
• {{version-number}} will be replaced with the version number of the next release without the v prefix.

name: Draft Release

on:
  push:
    branches:
      - main

jobs:
  draft-release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: lucacome/draft-release@v0.1.0
        with:
          minor-label: 'enhancement'
          major-label: 'change'
          notes-footer: |
            This is a footer.
            It can be multiline.

name: Draft Release

on:
  push:
    branches:
      - main

jobs:
  draft-release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: lucacome/draft-release@v0.1.0
        id: draft-release
        with:
          minor-label: 'enhancement'
          major-label: 'change'

      - name: Get Version Number
        run: echo ${{ steps.draft-release.outputs.version }}