Skip to content

RELEASES.md

Latest commit

 

History

History
75 lines (51 loc) · 2.28 KB

RELEASES.md

File metadata and controls

75 lines (51 loc) · 2.28 KB
Raw

Releases

Releases follow the pattern v{SEMVER}-{TERM} (e.g., v1.0.0-assist). Codenames are drawn alphabetically from the football terminology list.

Workflow

1. Create a Release Branch

Branch protection prevents direct pushes to master, so all release prep goes through a PR:

git checkout master && git pull
git checkout -b release/v1.0.0-assist

2. Update CHANGELOG.md

Move items from [Unreleased] to a new release section in CHANGELOG.md, then commit and push the branch:

# Move items from [Unreleased] to new release section
# Example: [1.0.0 - assist] - 2026-XX-XX
git add CHANGELOG.md
git commit -m "docs(changelog): prepare release notes for v1.0.0-assist"
git push origin release/v1.0.0-assist

3. Merge the Release PR

Open a pull request from release/v1.0.0-assist into master and merge it. The tag must be created after the merge so it points to the correct commit on master.

Pre-release Checklist

Before creating the tag, verify all of the following:

  • CHANGELOG.md [Unreleased] section is moved to a new versioned release entry
  • Release PR is merged into master
  • npm run build passes
  • npm test passes
  • Term name is valid and follows alphabetical order (see football terminology list)
  • All CI checks on master are green

4. Create and Push Tag

After the PR is merged, pull master and create the annotated tag:

git checkout master && git pull
git tag -a v1.0.0-assist -m "Release 1.0.0 - Assist"
git push origin v1.0.0-assist

5. Automated CD Workflow

Pushing the tag triggers the CD workflow which automatically:

  1. Validates tag format (semver and term name)
  2. Builds and tests the project
  3. Publishes Docker images to GitHub Container Registry with three tags
  4. Creates a GitHub Release with auto-generated changelog from commits

Docker Pull

Each release publishes multiple tags for flexibility:

# By semantic version (recommended for production)
docker pull ghcr.io/nanotaboada/ts-node-samples-express-restful:1.0.0

# By term name (memorable alternative)
docker pull ghcr.io/nanotaboada/ts-node-samples-express-restful:assist

# Latest release
docker pull ghcr.io/nanotaboada/ts-node-samples-express-restful:latest