This is an automated email from the ASF dual-hosted git repository. danhaywood pushed a commit to branch 3.2.0 in repository https://gitbox.apache.org/repos/asf/causeway.git
commit b69eb77da8ceef6fa4802343e891cf360f4534c8 Author: Dan Haywood <[email protected]> AuthorDate: Tue Dec 31 16:24:28 2024 +0000 CAUSEWAY-3800 : further doc simplifications removing reference to v2 branch --- .../modules/ROOT/pages/cutting-a-release.adoc | 20 ++++++++++++-------- .../modules/ROOT/pages/post-release-successful.adoc | 20 +++++++++++++------- .../comguide/modules/ROOT/pages/starter-apps.adoc | 10 +++++----- .../modules/ROOT/pages/verifying-releases.adoc | 6 ------ 4 files changed, 30 insertions(+), 26 deletions(-) diff --git a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc index 829fbf63f0f..7f4b5ede540 100644 --- a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc +++ b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc @@ -538,19 +538,23 @@ The remote tags aren't visible locally but can be seen link:https://github.com/a [#update-starter-apps] == Update starter apps -For each of the two starter apps, we maintain (currently) eight branches: +// For each of the two starter apps, we maintain (currently) eight branches: +For each of the two starter apps, we maintain four branches: -* `v2-jpa` and `v2-jdo` ; and also `v3-jpa` and `v3-jdo` +// * `v3-jpa` and `v3-jdo` ; and also `v4-jpa` and `v4-jdo` +* `v3-jpa` and `v3-jdo` + These are intended to reference the _most recently released_ version, the first demonstrating persistence using JDO, the second using JPA. These are the branches referenced from the home page and getting started pages of the website. -* `v2-jpa-SNAPSHOT` and `v2-jdo-SNAPSHOT` ; and also `v3-jpa-SNAPSHOT` and `v3-jdo-SNAPSHOT` +// * `v3-jpa-SNAPSHOT` and `v3-jdo-SNAPSHOT` ; and also `v4-jpa-SNAPSHOT` and `v4-jdo-SNAPSHOT` +* `v3-jpa-SNAPSHOT` and `v3-jdo-SNAPSHOT` + These reference the most current snapshot nightly build. -The general idea is that a release will fast-forward `v{2,3}-jpa` to `v{2,3}-jpa-SNAPSHOT` and similarly moves `v{2,3}-jdo` up to `v{2,3}-jdo-SNAPSHOT`, bumping to the newly released version of the framework in the process. +The general idea is that a release will fast-forward `vN-jpa` to `vN-jpa-SNAPSHOT` and similarly moves `vN-jdo` up to `vN-jdo-SNAPSHOT`, bumping to the newly released version of the framework in the process. This is done for all current `vN` branches. +The non-SNAPSHOT builds should always reference the most recently release. In order that we don't break the starter apps while a release is being voted on, we do the changes in work branches, `$CAUSEWAYBRANCH-jpa` and `$CAUSEWAYBRANCH-jdo`. @@ -564,7 +568,7 @@ For _helloworld_, we create a release branch for both variants: + [source,bash,subs="attributes+"] ---- -git checkout v3-jpa-SNAPSHOT # or: git checkout v2-jpa-SNAPSHOT +git checkout v3-jpa-SNAPSHOT git pull --ff-only git checkout -b $CAUSEWAYBRANCH-jpa @@ -601,7 +605,7 @@ git push -u origin $CAUSEWAYBRANCH-jpa + [source,bash,subs="attributes+"] ---- -git checkout v3-jdo-SNAPSHOT # or: git checkout v2-jdo-SNAPSHOT +git checkout v3-jdo-SNAPSHOT git pull --ff-only git checkout -b $CAUSEWAYBRANCH-jdo @@ -657,7 +661,7 @@ For _simple app_, the steps are almost the same: + [source,bash,subs="attributes+"] ---- -git checkout v3-jpa-SNAPSHOT # or: git checkout v2-jpa-SNAPSHOT +git checkout v3-jpa-SNAPSHOT git pull --ff-only git checkout -b $CAUSEWAYBRANCH-jpa @@ -694,7 +698,7 @@ git push -u origin $CAUSEWAYBRANCH-jpa + [source,bash,subs="attributes+"] ---- -git checkout v3-jdo-SNAPSHOT # or: git checkout v2-jdo-SNAPSHOT +git checkout v3-jdo-SNAPSHOT git pull --ff-only git checkout -b $CAUSEWAYBRANCH-jdo diff --git a/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc b/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc index 9225ca054cf..2f8c8299d4b 100644 --- a/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc +++ b/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc @@ -560,25 +560,31 @@ git commit -m "$CAUSEWAYJIRA: bumps BASELINE to latest release version" == Update starter projects -As explained in xref:cutting-a-release.adoc#update-starter-apps[cutting a release],for each of the two starter apps, we maintain eight (!) branches: +As explained in xref:cutting-a-release.adoc#update-starter-apps[cutting a release],for each of the two starter apps, we maintain +// eight (!) +four +branches: -* `v2-jpa`; `v2-jdo`; `v3-jpa`; `v3-jdo` +// * `v3-jpa`; `v3-jdo`; `v4-jpa`; `v4-jdo` +* `v3-jpa`; `v3-jdo` + These are intended to reference the _most recently released_ version, the first demonstrating persistence using JDO, the second using JPA. These are the branches referenced from the home page and getting started pages of the website. -* `v2-jpa-SNAPSHOT`; `v2-jdo-SNAPSHOT`; `v3-jpa-SNAPSHOT`; `v3-jdo-SNAPSHOT` +// * `v3-jpa-SNAPSHOT`; `v3-jdo-SNAPSHOT`; `v4-jpa-SNAPSHOT`; `v4-jdo-SNAPSHOT` +* `v3-jpa-SNAPSHOT`; `v3-jdo-SNAPSHOT` + These reference the most current snapshot nightly build. -The general idea is that a release will fast-forward `v2-jpa` to `v2-jpa-SNAPSHOT` and similarly moves `v2-jdo` up to `v2-jdo-SNAPSHOT`, and then repeat the process for v3. -The non-SNAPSHOT builds should always reference the most recently release of v2 or v3. +The general idea is that a release will fast-forward `vN-jpa` to `vN-jpa-SNAPSHOT` and similarly moves `vN-jdo` up to `vN-jdo-SNAPSHOT`, bumping to the newly released version of the framework in the process. +This is done for all current `vN` branches. +The non-SNAPSHOT builds should always reference the most recently release. -In order that we don't break the starter apps while a release is being voted on, we do the changes in work branches, `$CAUSEWAYBRANCH-jpa` and `$CAUSEWAYBRANCH-jdo` (where `$CAUSEWAYBRANCH` is "release-2.0.0-RC1", or "release-3.0.0-RC1" etc). +In order that we don't break the starter apps while a release is being voted on, we do the changes in work branches, `$CAUSEWAYBRANCH-jpa` and `$CAUSEWAYBRANCH-jdo`. Now that the release is complete, tidy up these branches and then set up the `-SNAPSHOT` branches as required. -IMPORTANT: The `v{2,3}-{jpa,jdo}` branches should always work against the most recent release, whereas the `v{2,3}-{jpa,jdo}-SNAPSHOT` reference more recent nightly builds if necessary. +IMPORTANT: The `vN-{jpa,jdo}` branches should always work against the most recent release, whereas the `vN-{jpa,jdo}-SNAPSHOT` reference more recent nightly builds if necessary. == Update the reference app diff --git a/antora/components/comguide/modules/ROOT/pages/starter-apps.adoc b/antora/components/comguide/modules/ROOT/pages/starter-apps.adoc index a90b8727ec5..729e0c7a189 100644 --- a/antora/components/comguide/modules/ROOT/pages/starter-apps.adoc +++ b/antora/components/comguide/modules/ROOT/pages/starter-apps.adoc @@ -8,11 +8,11 @@ When making updates for simpleapp, to the current snapshot: -. make change to `v2-jpa-SNAPSHOT` -. forward port from `v2-jpa-SNAPSHOT` to `v3-jpa-SNAPSHOT` -. merge down from `v2-jpa-SNAPSHOT` to `v2-jdo-SNAPSHOT` -. forward port from `v2-jdo-SNAPSHOT` to `v3-jdo-SNAPSHOT` -. merge down from `v3-jpa-SNAPSHOT` to `v3-jdo-SNAPSHOT` (should be a no-op) +. make change to `v3-jpa-SNAPSHOT` +// . forward port from `v3-jpa-SNAPSHOT` to `v4-jpa-SNAPSHOT` +. merge down from `v3-jpa-SNAPSHOT` to `v3-jdo-SNAPSHOT` +// . forward port from `v3-jdo-SNAPSHOT` to `v4-jdo-SNAPSHOT` +// . merge down from `v4-jpa-SNAPSHOT` to `v4-jdo-SNAPSHOT` (should be a no-op) [NOTE] ==== diff --git a/antora/components/comguide/modules/ROOT/pages/verifying-releases.adoc b/antora/components/comguide/modules/ROOT/pages/verifying-releases.adoc index efbd6c40816..c5999a24053 100644 --- a/antora/components/comguide/modules/ROOT/pages/verifying-releases.adoc +++ b/antora/components/comguide/modules/ROOT/pages/verifying-releases.adoc @@ -38,12 +38,6 @@ You will also require the following commands/tools: * `gpg` - to verify signatures * `unzip` - to unzip the ZIP files * JDK 17 -+ -[NOTE] -==== -v2 is for the most part compatible with Java 11 and almost all of the modules target Java 11. -The one exception is GraphQL viewer's test modules, which require Java 17. -==== * Apache Maven (`mvn`) 3.9.6+
