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
- Push branch first:
git push(important: push before tagging!) - Tag:
git tag v2026.01.28 - Push tag:
git push origin v2026.01.28
Why push before tagging?
git push --follow-tagsonly pushes tags pointing to commits in the push range. If HEAD is already on remote, the tag won't be included. Pushing branch first, then tagging and pushing the tag separately avoids this issue.
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
# Push branch first
git push
# Create release tag
git tag v2026.01.28
# Push the tag
git push origin v2026.01.28
# 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
Converted and distributed by TomeVault — claim your Tome and manage your conversions.