chore(release): switch to per-package release PRs for version in title (LAB-888) - #87
Merged
Merged
Conversation
…e (LAB-888)
Combined manifest PR titles (chore: release main) never render component
or version — release-please's Merge plugin only pulls those from a
candidate at path "." (MANIFEST_PULL_REQUEST_TITLE_PATTERN = 'chore:
release ${branch}'), and none of this repo's 3 packages live at root.
separate-pull-requests gives each package its own release PR using the
per-component pattern, which does render (e.g. 'chore(main): release
cachekit 0.1.5').
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThe release-please configuration now enables separate pull requests through the ChangesRelease Please configuration
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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.
Problem
release-please's generated release PR title is uninformative:
chore: release main(#83) — no version, no package. Since cachekit-ts is squash-merge-only withsquash_merge_commit_title=PR_TITLE, that title becomes the permanent commit header onmainwhen the release PR merges.Root cause (verified against release-please source, not just docs)
The combined/manifest PR title uses
MANIFEST_PULL_REQUEST_TITLE_PATTERN = 'chore: release ${branch}'(release-pleasesrc/manifest.ts). TheMergeplugin (src/plugins/merge.ts) only populates${component}/${version}from a candidate release atpath === '.':None of this repo's 3 packages (
packages/cachekit,packages/cachekit-core-ts,packages/cachekit-core-wasm) live at root path., sorootReleaseis alwaysnull— meaning${component}/${version}render empty regardless ofpull-request-title-patternorgroup-pull-request-title-patternconfiguration, and regardless of how many packages bump in a cycle. Setting either title-pattern option to include those tokens would not have fixed anything.Fix
"separate-pull-requests": trueinrelease-please-config.json. Each package now gets its own release PR (only for packages with releasable changes — usually justcachekitper cycle), using release-please's per-component default title pattern (chore${scope}: release${component} ${version}), which does populate component/version since each per-package candidate carries its own. Example:chore(main): release cachekit 0.1.5.Verified
pr-title-lint.yml's conventional-commit regex..github/workflows/release-please.ymlreads per-path outputs (packages/cachekit--release_createdetc.) — unaffected by combined vs. separate PRs.linked-versionsplugin configured, so per-package independent versioning (already the case per.release-please-manifest.json) is unaffected.Assign release PRstep keys offsteps.release.outputs.pr(first PR only) — in the common one-package-bumps-per-cycle case this is unaffected; if 2+ packages ever bump in the same cycle, only one of the resulting PRs gets auto-assigned. Not touching this here — config-file-only scope per LAB-888.Docs gate
No docs needed: internal release-automation config only, no user-facing SDK surface.
LAB-888
Summary by CodeRabbit