This list is supposed to make sure we do not forget any important steps during release.
-
Check and update issue tracker for issues associated with current milestone
-
Update CHANGELOG.md with all elements missing A useful tool is the
github_changelog_generator
It can be used like this:
sudo gem install github_changelog_generator
github_changelog_generator -u smarr -p SOMns --token ${GITHUB_TOKEN}
-
Make sure all desired changes are part of the
dev
branch. -
Prepare a release on GitHub with: https://github.com/smarr/SOMns/releases/new The content is normally just the last part of the CHANGELOG.md
-
If everything looks good, tag the release using the GitHub feature
-
Push the commit that is tagged as release to the
master
branch. -
Announce the release