Repository navigation
fix(cd): read release-please changelogs and attach to existing releases - #46
Conversation
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
Review effort: Lite
Findings: 4
Open (6)
The README example uses hyphens in GitHub Actions expression property access (e.g.,… · New The README example uses hyphens in GitHub Actions expression property access (e.g.,… · New The README example uses hyphens in GitHub Actions expression property access (e.g.,… · New The README example uses hyphens in GitHub Actions expression property access (e.g.,… · New This wording is misleading:cd-github-release.ymldoesn’t readrelease-please-config.json/… · New The comment says component tags are reduced to their version, but the regex keeps any suffix after… · New
What changed in this PR
Updates the GitHub release CD reusable workflow to interoperate with release-please by reusing existing releases and correctly extracting notes from release-please-style changelog headings.
Changes:
- Enhance
cd-github-release.ymlto detect existing releases and only upload assets when present (e.g., release-please-created releases). - Extend changelog section extraction to support release-please heading format and component-style tags.
- Update docs (
README.md,AGENTS.md) with guidance and pitfalls for release-please users.
| File | Description |
|---|---|
README.md |
Adds release-please usage guidance and immutable releases publishing flow. |
AGENTS.md |
Updates consumer guidance for cd-github-release.yml, including release-please formats and behavior. |
.github/workflows/cd-github-release.yml |
Detects existing releases to attach assets only, and improves changelog parsing for release-please/component tags. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| The action reads `release-please-config.json` and `.release-please-manifest.json` from the repository | ||
| root. For a manifest package at a path, read |
| # version, tolerating "## v1.2.3", "## 1.2.3", "## [1.2.3]", "## [v1.2.3]" | ||
| # and an optional trailing " - date". Exact token compare keeps "## Unreleased" | ||
| # and "## v1.2.30" from matching "v1.2.3". | ||
| if [[ "$TAG" =~ ^(.+-)?v?([0-9]+\.[0-9]+\.[0-9]+.*)$ ]]; then |
There was a problem hiding this comment.
Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.
Note
This error may be related to your runner configuration. You can now configure runners for Copilot code review separately from Copilot cloud agent by creating a copilot-code-review.yml file with your setup steps. Read the docs for details.
3a17072 to
2fcb36d
Compare
There was a problem hiding this comment.
Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.
An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing. Review the Copilot code review billing settings.
Brings in rtCamp#44, rtCamp#46, rtCamp#47, rtCamp#48 and rtCamp#49. AGENTS.md keeps this branch's rule that release-please owns CHANGELOG.md, the manifest and v* tags, and takes rtCamp#46's wording for cd-github-release.yml, which is consumer guidance. Drops the hand-written "## Unreleased" section rtCamp#47 added to CHANGELOG.md: release-please inserts each release above the first version heading, so that section would stay stranded above every release. The first release PR lists rtCamp#46 to rtCamp#49 from their titles, and rtCamp#47's fuller notes can go into that PR before it merges.



What this PR does
Makes
cd-github-release.ymlwork for consumers that use release-please. Needed before #45 (see theAGENTS.mddiscussion there).Closes
N/A
Changes
## [1.2.0](url) (date)) and component tags (acme-blocks-v1.2.0).AGENTS.md: thecd-github-releasepitfall is now consumer guidance.README.md: how to use it with release-please, including immutable releases.How I verified
yamllint,actionlintandbin/check-workflows.shpass.Reviewer notes
CHANGELOG.mdentry on purpose: once chore: userelease-pleasefor release automation #45 lands, release-please puts this commit in 1.0.1.