Skip to content

RELEASES.md

Latest commit

 

History

History
74 lines (50 loc) · 2.31 KB

RELEASES.md

File metadata and controls

74 lines (50 loc) · 2.31 KB

Releases

Releases follow the pattern v{SEMVER}-{COACH} (e.g., v1.0.0-ancelotti). Codenames are drawn alphabetically from the famous coach 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-ancelotti

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 - Ancelotti] - 2026-XX-XX
git add CHANGELOG.md
git commit -m "docs(changelog): prepare release notes for v1.0.0-ancelotti"
git push origin release/v1.0.0-ancelotti

3. Merge the Release PR

Open a pull request from release/v1.0.0-ancelotti 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
  • uv run pytest passes
  • Coach name is valid and follows alphabetical order (see "Release Naming Convention" in CHANGELOG.md)
  • 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-ancelotti -m "Release 1.0.0 - Ancelotti"
git push origin v1.0.0-ancelotti

5. Automated CD Workflow

Pushing the tag triggers the CD workflow which automatically:

  1. Validates tag format (semver and coach name)
  2. Builds and tests the project with coverage
  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/python-samples-fastapi-restful:1.0.0

# By coach name (memorable alternative)
docker pull ghcr.io/nanotaboada/python-samples-fastapi-restful:ancelotti

# Latest release
docker pull ghcr.io/nanotaboada/python-samples-fastapi-restful:latest