Skip to content

docs(release): stop telling the release to commit the built engine - #123

Merged
davidp57 merged 1 commit into
developfrom
fix/release-skill-untracked-engine
Aug 14, 2026
Merged

docs(release): stop telling the release to commit the built engine#123
davidp57 merged 1 commit into
developfrom
fix/release-skill-untracked-engine

Conversation

@davidp57

@davidp57 davidp57 commented Aug 14, 2026

Copy link
Copy Markdown
Member

Summary

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 (#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 (#122).

Two further gaps the same run surfaced — both of which I had to discover by reading past release PRs rather than the skill:

Also clarified in step 4:

  • ctld.VERSION is the only version to bump. ctld-tools reads it as its single source of truth (resources.py), so the exe and its help link follow on their own. The 0.1.0 in tools/ctld-tools/pyproject.toml is a leftover displayed nowhere — worth stating, since a release preparer would reasonably go looking for it.
  • The step-4 rebuild is a local check, not a file to commit, with an explicit "confirm the rebuilt CTLD.lua carries the new version" before moving on.

Documentation only — no code, no behaviour change. Scoped to the one skill file.

Test plan

  • Every claim verified against the repository rather than memory: .gitignore:12 and git check-ignore for the engine, gh pr list for the label and title convention on rc3→rc7, resources.py for the version source
  • The corrected procedure is the one actually executed on release: prepare 2.0.0-rc7 #122, which went green 9/9
  • CI green on this PR

Summary by Sourcery

Clarify the release skill documentation around version bumping, rebuild expectations, and Git/PR conventions for release branches.

Documentation:

  • Document that ctld.VERSION in src/CTLD_config.lua is the single source of truth for release versioning, and that other version fields are legacy and unused.
  • Clarify that rebuilding CTLD.lua is a local verification step and that the built engine must not be committed because it is a git-ignored artifact.
  • Update Git/PR instructions for release branches to specify which files to commit, enforce the standard release PR title, and require the skip-changelog label.

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.
@sourcery-ai

sourcery-ai Bot commented Aug 14, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Clarifies 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 process

flowchart 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]
Loading

File-Level Changes

Change Details Files
Clarified the version bump step to state ctld.VERSION is the single source of truth and that pyproject.toml’s version is a non-functional leftover.
  • Extended the step describing the ctld.VERSION bump to explain that ctld-tools reads this value from resources.py.
  • Noted that the version in tools/ctld-tools/pyproject.toml is a historical leftover and not surfaced anywhere.
.claude/skills/release/SKILL.md
Documented that rebuilding CTLD.lua is a local verification step only and should not result in committing the built artifact.
  • Updated the rebuild step to emphasize it is a local check and references a later git step.
  • Added explicit instruction to confirm CTLD.lua carries the new ctld.VERSION after rebuild.
.claude/skills/release/SKILL.md
Corrected the git/PR workflow instructions to stop committing CTLD.lua and to specify which files and PR metadata are required.
  • Removed CTLD.lua from the list of files to commit and explained it is a git-ignored build artifact regenerated by CI.
  • Clarified that CHANGELOG.md is only committed when actually modified by the release prep step.
  • Added explicit PR title convention: release: prepare x.y.z.
  • Documented the requirement to apply the skip-changelog label so changelog-guard passes for version-only src changes.
.claude/skills/release/SKILL.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@davidp57
davidp57 merged commit 8d00d35 into develop Aug 14, 2026
8 checks passed
@davidp57
davidp57 deleted the fix/release-skill-untracked-engine branch August 14, 2026 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant