Skip to content

Commit 02865cb

Browse files
committed
docs: clarify release note requirements
1 parent b859e3f commit 02865cb

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

‎CODEX.md‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,16 +65,22 @@ gem build ruby_api_pack_cloudways.gemspec
6565
`## [<version>] - <YYYY-MM-DD>`, with a release title line in the format
6666
`**Release Title:** <short title>`, where `<short title>` is a concise
6767
summary of what shipped. Do not include roadmap phase numbers, names, or
68-
version numbers in release titles.
68+
version numbers in release titles. Confirm a
69+
`Contract change type: <additive|semantic change|breaking>`
70+
classification line is present and accurate for the release.
6971
3. Run the validation gate described in [AGENTS.md](AGENTS.md) plus
7072
`gem build ruby_api_pack_cloudways.gemspec` — must pass clean.
7173
4. Stage and commit the version bump and changelog update.
7274
5. Create the git tag: `git tag v<version>` (matching `version.rb` exactly),
7375
then push the commit and tag.
7476
6. Publish the GitHub Release from that tag: `gh release create v<version>
75-
--title "<short title>" --notes-file` (extract the new version's changelog
76-
section, or `--notes` inline for a short release). The GitHub Release title
77-
must match the changelog release title exactly.
77+
--title "<short title>" --notes-file`. The notes file must contain the
78+
full versioned `CHANGELOG.md` entry verbatim except for the version
79+
heading and `Release Title` line, which GitHub already displays. Preserve
80+
section headings and every bullet. Never summarize, condense, paraphrase,
81+
add to, or omit the remaining changelog content — `--notes` inline
82+
freeform text is never used, even for a short release. The GitHub Release
83+
title must match the changelog release title exactly.
7884
7. `gem push` is **not** run by Codex — that stays with Bradley Potts.
7985

8086
## Hard Limits

0 commit comments

Comments
 (0)