build: automate Github release notes #848
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a script that gathers changes since the last stable release of the application and formats them using markdown. This markdown-formatted changelog is published with every release to provide a baseline, readily-available view of changes.
In addition, the script is designed such that it can also be executed locally on any branch, and will output the set of changes since the last stable release through the current branch's
HEAD
.There are a number of frameworks out there that help parse and format changes in the conventional commit format. Inspired by this blog post, I chose to go with a relatively lightweight approach and use a custom bash script instead (that ends up being ~100 LOC). Without the overhead of an entire framework, using bash is also more portable between environments. If we find this concept useful after trialing it out, we can always use a more fully-fleshed framework if we want any additional functionality.
To Test
Release Notes on Publish: Tag this branch with a temporary, dummy tag (greater than the current stable release version) to create a release draft in Github. Note that the release notes section of the draft will be pre-populated.
Using the Script Locally: Check out this branch and run
./make-changelog.sh
from the root of the repo.