docs(release): stop telling the release to commit the built engine - #123
Merged
Conversation
The release skill still listed CTLD.lua among the files to commit on the release branch. It has been git-ignored since CHORE-UNTRACK-BUILT-ENGINE (PR #110), so that instruction cannot be followed: git add on it silently does nothing, and CI rebuilds the engine and attaches it to the release anyway. Found while preparing 2.0.0-rc7. Two other gaps the same run surfaced, both discovered by reading past release PRs rather than the skill: - The PR needs the skip-changelog label. Bumping ctld.VERSION is a src/ change, so changelog-guard demands a CHANGELOG.md entry and fails the PR without one. Every release PR from rc3 to rc7 carried the label; the skill never said so. - The PR title convention, "release: prepare x.y.z", used unchanged since rc3. Also states that ctld.VERSION is the only version to bump - ctld-tools reads it as its single source of truth, and the 0.1.0 in its pyproject.toml is a leftover that is displayed nowhere - and that the rebuild in step 4 is a local check, not a file to commit.
Reviewer's guide (collapsed on small PRs)Reviewer's GuideClarifies and corrects the release documentation so it no longer instructs committing the built CTLD engine, explicitly identifies ctld.VERSION as the single source of truth for versioning, and documents PR title and labeling conventions needed for CI to pass. Flow diagram for updated release preparation processflowchart TD
A[Start release prep] --> B[Bump ctld.VERSION in src/CTLD_config.lua]
B --> C[Run tools/build/merge_CTLD.ps1 to rebuild CTLD.lua]
C --> D[Confirm rebuilt CTLD.lua shows new ctld.VERSION]
D --> E[Git commit only RELEASE_NOTES.md, src/CTLD_config.lua, CHANGELOG.md]
E --> F[Create release/x.y.z branch and push]
F --> G[Open PR targeting develop]
G --> H[Set PR title: release: prepare x.y.z]
H --> I[Add skip-changelog label]
I --> J[CI changelog-guard succeeds]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
releaseskill still listedCTLD.luaamong the files to commit on the release branch. It has been git-ignored sinceCHORE-UNTRACK-BUILT-ENGINE(#110), so that instruction cannot be followed:git addon it silently does nothing, and CI rebuilds the engine and attaches it to the release anyway. Found while preparing2.0.0-rc7(#122).Two further gaps the same run surfaced — both of which I had to discover by reading past release PRs rather than the skill:
skip-changeloglabel. Bumpingctld.VERSIONis asrc/change, sochangelog-guarddemands aCHANGELOG.mdentry and fails the PR without one. Every release PR from rc3 to rc7 carried the label; the skill never mentioned it.release: prepare x.y.z, used unchanged since rc3 (release: prepare 2.0.0-rc3 #89, release: prepare 2.0.0-rc4 #95, release: prepare 2.0.0-rc5 #98, release: prepare 2.0.0-rc6 #100, release: prepare 2.0.0-rc7 #122).Also clarified in step 4:
ctld.VERSIONis the only version to bump.ctld-toolsreads it as its single source of truth (resources.py), so the exe and its help link follow on their own. The0.1.0intools/ctld-tools/pyproject.tomlis a leftover displayed nowhere — worth stating, since a release preparer would reasonably go looking for it.CTLD.luacarries the new version" before moving on.Documentation only — no code, no behaviour change. Scoped to the one skill file.
Test plan
.gitignore:12andgit check-ignorefor the engine,gh pr listfor the label and title convention on rc3→rc7,resources.pyfor the version sourceSummary by Sourcery
Clarify the release skill documentation around version bumping, rebuild expectations, and Git/PR conventions for release branches.
Documentation: