You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@recrwplay changed the GitHub actions settings to include
"sorenlouv/backport-github-action@*,", not sure that's enough
---------
Co-authored-by: Neil Dewhurst <[email protected]>
Copy file name to clipboardExpand all lines: README.adoc
+31Lines changed: 31 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,6 +78,36 @@ There are a few edge cases where we might want to work only on the current branc
78
78
* When a new version is ready to published, the `5.x` branch will get a git tag, named with the exact version (for example, **5.1.0**), signifying that this point-in-time marks the completion of the work for that minor release.
79
79
* Updates merged into the `dev` branch for the next release are cherry-picked into the `5.x` branch.
80
80
81
+
=== Enable automatic cherry-picking on a PR
82
+
83
+
To enable automatic cherry-picking on a PR, add the label `auto-cherry-pick` to it.
84
+
Without it, the responsible GitHub action is not going to be triggered.
85
+
86
+
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>`.
87
+
For example: `auto-cherry-pick-to-cypher-25` to cherry-pick it to the branch `cypher-25` or `auto-cherry-pick-to-5.x` for the branch `5.x`.
88
+
You may even add new labels for branches that do not have such a label yet.
89
+
90
+
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.
91
+
In the latter case, ensure that you first add the labels containing the target branches and then finally the `auto-cherry-pick` label.
92
+
Otherwise the automation starts without any target branches.
93
+
94
+
95
+
==== Details
96
+
97
+
The PRs created by this GitHub action will have their heading prefixed with `[Cherry-pick][<targetBranch>]`.
98
+
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.
99
+
In case an assignee was set for the original PR, the cherry-picked PRs will also receive the same assignee.
100
+
You must add reviewers manually after the cherry-picked PRs have been created.
101
+
102
+
The creation of cherry-picked PRs can take a few minutes.
103
+
If you are an assignee of the original PR, you receive an email notification once the cherry-picked PRs have been created.
104
+
The original PR is updated with a comment that contains links to the newly created cherry-picked PRs.
105
+
106
+
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.
107
+
In that case you will have to take care of cherry-picking manually and resolve the conflicts.
108
+
This is not going to influence the other release branches as long as they do not have conflicts.
109
+
110
+
81
111
[[documenting-changes]]
82
112
== Documenting changes to Cypher
83
113
@@ -117,3 +147,4 @@ When documenting a new Cypher feature, its relationship with GQL must be conside
117
147
* If the feature is part of GQL's optional features, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/supported-optional.adoc[Supported optional GQL features].
118
148
* if the feature adds functionality for which there exists an analogous, optional GQL feature, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/analogous-cypher.adoc[Optional GQL features and analogous Cypher].
119
149
* If the feature adds functionality for which there exists no GQL equivalent, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/additional-cypher.adoc[Additional Cypher features].
0 commit comments