fix: correct the backport runbook and default to non-fork pushes - #922
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository’s backport runbook and Backport CLI configuration to prevent common local backport failures (auth/config mismatches, pushing to a fork by default) and to improve operational guidance around prerequisites, conflict resolution, and post-merge verification.
Changes:
- Revise
.github/BACKPORT.mdto update authentication guidance, add conflict-resolution workflow notes, and add a post-merge content verification step. - Set
"fork": falsein.backportrc.jsonso local backports default to pushing to the origin repo rather than a (possibly nonexistent) personal fork.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| .github/BACKPORT.md | Updates the backport runbook with revised CLI auth examples, conflict-resolution guidance, and verification steps. |
| .backportrc.json | Changes Backport CLI defaults to push to the origin repo ("fork": false). |
Suppressed comments (2)
.github/BACKPORT.md:57
- These CLI examples use
--githubToken, but the Backport CLI flag is--github-token(kebab-case). As written, the token argument may be ignored and the command can fail authentication.
npx backport --pr-query "merged:>=2026-05-01 label:backport-pending" \
--branch release/1.16.0 --branch release/1.15.0 --githubToken "$(gh auth token)"
# Or by path:
npx backport --path en/self-host/use-dify --branch release/1.15.0 --githubToken "$(gh auth token)"
.github/BACKPORT.md:63
- This CLI example uses
--githubToken, but the Backport CLI flag is--github-token(kebab-case).
npx backport --pr <source-pr-number> --branch release/<branch> --githubToken "$(gh auth token)"
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Three defects in the local backport path, each hit in practice during the #901/#903 backports, plus one verification gap:
accessToken; backport v12 only acceptsgithubToken, so following the doc failed at startup.ghlogin token already carriesreposcope and org authorization, so the CLI examples now pass--githubToken "$(gh auth token)". Also clarified that the workflow'sBACKPORT_TOKENis a repository secret and unrelated to CLI auth..backportrc.jsonleftforkat its default (true), so the CLI pushed to a nonexistent personal fork and died."fork": falsematches what the workflow already does.~/.backport/repositories/<org>/<repo>, merge prerequisites before the backport PR is created, and verify propagation by content after merging — docs: document 16 env vars missing from environments.mdx #881 silently missed release/1.16.0 for two weeks.Closes DC-143.