Skip to content

Commit 6d8cddf

Browse files
Add information about automated cherry-picks (#2413)
Relies on PR #2410
1 parent 376807f commit 6d8cddf

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.adoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,34 @@ When you run `npm start`, the project is monitored for updates to asciidoc files
3535

3636
If a change to an asciidoc file is detected the site is automatically rebuilt.
3737

38+
== Enable automatic cherry-picking on a PR
39+
40+
To enable automatic cherry-picking on a PR, add the label `auto-cherry-pick` to it.
41+
Without it, the responsible GitHub action is not going to be triggered.
42+
43+
To select the target branches you would like to cherry-pick your PR to, add labels of the following structure: `auto-cherry-pick-to-<targetBranch>`.
44+
For example: `auto-cherry-pick-to-main` to cherry-pick it to the branch `main` or `auto-cherry-pick-to-5.x` for the branch `5.x`.
45+
You may even add new labels for branches that do not have such a label yet.
46+
47+
The feature is triggered by either merging a PR with the `auto-cherry-pick` label or by adding the `auto-cherry-pick` label to an already closed and merged PR.
48+
In the latter case, ensure that you first add the labels containing the target branches and then finally the `auto-cherry-pick` label.
49+
Otherwise the automation starts without any target branches.
50+
51+
=== Details
52+
53+
The PRs created by this GitHub action will have their heading prefixed with `[Cherry-pick][<targetBranch>]`.
54+
So, for example, for `main` as the target branch and `some changes` as the original PR heading, it results in `[Cherry-pick][main] some changes` as the heading for the cherry-picked PR.
55+
In case an assignee was set for the original PR, the cherry-picked PRs will also receive the same assignee.
56+
You must add reviewers manually after the cherry-picked PRs have been created.
57+
58+
The creation of cherry-picked PRs can take a few minutes.
59+
If you are an assignee of the original PR, you receive an email notification once the cherry-picked PRs have been created.
60+
The original PR is updated with a comment that contains links to the newly created cherry-picked PRs.
61+
62+
In case of a merge conflict while cherry-picking to a specific release branch, the branch will be skipped.
63+
Information on skipped branches is also included in the comment added to the original PR.
64+
In that case you have to take care of cherry-picking manually and resolve the conflicts.
65+
This is not going to influence the other release branches as long as they do not have conflicts.
66+
67+
68+

0 commit comments

Comments
 (0)