TirSystem/github-action
0
1
Fork 0
Code Issues 5 Pull Requests 1 Actions Packages Projects Releases 3 Wiki Activity

Add the changelog and the check of its convention
TirSystem/github-action: Publish wiki / publish-wiki (push) Skipped
TirSystem/github-action: Sync GitHub mirror metadata / sync-metadata (push) Skipped
Validate workflows / validate (pull_request) Successful in 16s
Details

Browse Source 
CHANGELOG.md holds an [Unreleased] section with what the first release
v1.0.0 will contain, in the groups Breaking, Added, Changed and Fixed.
tools/changelog.py checks the convention of ADR-0006 (Unreleased first,
descending versions, dates, a Breaking entry needs a new major and a new major
needs one) and prints the notes of a release for the release page. The
release process guide uses both.

Task: MIL-004#2
This commit is contained in:
Tirsvad
2026-10-10 22:51:08 +08:00
parent b1515b26e1
commit 930e67ad7e
4 changed files with 361 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
guides/release-process.md
+8 -5
View File
@@ -26,9 +26,12 @@ Until the release workflow exists (MIL-004 task 5) the steps are done by hand.
2. **Check the commit.** The validation run (`validate-workflows`) on the exact
commit of `main` to be released is green; do not release from a red or
unchecked commit.
3. **Write the changelog entry** in `CHANGELOG.md`: the version, the date, and
the changes in the groups Breaking, Added, Changed and Fixed. A change that
touches credentials, tokens or permissions says so.
3. **Write the changelog entry** in `CHANGELOG.md`: move the items of
`[Unreleased]` under `## [x.y.z] - date` in the groups Breaking, Added,
Changed and Fixed. A change that touches credentials, tokens or permissions
says so. Check it with
`python tools/changelog.py check --version x.y.z`; a Breaking entry needs a
new major version, and a new major version needs a Breaking entry.
4. **Get the approval** of S01 for the release, in the pull request that adds
the changelog entry.
5. **Tag.** Create `vMAJOR.MINOR.PATCH` on the approved commit, then move
@@ -38,8 +41,8 @@ Until the release workflow exists (MIL-004 task 5) the steps are done by hand.
git push origin v1.2.0
git tag -f v1 <commit> && git push -f origin v1
```
6. **Announce.** Create the release page for the tag with the changelog entry
as its text, and say whether consumers must act.
6. **Announce.** Create the release page for the tag with the text of
`python tools/changelog.py notes x.y.z`, and say whether consumers must act.
7. **Verify.** One repository pinned to the previous exact tag still runs the
same code; one repository on the major tag receives the release.