feat: implement tag-based releases with football coaches naming (#467) #469
Conversation
Implements tag-triggered CD pipeline with famous coaches release names (A-Z). - Separate CI (python-ci.yml) from CD (python-cd.yml) - CI runs on every push/PR: lint, test, coverage only - CD runs only on version tags (v*.*.*-*): build, test, publish - Validate semver and coach names (A-Z list from CHANGELOG) - Multi-platform Docker builds (amd64, arm64) - Auto-generate GitHub releases with changelog - Publish 3 Docker tags per release: semver, coach name, latest
WalkthroughAdds a tag-triggered CD workflow that validates semver and coach, runs tests, builds/pushes multi-arch Docker images, generates a changelog, and creates a GitHub release. Removes the Docker publish job from CI and adds release documentation (CHANGELOG, README). Changes
Sequence Diagram(s)sequenceDiagram
actor Developer
participant GitHub as "GitHub (Tag Push)"
participant CD as "GitHub Actions CD"
participant Test as "Test Runner (pytest)"
participant Registry as "GHCR (Container Registry)"
participant Release as "GitHub Release"
Developer->>GitHub: Push tag vX.Y.Z-COACH
GitHub->>CD: Trigger CD workflow
CD->>CD: Parse & validate semver and coach
CD->>Test: Run tests & coverage
Test-->>CD: Test results
CD->>Registry: Login, setup Buildx, build & push images (amd64, arm64)
Registry-->>CD: Images pushed
CD->>CD: Generate changelog (compare with previous semver-tag)
CD->>Release: Create release with changelog & image tags
Release-->>Developer: Release published
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #469 +/- ##
=======================================
Coverage 89.65% 89.65%
=======================================
Files 3 3
Lines 116 116
=======================================
Hits 104 104
Misses 12 12
🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In @.github/workflows/python-cd.yml:
- Around line 111-164: The generated changelog in the "Generate changelog" step
is written to changelog.txt and exported as the step output (changelog) but not
included in the release; update the "Create GitHub Release" action
(softprops/action-gh-release) to embed the changelog by adding a Changelog
section inside the body and referencing the step output ${{
steps.changelog.outputs.changelog }} (e.g. append "## Changelog\n\n${{
steps.changelog.outputs.changelog }}" to the existing body), or alternatively
attach changelog.txt via the action's files/assets input if you prefer it as an
asset.
In `@CHANGELOG.md`:
- Line 55: Replace the placeholder release date "2026-XX-XX" in the CHANGELOG
header "## [1.0.0 - Ancelotti] - 2026-XX-XX" with a valid token such as "TBD" or
move the entire "1.0.0 - Ancelotti" entry under an "## [Unreleased]" section so
the changelog contains no invalid dates; update the header text accordingly to
ensure tooling and readers parse the file correctly.
🧹 Nitpick comments (2)
.github/workflows/python-cd.yml (1)
43-57: Consider sourcingVALID_COACHESfrom a single source of truth.
Hardcoding the list here risks drift from CHANGELOG/README. If feasible, parse it from CHANGELOG.md or a dedicated shared file..github/workflows/python-ci.yml (1)
19-26: Reconsider version pinning strategy for GitHub actions.
actions/checkoutis pinned to v6.0.1, which is one patch behind the latest v6.0.2 released Jan 9.actions/setup-pythonis already at v6.1.0, the current latest release, so no update is needed there.Consider using major version tags (
v6) instead of exact versions to automatically receive patch updates and security fixes without manual intervention, as recommended by GitHub's guidance for these actions.
- Add Changelog section to GitHub release body - Replace "2026-XX-XX" with "TBD" in CHANGELOG.md
nanotaboada
force-pushed
the
feat/named-releases-cicd
branch
from
a1deeb9 to
35860f6
Compare
|
Implements tag-triggered CD pipeline with famous coaches release names (A-Z).
This change is
Summary by CodeRabbit
New Features
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.