Skip to content

Commit ed043a4

Browse files
committed
added section to readme about auto-cherry-pick github action
1 parent a33fe53 commit ed043a4

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

README.adoc

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
= Neo4j GraphQL Library
1+
= Neo4j GraphQL library docs
22

33
This repo contains the documentation for the Neo4j GraphQL Library.
44

5-
== Prereqs
5+
== Prerequisites
66

77
- link:https://nodejs.org/en/download/[Node.js]
88
- npm
@@ -113,3 +113,33 @@ When we publish preview content to either development or production environments
113113

114114
You can use the link:https://www.npmjs.com/package/@neo4j-antora/antora-add-notes[antora-add-notes] extension to add content to your pages.
115115
Follow the Usage instructions in the package documentation.
116+
117+
== Repository and pull requests
118+
119+
=== Enable automatic cherry-picking on a PR
120+
121+
To enable automatic cherry-picking on a PR, add the label `auto-cherry-pick` to it.
122+
Without it, the responsible GitHub action is not going to be triggered.
123+
124+
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>`.
125+
For example: `auto-cherry-pick-to-6.x` to cherry-pick it to the branch `6.x` or `auto-cherry-pick-to-5.x` for the branch `5.x`.
126+
You may even add new labels for branches that do not have such a label yet.
127+
128+
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.
129+
In the latter case, ensure that you first add the labels containing the target branches and then finally the `auto-cherry-pick` label.
130+
Otherwise the automation starts without any target branches.
131+
132+
==== Details
133+
134+
The PRs created by this GitHub action will have their heading prefixed with `[Cherry-pick][<targetBranch>]`.
135+
So, for example, for `6.x` as the target branch and `some changes` as the original PR heading, it results in `[Cherry-pick][6.x] some changes` as the heading for the cherry-picked PR.
136+
In case an assignee was set for the original PR, the cherry-picked PRs will also receive the same assignee.
137+
You must add reviewers manually after the cherry-picked PRs have been created.
138+
139+
The creation of cherry-picked PRs can take a few minutes.
140+
If you are an assignee of the original PR, you receive an email notification once the cherry-picked PRs have been created.
141+
The original PR is updated with a comment that contains links to the newly created cherry-picked PRs.
142+
143+
In case of a merge conflict while cherry-picking to a specific release branch, the branch will be skipped. Information on skipped branches is also included in the comment added to the original PR.
144+
In that case you will have to take care of cherry-picking manually and resolve the conflicts.
145+
This is not going to influence the other release branches as long as they do not have conflicts.

0 commit comments

Comments
 (0)