Skip to content

Commit d53d154

Browse files
chore: update manual backport readme and trop comment with e backport command (#272)
* docs: add docs on manual backport in readme and trop comment * docs: fix link --------- Co-authored-by: David Sanders <[email protected]>
1 parent 87d47fd commit d53d154

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

docs/manual-backports.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Manual Backports
22

3-
When `trop` fails to backport your PR (trust us it tried its best) you need to backport the PR manually. You can do this by cherry-picking the commits in the PR yourself locally and pushing up a new branch.
3+
When `trop` fails to backport your PR (trust us it tried its best) you need to backport the PR manually. You can do this by cherry-picking the commits in the PR yourself locally and pushing up a new branch or using a [`build-tools` command](#build-tools-backport-command).
44

55
When you create PR for a manual backport, the body of the backport PR must contain:
66

@@ -23,6 +23,10 @@ Backport of https://github.com/electron/electron/pull/21813
2323
If you raise a PR to a branch that isn't `main` or a release branch without including a valid reference as above, `trop` will create a
2424
"failed" check on that PR to prevent it being merged.
2525

26+
## Build Tools Backport Command
27+
28+
You can use the `e backport <PR>` command to backport PRs. [This command](https://github.com/electron/build-tools?tab=readme-ov-file#e-backport-pr) manually backports PRs by automating the steps above.
29+
2630
## Skipping Backport Checks
2731

2832
Sometimes development flows will necessitate a PR train, or several linked PRs to be merged into one another successively where none is a backport. To account for this case, `trop` allows for a label to be set on the non-backport PR: `SKIP_CHECK_LABEL`.

src/utils.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -726,7 +726,7 @@ export const backportImpl = async (
726726
context.repo({
727727
issue_number: pr.number,
728728
body: `I was unable to backport this PR to "${targetBranch}" cleanly;
729-
you will need to perform this backport manually.`,
729+
you will need to perform this [backport manually](https://github.com/electron/trop/blob/main/docs/manual-backports.md#manual-backports).`,
730730
}),
731731
);
732732

0 commit comments

Comments
 (0)