From c535feecb15b484ab1b0b67020b9650d35c7c8b8 Mon Sep 17 00:00:00 2001 From: Antonio Barcelos Date: Thu, 27 Oct 2022 13:45:29 +0200 Subject: [PATCH 1/2] Add release policy note to the readme. --- README.md | 3 +++ packages/neo4j-driver-lite/README.md | 3 +++ packages/neo4j-driver/README.md | 3 +++ 3 files changed, 9 insertions(+) diff --git a/README.md b/README.md index 2eb6990a7..3b67543ac 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,9 @@ Resources to get you started: - [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/5.0-changelog) +> *Starting with 5.0, the Neo4j Drivers will be moving to a monthly release cadence. A minor version will be released on the last Friday of each month so as to maintain versioning consistency with the core product (Neo4j DBMS) which has also moved to a monthly cadence.* +*As a policy, patch versions will not be released except on rare occasions. Bug fixes and updates will go into the latest minor version and users should upgrade to that. Driver upgrades within a major version will never contain breaking API changes.* + ## Including the Driver ### In Node.js application diff --git a/packages/neo4j-driver-lite/README.md b/packages/neo4j-driver-lite/README.md index a8d25b326..7620a91ab 100644 --- a/packages/neo4j-driver-lite/README.md +++ b/packages/neo4j-driver-lite/README.md @@ -12,6 +12,9 @@ Resources to get you started: - [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/5.0-changelog) +> *Starting with 5.0, the Neo4j Drivers will be moving to a monthly release cadence. A minor version will be released on the last Friday of each month so as to maintain versioning consistency with the core product (Neo4j DBMS) which has also moved to a monthly cadence.* +*As a policy, patch versions will not be released except on rare occasions. Bug fixes and updates will go into the latest minor version and users should upgrade to that. Driver upgrades within a major version will never contain breaking API changes.* + ## Including the Driver ### In Node.js application diff --git a/packages/neo4j-driver/README.md b/packages/neo4j-driver/README.md index 2eb6990a7..3b67543ac 100644 --- a/packages/neo4j-driver/README.md +++ b/packages/neo4j-driver/README.md @@ -12,6 +12,9 @@ Resources to get you started: - [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/5.0-changelog) +> *Starting with 5.0, the Neo4j Drivers will be moving to a monthly release cadence. A minor version will be released on the last Friday of each month so as to maintain versioning consistency with the core product (Neo4j DBMS) which has also moved to a monthly cadence.* +*As a policy, patch versions will not be released except on rare occasions. Bug fixes and updates will go into the latest minor version and users should upgrade to that. Driver upgrades within a major version will never contain breaking API changes.* + ## Including the Driver ### In Node.js application From ae358c84c0c9ad971071170b9fd2373df8bc2fce Mon Sep 17 00:00:00 2001 From: Antonio Barcelos Date: Thu, 27 Oct 2022 13:55:05 +0200 Subject: [PATCH 2/2] Moving the docs out of the what's new and include links --- README.md | 9 ++++++--- packages/neo4j-driver-lite/README.md | 9 ++++++--- packages/neo4j-driver/README.md | 9 ++++++--- 3 files changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3b67543ac..249defbff 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ This is the official Neo4j driver for JavaScript. +Starting with 5.0, the Neo4j Drivers will be moving to a monthly release cadence. A minor version will be released on the last Friday of each month so as to maintain versioning consistency with the core product (Neo4j DBMS) which has also moved to a monthly cadence. + +As a policy, patch versions will not be released except on rare occasions. Bug fixes and updates will go into the latest minor version and users should upgrade to that. Driver upgrades within a major version will never contain breaking API changes. + +See also: https://neo4j.com/developer/kb/neo4j-supported-versions/ + Resources to get you started: - [API Documentation](https://neo4j.com/docs/api/javascript-driver/current/) @@ -12,9 +18,6 @@ Resources to get you started: - [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/5.0-changelog) -> *Starting with 5.0, the Neo4j Drivers will be moving to a monthly release cadence. A minor version will be released on the last Friday of each month so as to maintain versioning consistency with the core product (Neo4j DBMS) which has also moved to a monthly cadence.* -*As a policy, patch versions will not be released except on rare occasions. Bug fixes and updates will go into the latest minor version and users should upgrade to that. Driver upgrades within a major version will never contain breaking API changes.* - ## Including the Driver ### In Node.js application diff --git a/packages/neo4j-driver-lite/README.md b/packages/neo4j-driver-lite/README.md index 7620a91ab..bec459146 100644 --- a/packages/neo4j-driver-lite/README.md +++ b/packages/neo4j-driver-lite/README.md @@ -2,6 +2,12 @@ This is the lite version of the official Neo4j driver for JavaScript. +Starting with 5.0, the Neo4j Drivers will be moving to a monthly release cadence. A minor version will be released on the last Friday of each month so as to maintain versioning consistency with the core product (Neo4j DBMS) which has also moved to a monthly cadence. + +As a policy, patch versions will not be released except on rare occasions. Bug fixes and updates will go into the latest minor version and users should upgrade to that. Driver upgrades within a major version will never contain breaking API changes. + +See also: https://neo4j.com/developer/kb/neo4j-supported-versions/ + Resources to get you started: - [API Documentation](https://neo4j.com/docs/api/javascript-driver/current/) @@ -12,9 +18,6 @@ Resources to get you started: - [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/5.0-changelog) -> *Starting with 5.0, the Neo4j Drivers will be moving to a monthly release cadence. A minor version will be released on the last Friday of each month so as to maintain versioning consistency with the core product (Neo4j DBMS) which has also moved to a monthly cadence.* -*As a policy, patch versions will not be released except on rare occasions. Bug fixes and updates will go into the latest minor version and users should upgrade to that. Driver upgrades within a major version will never contain breaking API changes.* - ## Including the Driver ### In Node.js application diff --git a/packages/neo4j-driver/README.md b/packages/neo4j-driver/README.md index 3b67543ac..249defbff 100644 --- a/packages/neo4j-driver/README.md +++ b/packages/neo4j-driver/README.md @@ -2,6 +2,12 @@ This is the official Neo4j driver for JavaScript. +Starting with 5.0, the Neo4j Drivers will be moving to a monthly release cadence. A minor version will be released on the last Friday of each month so as to maintain versioning consistency with the core product (Neo4j DBMS) which has also moved to a monthly cadence. + +As a policy, patch versions will not be released except on rare occasions. Bug fixes and updates will go into the latest minor version and users should upgrade to that. Driver upgrades within a major version will never contain breaking API changes. + +See also: https://neo4j.com/developer/kb/neo4j-supported-versions/ + Resources to get you started: - [API Documentation](https://neo4j.com/docs/api/javascript-driver/current/) @@ -12,9 +18,6 @@ Resources to get you started: - [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/5.0-changelog) -> *Starting with 5.0, the Neo4j Drivers will be moving to a monthly release cadence. A minor version will be released on the last Friday of each month so as to maintain versioning consistency with the core product (Neo4j DBMS) which has also moved to a monthly cadence.* -*As a policy, patch versions will not be released except on rare occasions. Bug fixes and updates will go into the latest minor version and users should upgrade to that. Driver upgrades within a major version will never contain breaking API changes.* - ## Including the Driver ### In Node.js application