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 9e3c41761fdfa16c6a6c69ab98e30eef2840d82b Author: Dan Haywood <[email protected]> AuthorDate: Tue Dec 31 16:32:12 2024 +0000 CAUSEWAY-3800 : further doc parameterization --- .../modules/ROOT/pages/cutting-a-release.adoc | 22 +++++++++++----------- .../ROOT/pages/post-release-successful.adoc | 8 ++++---- .../comguide/modules/ROOT/pages/starter-apps.adoc | 10 +++++----- antora/playbooks/site.NEXT.yml | 2 ++ antora/playbooks/site.yml | 2 ++ 5 files changed, 24 insertions(+), 20 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 7f4b5ede540..649a62c251e 100644 --- a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc +++ b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc @@ -541,14 +541,14 @@ The remote tags aren't visible locally but can be seen link:https://github.com/a // For each of the two starter apps, we maintain (currently) eight branches: For each of the two starter apps, we maintain four branches: -// * `v3-jpa` and `v3-jdo` ; and also `v4-jpa` and `v4-jdo` -* `v3-jpa` and `v3-jdo` +// * `{page-causewaycurrmajorversion}-jpa` and `{page-causewaycurrmajorversion}-jdo` ; and also `{page-causewaynextmajorversion}-jpa` and `{page-causewaynextmajorversion}-jdo` +* `{page-causewaycurrmajorversion}-jpa` and `{page-causewaycurrmajorversion}-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. -// * `v3-jpa-SNAPSHOT` and `v3-jdo-SNAPSHOT` ; and also `v4-jpa-SNAPSHOT` and `v4-jdo-SNAPSHOT` -* `v3-jpa-SNAPSHOT` and `v3-jdo-SNAPSHOT` +// * `{page-causewaycurrmajorversion}-jpa-SNAPSHOT` and `{page-causewaycurrmajorversion}-jdo-SNAPSHOT` ; and also `{page-causewaynextmajorversion}-jpa-SNAPSHOT` and `{page-causewaynextmajorversion}-jdo-SNAPSHOT` +* `{page-causewaycurrmajorversion}-jpa-SNAPSHOT` and `{page-causewaycurrmajorversion}-jdo-SNAPSHOT` + These reference the most current snapshot nightly build. @@ -562,13 +562,13 @@ In order that we don't break the starter apps while a release is being voted on, For _helloworld_, we create a release branch for both variants: -* for `v3-jpa`: +* for `jpa`: + ** Checkout the branch, bump versions, and commit: + [source,bash,subs="attributes+"] ---- -git checkout v3-jpa-SNAPSHOT +git checkout {page-causewaycurrmajorversion}-jpa-SNAPSHOT git pull --ff-only git checkout -b $CAUSEWAYBRANCH-jpa @@ -605,7 +605,7 @@ git push -u origin $CAUSEWAYBRANCH-jpa + [source,bash,subs="attributes+"] ---- -git checkout v3-jdo-SNAPSHOT +git checkout {page-causewaycurrmajorversion}-jdo-SNAPSHOT git pull --ff-only git checkout -b $CAUSEWAYBRANCH-jdo @@ -627,9 +627,9 @@ mvnd spring-boot:run ** Make any additional changes that might be required, and re-test. + -This might be easiest to just cherry-pick commits made on the `v3-jpa` branch. +This might be easiest to just cherry-pick commits made on the `{page-causewaycurrmajorversion}-jpa` branch. -** Merge in the `v3-jpa` branch, discarding any conflicts. +** Merge in the `{page-causewaycurrmajorversion}-jpa` branch, discarding any conflicts. + [source,bash,subs="attributes+"] ---- @@ -661,7 +661,7 @@ For _simple app_, the steps are almost the same: + [source,bash,subs="attributes+"] ---- -git checkout v3-jpa-SNAPSHOT +git checkout {page-causewaycurrmajorversion}-jpa-SNAPSHOT git pull --ff-only git checkout -b $CAUSEWAYBRANCH-jpa @@ -698,7 +698,7 @@ git push -u origin $CAUSEWAYBRANCH-jpa + [source,bash,subs="attributes+"] ---- -git checkout v3-jdo-SNAPSHOT +git checkout {page-causewaycurrmajorversion}-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 2f8c8299d4b..d3009325de5 100644 --- a/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc +++ b/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc @@ -565,14 +565,14 @@ As explained in xref:cutting-a-release.adoc#update-starter-apps[cutting a releas four branches: -// * `v3-jpa`; `v3-jdo`; `v4-jpa`; `v4-jdo` -* `v3-jpa`; `v3-jdo` +// * `{page-causewaycurrmajorversion}-jpa`; `{page-causewaycurrmajorversion}-jdo`; `{page-causewaynextmajorversion}-jpa`; `{page-causewaynextmajorversion}-jdo` +* `{page-causewaycurrmajorversion}-jpa`; `{page-causewaycurrmajorversion}-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. -// * `v3-jpa-SNAPSHOT`; `v3-jdo-SNAPSHOT`; `v4-jpa-SNAPSHOT`; `v4-jdo-SNAPSHOT` -* `v3-jpa-SNAPSHOT`; `v3-jdo-SNAPSHOT` +// * `{page-causewaycurrmajorversion}-jpa-SNAPSHOT`; `{page-causewaycurrmajorversion}-jdo-SNAPSHOT`; `{page-causewaynextmajorversion}-jpa-SNAPSHOT`; `{page-causewaynextmajorversion}-jdo-SNAPSHOT` +* `{page-causewaycurrmajorversion}-jpa-SNAPSHOT`; `{page-causewaycurrmajorversion}-jdo-SNAPSHOT` + These reference the most current snapshot nightly build. diff --git a/antora/components/comguide/modules/ROOT/pages/starter-apps.adoc b/antora/components/comguide/modules/ROOT/pages/starter-apps.adoc index 729e0c7a189..cd2f8366033 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 `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) +. make change to `{page-causewaycurrmajorversion}-jpa-SNAPSHOT` +// . forward port from `{page-causewaycurrmajorversion}-jpa-SNAPSHOT` to `{page-causewaynextmajorversion}-jpa-SNAPSHOT` +. merge down from `{page-causewaycurrmajorversion}-jpa-SNAPSHOT` to `{page-causewaycurrmajorversion}-jdo-SNAPSHOT` +// . forward port from `{page-causewaycurrmajorversion}-jdo-SNAPSHOT` to `{page-causewaynextmajorversion}-jdo-SNAPSHOT` +// . merge down from `{page-causewaynextmajorversion}-jpa-SNAPSHOT` to `{page-causewaynextmajorversion}-jdo-SNAPSHOT` (should be a no-op) [NOTE] ==== diff --git a/antora/playbooks/site.NEXT.yml b/antora/playbooks/site.NEXT.yml index c340d84f1fa..e7bf21f4e3c 100644 --- a/antora/playbooks/site.NEXT.yml +++ b/antora/playbooks/site.NEXT.yml @@ -302,6 +302,8 @@ asciidoc: kroki-default-options: interactive # only available for SVG kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) + page-causewaycurrmajorversion: "v3" + page-causewaynextmajorversion: "v4" page-causewaysnapshotversion: "3.0.0-SNAPSHOT" page-causewaypreviousversion: "3.2.0" page-causewayreleaseversion: "3.3.0" diff --git a/antora/playbooks/site.yml b/antora/playbooks/site.yml index d979435be6e..ca291a6cb41 100644 --- a/antora/playbooks/site.yml +++ b/antora/playbooks/site.yml @@ -302,6 +302,8 @@ asciidoc: kroki-default-options: interactive # only available for SVG kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) + page-causewaycurrmajorversion: "v3" + page-causewaynextmajorversion: "v4" page-causewaysnapshotversion: "3.0.0-SNAPSHOT" page-causewaypreviousversion: "3.1.0" page-causewayreleaseversion: "3.2.0"
