Create Release
Create releases with changelog entry and git tag.
Tag Format
vYYYY.MM.DD (e.g., v2026.01.28)
Process
- •Update changelog for today's date in
docs/changelog.md - •Commit if there are uncommitted changes
- •Tag:
git tag v2026.01.28
After Tagging
Push the branch and tag together using --follow-tags:
bash
git push --follow-tags
This pushes the branch and any tags pointing to commits being pushed in one command. Prefer this over separate git push + git push origin <tag> calls.
Tip: Set
git config --global push.followTags trueto make this the default forgit push.
Once the tag reaches the remote, it triggers:
- •GitHub release with changelog content extracted
- •Docker image tagged
ghcr.io/hyaway/hyaway:v2026.01.28
Commands
bash
# Create release tag git tag v2026.01.28 # Push branch + tag together git push --follow-tags # Tag specific commit git tag v2026.01.28 <commit-hash> # Delete tag (if needed to redo) git tag -d v2026.01.28 git push origin :refs/tags/v2026.01.28
Important
- •Changelog entry date must match tag:
v2026.01.28expects## 2026-01-28 - •Tag must point to commit containing the changelog entry
- •Old commits (before workflow existed) need manual dispatch via GitHub Actions UI