Skip to content

Commit 7657599

Browse files
Update Readme and yml files for Cypher 25 (#1057)
1 parent 3b8732a commit 7657599

File tree

6 files changed

+17
-22
lines changed

6 files changed

+17
-22
lines changed

.github/workflows/docs-pr-checks.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ on:
55
pull_request:
66
branches:
77
- "dev"
8+
- "cypher-25"
89
- "5.x"
910
- "4.[0-9]"
1011
- "3.5"

.github/workflows/docs-teardown.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ on:
55
pull_request_target:
66
branches:
77
- "dev"
8+
- "cypher-25"
89
- "5.x"
910
- "4.[0-9]"
1011
- "3.5"

README.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ If a change to an asciidoc file is detected, the site is automatically rebuilt.
4848
The docs-cypher repo (and all CoreDB docs repos) will contain the following branches:
4949

5050
* `4.4` - Long term support
51-
* `5.x` - this is the currently published version, and therefore is the branch that we publish all v5 docs from.
51+
* `5.x` - Long term support.
52+
* `cypher-25` - this is the currently published version, and therefore is the branch that we publish all Cypher 25 docs from.
5253
** PRs merged into this branch will be published live immediately.
5354
* `dev` - this is always the next release - this branch will be published on the staging server, as a preview, but we will never publish from this branch publicly.
5455
** Next means the “next version of documentation”, and may not mirror other Neo4j engineering repos.
@@ -60,11 +61,11 @@ Within Github we’ll update the branch descriptions with what the current and n
6061

6162
Here is the workflow for creating PRs in the repo, and our publication process:
6263

63-
* For any work on the **current** version, all work should be raised & merged against the `dev` branch, and cherry-picked back to `5.x` branch.
64+
* For any work on the **current** version, all work should be raised & merged against the `dev` branch, and cherry-picked back to `cypher-25` branch.
6465
There are a few edge cases where we might want to work only on the current branch, for example adding a warning that is not needed in the next version - this is ok!
6566
* For content relating to the **next** release, raise PRs against the dev branch and use labels to mark the specific version it is targeting.
6667
* For work on **next+n** docs (i.e a version beyond **next**), we have 2 options:
67-
** Open a draft PR against `dev`, with a label for the specific version it is targeting - this can be shared & reviewed in draft mode, but will not be mergeable until it is pointed at the next release.
68+
** Open a draft PR against `dev`, with a label for the specific server version it is targeting (e.g. `2025.01` ) - this can be shared & reviewed in draft mode, but will not be mergeable until it is pointed at the next release.
6869
** Create a feature branch from `dev`, to be merged into `dev` when appropriate.
69-
* 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.
70-
* Updates merged into the `dev` branch for the next release are cherry-picked into the `5.x` branch.
70+
* 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.
71+
* Updates merged into the `dev` branch for the next release are cherry-picked into the `cypher-25` branch.

antora.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
name: cypher-manual
22
title: Cypher Manual
3-
version: '5'
3+
version: '25'
44
start_page: ROOT:introduction/index.adoc
55
nav:
66
- modules/ROOT/content-nav.adoc
77
asciidoc:
88
attributes:
9-
neo4j-version: '5'
10-
neo4j-version-minor: '5.25'
11-
neo4j-version-exact: '5.25.0'
9+
neo4j-version: '2025.01'
10+
neo4j-version-minor: '2025.01.00'

preview.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ urls:
2525
antora:
2626
extensions:
2727
- require: "@neo4j-antora/antora-modify-sitemaps"
28-
sitemap_version: '5'
28+
sitemap_version: '25'
2929
sitemap_loc_version: 'current'
3030
move_sitemaps_to_components: true
3131

@@ -53,7 +53,7 @@ asciidoc:
5353
includePDF: false
5454
nonhtmloutput: ""
5555
experimental: ''
56-
copyright: "2024 Neo4j, Inc."
56+
copyright: "2025 Neo4j, Inc."
5757
common-license-page-uri: https://neo4j.com/docs/license/
5858
docs-base-uri: https://neo4j.com/docs
5959
check-mark: icon:check[]

publish.yml

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ site:
66
content:
77
sources:
88
- url: ./
9-
branches: ['3.5', '4.0', '4.1', '4.2', '4.3', '4.4', 'HEAD']
9+
branches: ['4.4', '5.x' 'HEAD']
1010
edit_url: https://github.com/neo4j/docs-cypher/tree/{refname}/{path}
1111
exclude:
1212
- '!**/_includes/*'
@@ -25,7 +25,7 @@ urls:
2525
antora:
2626
extensions:
2727
- require: "@neo4j-antora/antora-modify-sitemaps"
28-
sitemap_version: '5'
28+
sitemap_version: '25'
2929
sitemap_loc_version: 'current'
3030
move_sitemaps_to_components: true
3131

@@ -53,18 +53,11 @@ asciidoc:
5353
includePDF: false
5454
nonhtmloutput: ""
5555
experimental: ''
56-
copyright: "2024 Neo4j, Inc."
56+
copyright: "2025 Neo4j, Inc."
5757
common-license-page-uri: https://neo4j.com/docs/license/
5858
docs-base-uri: https://neo4j.com/docs
5959
check-mark: icon:check[]
6060
cross-mark: icon:times[]
6161
neo4j-base-uri: ''
6262
neo4j-docs-base-uri: /docs
63-
# NODES 2024 AD
64-
page-ad-overline-link: https://neo4j.registration.goldcast.io/events/03805ea9-fe3a-4cac-8c15-aa622666531a?utm_source=neodocs&utm_medium=banner&utm_campaign=std
65-
page-ad-image: https://neo4j.com/docs/assets/img/nodes-24.png
66-
page-ad-title: Neo4j Online Developer Conference
67-
page-ad-description: Join us on November 7 for live and unique tech talks over 24 hours across all timezones.
68-
page-ad-link: https://neo4j.registration.goldcast.io/events/03805ea9-fe3a-4cac-8c15-aa622666531a?utm_source=neodocs&utm_medium=banner&utm_campaign=std
69-
page-ad-underline-role: button
70-
page-ad-underline: Register
63+

0 commit comments

Comments
 (0)