This document outlines how to release a new version of Blip. It is not the release notes.
Review Blip versioning guidelines.
First, create a branch to prepare the new version.
- Ensure local main branch is up to date and clean:
git co main && git pull - Create release branch:
git co -b v1.Y.Z(replace Y and Z with new version) - Bump version const
blip.VERSION
Second, update the documentation.
Run docs/serve.sh to edit locally.
- Write release notes for the new version (maintain style: past tense one liners)
- Check and update Readiness
- Update other pages affected by new changes (or ask contributors to update docs affected by their changes)
- Glance over all docs to make sure nothing obvious is broken or wrong (including HTML/CSS layout)
Third, merge the release branch and create a GitHub release.
- Add, commit, and merge changes in the release branch; commit message "Release v1.Y.Z" or similar
- Wait for GitHub Actions to build/publish
- Update local main branch:
git co main && git pull - Tag local main with new version:
git tag v1.Y.Z(replace Y and Z) - Push tag:
git push --tags - Draft a new release
- Select new version tag
- Click "Generate release notes" button (on the right)
- Put "Human-readable release notes: ..." preamble before generated release notes (see v1.0.1 release for example)
- Clean up generated releases that are noisy or useless
- Make sure "Set as the latest release" is checked (leave pre-release unchecked/clear)
- Pubish release
Congratulations and thank you for helping develop Blip and monitor MySQL!