|
| 1 | +Run the pre-release checklist for this project. Work through all three phases |
| 2 | +in order, pausing for explicit confirmation at each decision point before |
| 3 | +proceeding. Never create a branch, commit, tag, or push without approval. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## Phase 1 — Determine next release |
| 8 | + |
| 9 | +1. Run `git status` and confirm the working tree is clean and on `master`. |
| 10 | + If not, stop and report the problem. |
| 11 | + |
| 12 | +2. Run `git tag --sort=-v:refname` to list existing tags. Identify the most |
| 13 | + recent tag matching `v*.*.*-*` and extract its club codename. |
| 14 | + |
| 15 | +3. Read the A–Z club table from `CHANGELOG.md` to find the next club: |
| 16 | + - **No tags yet**: start at `A` (first club in the table). |
| 17 | + - **Normal case**: use the club that follows the last used codename |
| 18 | + alphabetically. If letters were skipped, pick the next after the |
| 19 | + highest existing codename — do not backfill gaps. |
| 20 | + - **Last codename is `Z`** (Zenit): the list is finite. Stop and flag |
| 21 | + that the naming convention needs to be revisited before proceeding. |
| 22 | + |
| 23 | +4. Read the `[Unreleased]` section of `CHANGELOG.md` and infer the version |
| 24 | + bump using these rules (applied in order — first match wins): |
| 25 | + - Any entry contains the word **BREAKING** (case-insensitive), a |
| 26 | + `BREAKING CHANGE:` token in a commit footer, or a `!` suffix after |
| 27 | + the commit type/scope (e.g. `feat!:` or `feat(scope)!:`) → **major** bump |
| 28 | + - Any `### Added` subsection has entries → **minor** bump |
| 29 | + - Otherwise (only `### Changed`, `### Fixed`, `### Removed`) → **patch** bump |
| 30 | + |
| 31 | +5. Compute the next version by applying the bump to the current latest tag's |
| 32 | + semver (e.g. `v1.0.0-arsenal` + minor → `1.1.0`). |
| 33 | + |
| 34 | +6. Present a summary for confirmation before continuing: |
| 35 | + - Last tag and club |
| 36 | + - Next version and club codename |
| 37 | + - Bump type and the reasoning (what triggered it) |
| 38 | + - Proposed tag: `vX.Y.Z-{club}` |
| 39 | + - Proposed branch: `release/vX.Y.Z-{club}` |
| 40 | + |
| 41 | + **Wait for explicit approval before proceeding to Phase 2.** |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +## Phase 2 — Prepare release branch |
| 46 | + |
| 47 | +1. Create branch `release/vX.Y.Z-{club}` from `master`. |
| 48 | + |
| 49 | +2. Edit `CHANGELOG.md`: |
| 50 | + - Replace `## [Unreleased]` with `## [X.Y.Z - ClubName] - YYYY-MM-DD` |
| 51 | + (use today's date; use the club's display name from the table, e.g. |
| 52 | + "Barcelona", "Chelsea"). |
| 53 | + - Consolidate duplicate subsection headings (e.g. two `### Added` blocks |
| 54 | + should be merged into one). |
| 55 | + - Add a new empty `## [Unreleased]` section at the top (above the new |
| 56 | + versioned heading) with the standard subsections. |
| 57 | + - Update the compare links at the bottom of the file: |
| 58 | + - `[unreleased]` → `.../compare/vX.Y.Z-{club}...HEAD` |
| 59 | + - Add `[X.Y.Z - ClubName]` → `.../compare/v{prev-tag}...vX.Y.Z-{club}` |
| 60 | + |
| 61 | +3. Show the full diff of `CHANGELOG.md` and propose this commit message: |
| 62 | + |
| 63 | + ```text |
| 64 | + docs(changelog): prepare release notes for vX.Y.Z-{club} (#issue) |
| 65 | + ``` |
| 66 | + |
| 67 | + **Wait for explicit approval before committing.** |
| 68 | + |
| 69 | +4. Run `/pre-commit`, manually skipping step 1 — do not re-run or re-attempt |
| 70 | + the CHANGELOG update; it was already completed above. Open with: "Skip |
| 71 | + step 1 — CHANGELOG was already updated as part of this release branch." |
| 72 | + Proceed directly with steps 2–4. |
| 73 | + |
| 74 | +5. Propose opening a PR from `release/vX.Y.Z-{club}` into `master`. |
| 75 | + **Wait for explicit approval before opening.** |
| 76 | + |
| 77 | +6. Open the PR with: |
| 78 | + - Title: `docs(changelog): prepare release notes for vX.Y.Z-{club}` |
| 79 | + - Body summarising what is included in this release. |
| 80 | + |
| 81 | +--- |
| 82 | + |
| 83 | +## Phase 3 — Tag and release |
| 84 | + |
| 85 | +1. Wait — do not proceed until the user confirms: |
| 86 | + - CI is green |
| 87 | + - The PR has been merged into `master` |
| 88 | + |
| 89 | +2. Once confirmed, run: |
| 90 | + ```bash |
| 91 | + git checkout master && git pull origin master |
| 92 | + ``` |
| 93 | + and show the resulting `git log --oneline -3`. |
| 94 | + |
| 95 | +3. Propose the annotated tag: |
| 96 | + ```bash |
| 97 | + git tag -a vX.Y.Z-{club} -m "Release X.Y.Z - ClubName" |
| 98 | + ``` |
| 99 | + |
| 100 | + **Wait for explicit approval before creating the tag.** |
| 101 | + |
| 102 | +4. Create the tag, then propose: |
| 103 | + ```bash |
| 104 | + git push origin vX.Y.Z-{club} |
| 105 | + ``` |
| 106 | + |
| 107 | + **Wait for explicit approval before pushing.** Remind the user that pushing |
| 108 | + the tag triggers the CD workflow which will build, publish the Docker image, |
| 109 | + and create the GitHub Release. |
0 commit comments