Skip to content

Commit 361eb3a

Browse files
authored
Merge pull request #576 from nanotaboada/docs/normalize-changelog-567
docs(changelog): remove How to Release prose section (#567)
2 parents c270f8f + d58c988 commit 361eb3a

1 file changed

Lines changed: 0 additions & 43 deletions

File tree

CHANGELOG.md

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -222,49 +222,6 @@ This project uses famous football coaches as release codenames, following an A-Z
222222

223223
Initial release. See [README.md](README.md) for complete feature list and documentation.
224224

225-
---
226-
227-
## How to Release
228-
229-
To create a new release, follow these steps in order:
230-
231-
### 1. Update CHANGELOG.md
232-
233-
Move items from the `[Unreleased]` section to a new release section using the template format provided at the bottom of this file (see the commented template).
234-
235-
**Important:** Commit and push this change before creating the tag.
236-
237-
### 2. Create and Push Version Tag
238-
239-
```bash
240-
git tag -a vX.Y.Z-coach -m "Release X.Y.Z - Coach"
241-
git push origin vX.Y.Z-coach
242-
```
243-
244-
Example:
245-
246-
```bash
247-
git tag -a v1.0.0-ancelotti -m "Release 1.0.0 - Ancelotti"
248-
git push origin v1.0.0-ancelotti
249-
```
250-
251-
### 3. Automated CD Workflow
252-
253-
The CD workflow automatically:
254-
255-
- ✅ Validates the coach name against the A-Z list
256-
- ✅ Builds and tests the project with coverage
257-
- ✅ Publishes Docker images to GHCR with three tags (`:X.Y.Z`, `:coach`, `:latest`)
258-
- ✅ Creates a GitHub Release with auto-generated notes from commits
259-
260-
### Pre-Release Checklist
261-
262-
- [ ] CHANGELOG.md updated with release notes
263-
- [ ] CHANGELOG.md changes committed and pushed
264-
- [ ] Tag created with correct format: `vX.Y.Z-coach`
265-
- [ ] Coach name is valid (A-Z from table above)
266-
- [ ] Tag pushed to trigger CD workflow
267-
268225
<!-- Template for new releases:
269226
270227
## [X.Y.Z - COACH_NAME] - YYYY-MM-DD

0 commit comments

Comments
 (0)