Skip to content

docs(readme): acknowledge dev builds where the release rule is stated - #114

Merged
davidp57 merged 1 commit into
developfrom
docs/readme-dev-build
Aug 9, 2026
Merged

docs(readme): acknowledge dev builds where the release rule is stated#114
davidp57 merged 1 commit into
developfrom
docs/readme-dev-build

Conversation

@davidp57

@davidp57 davidp57 commented Aug 9, 2026

Copy link
Copy Markdown
Member

Why

A gap I left in FEAT-DEV-BUILD-CHANNEL and only spotted when Zip asked whether the channel was documented.

The lot documented it for developers (workflow.{md,fr.md}, building-and-testing.{md,fr.md}) and added one sentence to the mission-maker guide (ctld-tools.{md,fr.md}) — but not to the README, which is precisely the page carrying "a new CTLD reaches your missions only once a release is published". Someone handed a dev exe by FullGas reads that and cannot place the file they were given.

What changed

Three sentences in the existing Getting a newer CTLD section, matching the guide: a dev build exists, it is unreleased and CI-tested only, it names its commit in --version (quote it in a bug report), and it is for when someone asks you to try something.

Documentation only — no src/ change, so no CHANGELOG entry.

🤖 Generated with Claude Code

Summary by Sourcery

Documentation:

  • Update the README "Getting a newer CTLD" section to document the dev build channel, its unreleased/CI-tested nature, and how to reference its commit in bug reports.

FEAT-DEV-BUILD-CHANNEL documented the channel for developers
(workflow.md, building-and-testing.md) and added a sentence to the
mission-maker guide, but not to the README — which is the page that
tells a Mission Maker a new CTLD only arrives with a published release.
Someone handed a dev exe reads that and cannot place their file.

Same content as the guide's sentence: a dev build exists, it names its
commit in --version, take one only when asked.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@sourcery-ai

sourcery-ai Bot commented Aug 9, 2026

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

Reviewer's Guide

Updates the README documentation to describe the dev build channel and how users should treat and report issues for dev builds, aligning it with existing developer and mission-maker guides.

File-Level Changes

Change Details Files
Document the dev build channel and its usage in the README release section.
  • Explain that a dev build exe can be handed to users as an unreleased build from the latest work on the develop branch.
  • Clarify that dev builds are only CI-tested and therefore less stable than releases.
  • Describe how dev builds embed their source commit in the version output and instruct users to quote it in bug reports.
  • Advise users to use dev builds only when explicitly asked to try something and otherwise stay on official releases.
README.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 left some high level feedback:

  • The relative link to the dev pre-release (../../releases/tag/dev) is likely incorrect from the root README; consider using an absolute GitHub URL or a repo-relative path like ./releases/tag/dev.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The relative link to the `dev` pre-release (`../../releases/tag/dev`) is likely incorrect from the root README; consider using an absolute GitHub URL or a repo-relative path like `./releases/tag/dev`.

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 6a78c80 into develop Aug 9, 2026
7 checks passed
@davidp57
davidp57 deleted the docs/readme-dev-build branch August 9, 2026 09:14
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