Skip to content

Commit ee37101

Browse files
Merge branch 'dev' into select_version
2 parents 63d64d4 + 9aefb60 commit ee37101

File tree

291 files changed

+6329
-5688
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

291 files changed

+6329
-5688
lines changed

.backportrc.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"repoOwner": "Neo4j",
3+
"repoName": "docs-cypher",
4+
"prTitle": "[Cherry-pick][{{targetBranch}}] {{commitMessages}}"
5+
}
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: auto-cherry-pick
2+
on:
3+
pull_request_target:
4+
types: ["closed"]
5+
6+
jobs:
7+
backport:
8+
name: Cherry-pick PR
9+
runs-on: [ubuntu-latest]
10+
if: |
11+
github.event.pull_request.merged == true
12+
&& contains(github.event.pull_request.labels.*.name, 'cherry-pick')
13+
&& github.event.action == 'closed'
14+
steps:
15+
- name: Cherry-pick action
16+
uses: sorenlouv/backport-github-action@929f69d04adbc196d982e60f02837b6cc00b3129
17+
with:
18+
github_token: ${{ secrets.GITHUB_TOKEN }}
19+
auto_backport_label_prefix: cherry-pick-to-
20+
add_original_reviewers: false
21+
22+
- name: Info log
23+
if: ${{ success() }}
24+
run: cat ~/.backport/backport.info.log
25+
26+
- name: Debug log
27+
if: ${{ failure() }}
28+
run: cat ~/.backport/backport.debug.log

README.adoc

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ To view the built site, launch a local server:
4040
. `npm start`
4141
. In a browser tab, go to `localhost:8000`
4242

43-
4443
=== Live preview
4544

4645
When you run `npm start`, the project is monitored for updates to asciidoc files.
@@ -78,6 +77,37 @@ There are a few edge cases where we might want to work only on the current branc
7877
* When a new version is ready to published, the `cypher-25` branch will get a git tag, named with the exact version (for example, **2025.01.00**), signifying that this point-in-time marks the completion of the work for that minor release.
7978
* Updates merged into the `dev` branch for the next release are cherry-picked into the `cypher-25` branch.
8079

80+
81+
=== Enable automatic cherry-picking on a PR
82+
83+
To enable automatic cherry-picking on a PR, add the label `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: `cherry-pick-to-<targetBranch>`.
87+
For example: `cherry-pick-to-cypher-25` to cherry-pick it to the branch `cypher-25` or `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 `cherry-pick` label or by adding the `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 `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+
81111
[[documenting-changes]]
82112
== Documenting changes to Cypher
83113

@@ -117,3 +147,4 @@ When documenting a new Cypher feature, its relationship with GQL must be conside
117147
* 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].
118148
* 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].
119149
* 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].
150+

modules/ROOT/.DS_Store

8 KB
Binary file not shown.

modules/ROOT/content-nav.adoc

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
** xref:queries/composed-queries/index.adoc[]
1111
*** xref:queries/composed-queries/combined-queries.adoc[]
1212
*** xref:queries/composed-queries/conditional-queries.adoc[]
13+
*** xref:queries/composed-queries/sequential-queries.adoc[]
1314
1415
* xref:clauses/index.adoc[]
1516
** xref:clauses/clause-composition.adoc[]
@@ -53,20 +54,22 @@
5354
** xref:patterns/variable-length-patterns.adoc[]
5455
** xref:patterns/shortest-paths.adoc[]
5556
** xref:patterns/non-linear-patterns.adoc[]
57+
** xref:patterns/match-modes.adoc[]
5658
** xref:patterns/reference.adoc[]
5759
5860
* xref:values-and-types/index.adoc[]
59-
** xref:values-and-types/property-structural-constructed.adoc[]
60-
** xref:values-and-types/temporal.adoc[]
61-
** xref:values-and-types/spatial.adoc[]
62-
** xref:values-and-types/working-with-null.adoc[]
63-
** xref:values-and-types/lists.adoc[]
64-
** xref:values-and-types/maps.adoc[]
65-
** xref:values-and-types/casting-data.adoc[]
61+
** xref::values-and-types/property-structural-constructed.adoc[]
62+
** xref:values-and-types/boolean-numeric-string.adoc[]
63+
** xref::values-and-types/temporal.adoc[]
64+
** xref::values-and-types/spatial.adoc[]
65+
** xref::values-and-types/lists.adoc[]
66+
** xref::values-and-types/maps.adoc[]
67+
** xref:values-and-types/graph-references.adoc[]
68+
** xref::values-and-types/working-with-null.adoc[]
69+
** xref::values-and-types/casting-data.adoc[]
6670
** xref:values-and-types/ordering-equality-comparison.adoc[]
6771
6872
* xref:expressions/index.adoc[]
69-
** xref:expressions/expressions-overview.adoc[]
7073
** xref:expressions/predicates/index.adoc[]
7174
*** xref:expressions/predicates/boolean-operators.adoc[]
7275
*** xref:expressions/predicates/comparison-operators.adoc[]
@@ -136,7 +139,6 @@
136139
** xref:syntax/variables.adoc[]
137140
** xref:syntax/keywords.adoc[]
138141
** xref:syntax/parameters.adoc[]
139-
** xref:syntax/operators.adoc[]
140142
** xref:syntax/comments.adoc[]
141143
142144
* xref:deprecations-additions-removals-compatibility.adoc[]
@@ -152,4 +154,4 @@
152154
** xref:appendix/tutorials/index.adoc[]
153155
*** xref:appendix/tutorials/basic-query-tuning.adoc[]
154156
*** xref:appendix/tutorials/advanced-query-tuning.adoc[]
155-
*** xref:appendix/tutorials/shortestpath-planning.adoc[]
157+
*** xref:appendix/tutorials/shortestpath-planning.adoc[]

modules/ROOT/images/call-procedure.svg

Lines changed: 27 additions & 0 deletions
Loading

modules/ROOT/images/call-subquery-graph.svg

Lines changed: 12 additions & 0 deletions
Loading

modules/ROOT/images/call_procedure.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

modules/ROOT/images/call_subquery_graph.svg

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)