This is an automated email from the ASF dual-hosted git repository. danhaywood pushed a commit to branch 4.0.0-M1 in repository https://gitbox.apache.org/repos/asf/causeway.git
commit f9ea314016eda32a99ae4fb4eee4d757329039a7 Author: Dan Haywood <[email protected]> AuthorDate: Sun Oct 19 23:49:11 2025 +0100 updates release procedure docs --- .../ROOT/pages/post-release-successful.adoc | 25 ++++++++-------------- .../modules/ROOT/pages/verifying-releases.adoc | 18 ---------------- .../docs/modules/referenceapp/pages/about.adoc | 5 +---- 3 files changed, 10 insertions(+), 38 deletions(-) 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 9f9d016e11d..9fadacca09b 100644 --- a/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc +++ b/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc @@ -569,31 +569,24 @@ 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 (!) -four -branches: +As explained in xref:cutting-a-release.adoc#update-starter-apps[cutting a release],for each of the two starter apps, we maintain two branches: -// * `{page-causewaycurrmajorversion}-jpa`; `{page-causewaycurrmajorversion}-jdo`; `{page-causewaynextmajorversion}-jpa`; `{page-causewaynextmajorversion}-jdo` -* `{page-causewaycurrmajorversion}-jpa`; `{page-causewaycurrmajorversion}-jdo` +* `{page-causewaycurrmajorversion}-jpa` + -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. +This branch is intended to reference the _most recently released_ version, and is referenced from the home page and getting started pages of the website. -// * `{page-causewaycurrmajorversion}-jpa-SNAPSHOT`; `{page-causewaycurrmajorversion}-jdo-SNAPSHOT`; `{page-causewaynextmajorversion}-jpa-SNAPSHOT`; `{page-causewaynextmajorversion}-jdo-SNAPSHOT` -* `{page-causewaycurrmajorversion}-jpa-SNAPSHOT`; `{page-causewaycurrmajorversion}-jdo-SNAPSHOT` +* `{page-causewaycurrmajorversion}-jpa-SNAPSHOT` + -These reference the most current snapshot nightly build. +This branch is intended to reference the most current snapshot nightly build. -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 general idea is that a release will fast-forward `vN-jpa` to `vN-jpa-SNAPSHOT`, bumping to the newly released version of the framework in the process. 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`. +In order that we don't break the starter apps while a release is being voted on, we do the changes in a work branch, `$CAUSEWAYBRANCH-jpa`. Now that the release is complete, tidy up these branches and then set up the `-SNAPSHOT` branches as required. -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. +IMPORTANT: The `vN-jpa` branch should always work against the most recent release, whereas the `vN-jpa-SNAPSHOT` reference more recent nightly builds if necessary. == Update the petclinic app @@ -630,7 +623,7 @@ git reset --hard v3 PREV_VERSION=... # <.> ./tagger.sh -p $PREV_VERSION -v {page-causewayreleaseversion} ---- -<.> adjust as necessary; should be the immediately previous version, eg `3.3.0` precedes `3.4.0`. +<.> adjust as necessary; should be the immediately previous version. * confirm that the last tag builds and runs ok. + diff --git a/antora/components/comguide/modules/ROOT/pages/verifying-releases.adoc b/antora/components/comguide/modules/ROOT/pages/verifying-releases.adoc index 4486016164e..cc18da38c2e 100644 --- a/antora/components/comguide/modules/ROOT/pages/verifying-releases.adoc +++ b/antora/components/comguide/modules/ROOT/pages/verifying-releases.adoc @@ -67,15 +67,6 @@ in other words, to confirm that the release was created by an Apache Causeway co Assuming this completes successfully, you can then test the starter applications: -* Test out helloworld (jdo) using: -+ -[source,bash] ----- -pushd causeway-app-helloworld-jdo -mvn spring-boot:run -popd ----- - * Test out helloworld (jpa) using: + [source,bash] @@ -85,15 +76,6 @@ mvn spring-boot:run popd ---- -* Test out simpleapp (jdo) using: -+ -[source,bash] ----- -pushd causeway-app-simpleapp-jdo -mvn -pl webapp spring-boot:run -popd ----- - * Test out simpleapp (jpa) using: + [source,bash] diff --git a/antora/components/docs/modules/referenceapp/pages/about.adoc b/antora/components/docs/modules/referenceapp/pages/about.adoc index ce0fa962c04..e4b1de339a7 100644 --- a/antora/components/docs/modules/referenceapp/pages/about.adoc +++ b/antora/components/docs/modules/referenceapp/pages/about.adoc @@ -8,7 +8,7 @@ It's also a useful reference to help you develop your own Apache Causeway applic image::teaser-light.png[] -The application is packaged up as a Docker image (link:https://hub.docker.com/r/apache/causeway-app-demo-jpa[apache/causeway-app-demo-jpa] or link:https://hub.docker.com/r/apache/causeway-app-demo-jdo[apache/causeway-app-demo-jdo]) on Docker Hub, so you can easily run it yourself (as described <<Running the Docker Image,below>>). +The application is packaged up as a Docker image (link:https://hub.docker.com/r/apache/causeway-app-demo-jpa[apache/causeway-app-demo-jpa]) on Docker Hub, so you can easily run it yourself (as described <<Running the Docker Image,below>>). == Prereqs @@ -18,8 +18,6 @@ Head over to https://www.docker.com/community-edition[Docker] to install the com == Running the Docker Image -Assuming the `jpa` variant (if using `jdo`, just substitute "jpa" with "jdo" in the commands below): - * Pull and run the Docker Image + [source,bash] @@ -41,7 +39,6 @@ docker stop demo && docker rm demo === Customization The way in which the app is run by Docker be customised in a couple of ways. -Assuming the `jpa` variant (if using `jdo`, just substitute "jpa" with "jdo" in the commands below): * Prototyping mode +
