GitHub actions example for automatic release drafts and changelog.md creation
What are GitHub actions?
Which problem should be solved?
For this open-source project, the requirement was to determine the release structure via labels at the pull request. This was preferred over conventional commits. Also, not every merged pull request should automatically trigger a new release. Therefore, a draft is the right way to collect the changes and publish a version whenever needed.
Addionatylly to the GitHub releases, a changelog.md helps see the version history, for example, directly in the code editor. That changelog.md should be updated every time a release is published.
Configure Release Drafter
To configure Release Drafter in the default way, it needs two files and the according labels.
This template describes the structure of the release draft and the needed labels.
The full path is
name-template: 'v$RESOLVED_VERSION 🌈' tag-template: 'v$RESOLVED_VERSION' categories: - title: '🚀 Features' labels: - 'feature' - 'enhancement' - title: '🐛 Bug Fixes' labels: - 'fix' - 'bugfix' - 'bug' - title: '🧰 Maintenance' label: 'chore' - title: '🧺 Miscellaneous' #Everything except ABAP label: 'misc' change-template: '- $TITLE @$AUTHOR (#$NUMBER)' change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks. version-resolver: major: labels: - 'major' minor: labels: - 'minor' patch: labels: - 'patch' default: patch template: | ## Changes $CHANGES
The GitHub actions configuration like this:
name: Release Drafter on: push: # branches to consider in the event; optional, defaults to all branches: - main jobs: update_release_draft: runs-on: ubuntu-latest steps: # Drafts your next Release notes as Pull Requests are merged into "master" - uses: release-drafter/release-drafter@v5 env: GITHUB_TOKEN: $
The releases are published manually at certain times. This trigger this configuration.
name: "update changelog" on: release: types: [published] jobs: update-changelog: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Update changelog run: | npm install github-release-notes export GREN_GITHUB_TOKEN=$ npm run overrideChangelog - name: Create Pull Request uses: peter-evans/create-pull-request@v3 with: commit-message: update changelog title: Update Changelog body: Update changelog to reflect release changes branch: update-changelog base: main
"overrideChangelog": "gren changelog --override" from the package.json update then the changelog.md.
Because of the main branch protection, it’s not possible to push the changes directly back. This will do this via a pull request with the GitHub action create-pull-request.
How it looks like
The collection of the changes in a release draft.
The labels in a pull request.
The result in the GitHub release.
The result in the CHANGELOG.md.
Let me know what you think of this article on twitter @KoningsJohannes or leave a comment below!