Repository navigation
feat(release): credit contributors in release notes - #915
Merged
blafourcade merged 7 commits intoSep 24, 2026
Merged
blafourcade merged 7 commits into
blafourcade merged 7 commits into
Conversation
A squashed promote collapses the week's commits into one hidden `ci:` subject, so release-please reports no user-facing commits and the entries vanish from the notes; it also collapses authorship onto whoever merged. A rebase breaks the merge base the back-merge relies on. The ruleset file now allows only merge commits on main. A bypass in pull_request mode does not lift that restriction (proven in a sandbox), so the Release PR moves from --squash --admin to --merge --admin, which this repository already released from once (#135). The live ruleset is left unchanged: it must be applied only after one release has merged with --merge. Refs #911 Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]> AIDD-Session-Id: 3adb1fb2-3894-4e52-afab-424803c7fcad
Generated GitHub releases never named the people behind a change. release-please's own include-commit-authors option is a no-op in every 17.x release so far: parseConventionalCommits drops the author before the changelog notes see it (googleapis/release-please#2761, fix pending in #2892). After release-please creates the cycle's releases, a CI step appends each line's commit author as (@login), or the name when no account resolves, resolved from the line's commit SHA. Lines already credited are left alone, so a re-run changes nothing, and a crediting failure never blocks the build and publish jobs. Delete the step once a fixed release-please is pinned. Refs #911 Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]> AIDD-Session-Id: 3adb1fb2-3894-4e52-afab-424803c7fcad
The live main ruleset still allows squash and rebase until a maintainer applies .github/rulesets/main.json, which must wait for one release to merge with --merge. The docs now describe the rule the file declares instead of claiming it is enforced today. Refs #911 Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]> AIDD-Session-Id: 3adb1fb2-3894-4e52-afab-424803c7fcad
…ishing A missing RELEASE_OUTPUTS made the script credit nothing and exit 0, and a failing checkout before the credit step would fail the release-please job and skip every build and publish job. The script now exits non-zero on missing outputs, both crediting steps carry continue-on-error, and tests pin the wiring. A second pass no longer re-appends an author name containing parentheses, and a release is written back only when its body changed. Refs #911 Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]> AIDD-Session-Id: 3adb1fb2-3894-4e52-afab-424803c7fcad
The repository fills a merge commit's body with the PR title, and release-please splits a message on each conventional line, so a PR merged into main as a merge commit is parsed twice: the change appears twice in the notes, the copy credited to whoever merged. No repository setting yields an empty body with the "Merge pull request" subject. The Release PR and promote merges now pass --body "", and hotfixes are documented to merge with an empty description. Proven in a sandbox: a default-body merge duplicated the line, an empty-body merge did not. Refs #911 Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]> AIDD-Session-Id: 3adb1fb2-3894-4e52-afab-424803c7fcad
A hotfix merged with the default body still reaches release-please twice. When crediting, a line whose commit is a merge commit is removed if a non-merge line in the same release carries the same text; a lone merge-commit line is credited to its pull request's author instead of whoever merged it. CHANGELOG.md keeps the duplicate. Refs #911 Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]> AIDD-Session-Id: 3adb1fb2-3894-4e52-afab-424803c7fcad
Refs #911 Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]> AIDD-Session-Id: 3adb1fb2-3894-4e52-afab-424803c7fcad
blafourcade
marked this pull request as ready for review
September 24, 2026 04:26
blafourcade
deleted the
blafourcade/feat-framework-credit-github-contributors-in-gen
branch
September 24, 2026 04:47
Merged
8 of 9 tasks
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
1 participant
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.
🎯 What & why
(@login), or the name without an account.mainaccepts merge commits only: a squashed promote silently drops the week's notes.include-commit-authorsis broken (#2761), so a post-processing step does it.🛠️ How it works
scripts/credit-release-authors.cjs, run inci.ymlafter the releases are created. Idempotent,continue-on-error.--merge --body "". An empty body stops release-please from reading a merge commit twice..github/rulesets/main.json:allowed_merge_methods: ["merge"]. File only, live unchanged.🧪 How to verify
ci.ymljob end to end: 5/5 runs green (deleted since).🚀 Deployment (maintainer)
flowchart TD A[Merge #915 into next] --> B[Run promote.yml] B --> C{Release PR merged<br/>with --merge, tagged?} C -- no --> X[Stop: investigate the ci.yml run] C -- yes --> D{Lines show '(@login)'?<br/>Back-merge green?} D -- no --> X D -- yes --> E[Apply the live ruleset] E --> F["Read back: ['merge']"]gh api -X PUT repos/ai-driven-dev/framework/rulesets/12902947 --input .github/rulesets/main.jsongh api repos/ai-driven-dev/framework/rulesets/12902947 -q '.rules[]|select(.type=="pull_request").parameters.allowed_merge_methods'squashandrebasein settings/rulesgh pr merge <n> --merge --body "". If you forget, the release gets fixed,CHANGELOG.mddoes not.CHANGELOG.md.🔗 Linked issue
Closes #911
✅ I certify
🤖 Generated with Claude Code