Skip to content

Commit d41b4ce

Browse files
authored
docs: explain BEGIN_COMMIT_OVERRIDE for PRs with several changes (#2445)
A squash merge keeps only the PR title, so release-please lists one changelog entry per PR. Document the commit override block for PRs that contain several changes that should be listed separately.
1 parent ee5bc10 commit d41b4ce

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,21 @@ into the root `settings.gradle.kts`; build them from their own directory.
7373
prefix causes a wrong release bump.
7474
- **PR Title Validation**: Ensure PR titles strictly conform to Conventional Commits (e.g., `fix: stale QuadItem removal` instead of `Fix stale QuadItem removal`). When PRs are squash-merged into `main`, GitHub uses the PR title as the default commit header; a non-conforming title prevents release-please from accurately categorizing changes in CHANGELOG.md or calculating semantic version increments.
7575
- Never edit CHANGELOG.md or `.release-please-manifest.json` by hand.
76+
- **Several changes in one PR**: a squash merge keeps only the PR title, so
77+
release-please would list one entry. When a PR contains several changes that
78+
belong in the changelog separately (for example several bug fixes), add a
79+
commit override block at the end of the PR description, one Conventional
80+
Commit per line. release-please uses these lines instead of the PR title:
81+
82+
```
83+
BEGIN_COMMIT_OVERRIDE
84+
fix(ApiDemos): describe the first fix
85+
fix(snippets): describe the second fix
86+
END_COMMIT_OVERRIDE
87+
```
88+
89+
The PR title still has to be a valid Conventional Commit. Each line counts
90+
for the version bump, so a `feat:` or `!` line bumps accordingly.
7691
- All pull requests are to be created as drafts (`gh pr create --draft`) until authorization is explicitly given to mark them ready for review. Always inform the user that the PR was created as a draft.
7792
- Keep changes scoped to one sample or one feature across its language
7893
variants; do not mix unrelated samples in one PR.

0 commit comments

Comments
 (0)