github/codeql-action
1
0
Fork 0
mirror of https://github.com/github/codeql-action.git synced 2026-10-03 17:41:28 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ccd5275aa4e05dc04af2de7c55dd2272269ecc6d
codeql-action/.github/instructions/release-merge.instructions.md
Paolo Tranquilli 42c2ea9ef7 Document merge-commit requirement for release PRs 
Release, mergeback, and backport PRs must be merged with a merge commit
so the branch linkage the release automation depends on is preserved
(the mergeback tags the release using the merge commit of the
"Merge main into releases/vN" PR, so squashing or rebasing breaks
tagging).

Add a path-scoped Copilot instructions file scoped to the files that
reliably change in these PRs (CHANGELOG.md, src/defaults.json,
lib/defaults.json, src/api-compatibility.json), and add an explicit note
to the Releasing runbook in CONTRIBUTING.md so the rule is enforced
regardless of who merges.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 0dae6e42-7fc6-4fb1-b1ea-15dc17e402a2
2026-08-26 17:13:12 +02:00

707 B
Raw Blame History

applyTo
applyTo
CHANGELOG.md,src/defaults.json,lib/defaults.json,src/api-compatibility.json

Merging release, mergeback, and backport PRs

The release process creates a cascade of PRs (main → releases/vN, then releases/vN → main mergeback, then releases/vN → releases/v(N-1) backport). These PRs reliably touch CHANGELOG.md, src/defaults.json / lib/defaults.json (bundle/CLI version bump), and src/api-compatibility.json.

Such PRs must be merged with a merge commit. Never squash or rebase, as that breaks the branch linkage the release automation relies on.

When arming auto-merge on these PRs, use --merge (e.g. gh pr merge --merge), not --squash or --rebase.