Conversation
- The breaking-changes section of the release PR pasted the raw cargo-semver-checks report: every lint's description and reference links, and the temporary checkout paths of the old version. A `pr_body` template keeps release-plz's layout and lists each failed lint with the items it names. The check stays on, since it also bumps the major version for a breaking change no commit declared. - The changelog listed the commit that moved the binary into a structured-proxy-cli package; that package was never released, as the binary moved back into structured-proxy before 5.0.0. A commit parser skips it by sha, ahead of release-plz's default parsers, which setting the key replaces. Closes #115
|
Warning Review limit reachedNext included review available in 22 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 23acaab8f7
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| # The structured-proxy-cli package this commit introduced was never | ||
| # released: the binary moved back into structured-proxy before the next | ||
| # release, so the entry would describe a change no user sees. | ||
| { sha = "90d746b1b3c879359776adaf4bbbac5b97bf1f38", skip = true }, |
There was a problem hiding this comment.
Preserve user-visible changes from the skipped commit
When generating the 5.0.0 changelog, this rule drops the entire 90d746b commit rather than only its transient package move. That commit also introduced the still-shipped structured-proxy --version option (src/main.rs:16) and clearer config-path errors, and no later commit adds a replacement changelog entry for --version; users therefore receive a new CLI capability that is absent from the release notes. Reword or replace the misleading package-move entry while retaining the user-visible changes instead of skipping the whole commit.
Useful? React with 👍 / 👎.
|
| {%- elif line is starting_with(pat=" ") and line is containing(pat=" in file ") %} | ||
| - `{{ line | split(pat=" in file ") | first | trim | replace(from=", previously", to="") }}` |
There was a problem hiding this comment.
Removed feature names disappear
When cargo-semver-checks reports a removed Cargo feature, its item line says in the package's Cargo.toml, not in file. This filter drops the item line, so the release PR flags the breaking change but omits which features were removed. Reviewers must consult the full report to identify them. This loss of review detail does not block merging.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Artifacts
Exact Tera rendering test script
- This is the authored script executed for both captures; it fetches upstream report examples and renders the default and PR templates with Tera 2.
Default template render with compatible and breaking reports
- The before command exited 0 and displayed both removed feature names in the upstream default release PR body.
PR template render with compatible and breaking reports
- The after command exited 0 but displayed only the feature-removal lint heading, omitting both removed feature names.
Release rendering test inventory and tracked-file status
- The command found no tracked release-template rendering test and confirmed that tracked files were unchanged.
Comments Outside DiffThese findings sit on lines the diff does not cover, so they could not be posted inline. Each one leaves this list once its file changes.
|
Summary
The release PR body carries only what the release is:
Breaking changes: release-plz's default template pasted the raw cargo-semver-checks report (lint descriptions, reference links, the temporary checkout paths of the old version). A
pr_bodytemplate keeps release-plz's layout and lists each failed lint with the items it names:The check stays on: it also bumps the major version for a breaking change no commit declared.
Changelog: the commit that moved the binary into a
structured-proxy-clipackage is skipped. That package was never released (the binary moved back intostructured-proxybefore 5.0.0), so its entry described a change no user sees.commit_parsersreplaces release-plz's defaults, so they follow the skip rule unchanged.Testing
Tera::default(),releasesin the context), against the report in the current release PR: the output is the list above; a compatible release renders with no breaking-changes section. release-plz's own default template through the same harness reproduces the current release PR body.release-plz updateon this branch: next version 5.0.0 with the semver check still run; the 5.0.0 changelog has no structured-proxy-cli entry, and every other entry keeps its group.Closes #115