Release Checklist

release-checklist.md

Release Checklist

Step 1: Version & Changelog

On the develop branch, do the following changes:

• Increment version number
  • in the package.json file
  • in the package-lock.json file (cause why not?)
  • everywhere else used
• Add new entry to the CHANGELOG.md, including
  • new features, bug fixes, ...
  • special mentions of any breaking changes
• For breaking changes, consider
  • extending compatibility tables (e.g. in README.md)
  • adding upgrade instructions (e.g. MIGRATION-GUIDE.md)

Commit all changes under the name Release X.X.X:

git add .
git commit -m "Release X.X.X"
git push

Step 2: Merge latest develop into main

git checkout main
git pull
git merge develop
git push

Step 3: Tag and push the release commit on the main branch

git tag -a X.X.X -m "Release X.X.X"
git push --tags

Step 4: In GitHub, publish a new release based on the new Git tag

Use the tag as basis, and use the corresponding CHANGELOG.md entry as the description.

Potential additional steps

• Deploy / release (e.g. npm, server)
• Mention new release on PRs / issues closed by the release