This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch release-4.0.0-M1-RC1
in repository https://gitbox.apache.org/repos/asf/causeway.git
The following commit(s) were added to refs/heads/release-4.0.0-M1-RC1 by this
push:
new 946f3108028 CAUSEWAY-3898: updates release procedure docs
946f3108028 is described below
commit 946f31080288ae456ef6665e37f961a25a89e141
Author: Dan Haywood <[email protected]>
AuthorDate: Wed Oct 8 17:57:56 2025 +0100
CAUSEWAY-3898: updates release procedure docs
---
.../modules/ROOT/pages/cutting-a-release.adoc | 149 +++------------------
1 file changed, 19 insertions(+), 130 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 3b1847c7c42..35e3784c80e 100644
--- a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
+++ b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
@@ -550,7 +550,7 @@ and also push tag:
[source,bash,subs="attributes+"]
----
-git push origin
refs/tags/causeway-$CAUSEWAYREL:refs/tags/causeway-$CAUSEWAYREL-$CAUSEWAYRC
+git push origin
refs/tags/causeway-${CAUSEWAYREL}:refs/tags/causeway-${CAUSEWAYREL}-${CAUSEWAYRC}
git fetch
----
@@ -562,33 +562,25 @@ 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 four branches:
+For each of the two starter apps, we maintain two branches:
-// * `{page-causewaycurrmajorversion}-jpa` and
`{page-causewaycurrmajorversion}-jdo` ; and also
`{page-causewaynextmajorversion}-jpa` and `{page-causewaynextmajorversion}-jdo`
-* `{page-causewaycurrmajorversion}-jpa` and
`{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.
+Is are intended to reference the _most recently released_ version
(demonstrating persistence using EclipseLink JPA).
+This branch is referenced from the home page and getting started pages of the
website.
-// * `{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`
+* `{page-causewaycurrmajorversion}-jpa-SNAPSHOT`
+
-These reference the most current snapshot nightly build.
+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 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`.
=== HelloWorld
For _helloworld_, we create a release branch for both variants:
-* for `jpa`:
-+
-** Checkout the branch, bump versions, and commit:
+* Checkout the branch, bump versions, and commit:
+
[source,bash,subs="attributes+"]
----
@@ -602,10 +594,10 @@ find . -name pom.xml -exec sed -i ''
"s/<version>${CAUSEWAYREL}-SNAPSHOT<\/versi
git add .
git commit -m "$CAUSEWAYJIRA - updates to $CAUSEWAYREL (jpa)"
----
-
++
The parent `pom.xml` references the ASF staging repository, so this will pull
down the release if not already present in `~/.m2/repository`.
-** Test the app
+* Test the app
+
[source,bash,subs="attributes+"]
----
@@ -613,73 +605,21 @@ mvnd clean install
mvnd spring-boot:run
----
-** Make any additional changes that might be required (eg update to
`menubars.layout.xml`) commit and retest
+* Make any additional changes that might be required (eg update to
`menubars.layout.xml`) commit and retest
-** Push the branch to origin:
+* Push the branch to origin:
+
[source,bash,subs="attributes+"]
----
git push -u origin $CAUSEWAYBRANCH-jpa
----
-* for `jdo`:
-+
-** Checkout the branch, bump versions, and commit:
-+
-[source,bash,subs="attributes+"]
-----
-git checkout {page-causewaycurrmajorversion}-jdo-SNAPSHOT
-git pull --ff-only
-
-git checkout -b $CAUSEWAYBRANCH-jdo
-
-find . -name pom.xml -exec sed -i ''
"s/<version>${CAUSEWAYREL}-SNAPSHOT<\/version>/<version>${CAUSEWAYREL}<\/version>/g"
{} +
-
-git add .
-git commit -m "$CAUSEWAYJIRA - updates to $CAUSEWAYREL (jdo)"
-----
-
-** Test the app
-+
-[source,bash,subs="attributes+"]
-----
-mvnd clean install
-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
`{page-causewaycurrmajorversion}-jpa` branch.
-
-** Merge in the `{page-causewaycurrmajorversion}-jpa` branch, discarding any
conflicts.
-+
-[source,bash,subs="attributes+"]
-----
-git merge $CAUSEWAYBRANCH-jpa --no-commit
-----
-+
-The idea here is to show equivalence between the two branches.
-The merge commit should end up with no changes:
-+
-[source,bash,subs="attributes+"]
-----
-git commit -m "$CAUSEWAYJIRA - merge in jpa"
-----
-
-** Push the branch to origin:
-+
-[source,bash,subs="attributes+"]
-----
-git push -u origin $CAUSEWAYBRANCH-jdo
-----
=== SimpleApp
For _simple app_, the steps are almost the same:
-* for `jpa`:
-
-** Checkout the branch, bump versions, and commit:
+* Checkout the branch, bump versions, and commit:
+
[source,bash,subs="attributes+"]
----
@@ -693,44 +633,10 @@ find . -name pom.xml -exec sed -i ''
"s/<version>${CAUSEWAYREL}-SNAPSHOT<\/versi
git add .
git commit -m "$CAUSEWAYJIRA - updates to $CAUSEWAYREL (jpa)"
----
-<.> the top-level `pom.xml` references the ASF staging repository, so this
will pull down the release if not already present in `~/.m2/repository`.
-
-** Test the app
-+
-[source,bash,subs="attributes+"]
-----
-mvnd clean install
-mvnd -pl webapp spring-boot:run
-----
-
-** Make any additional changes that might be required (eg update to
`menubars.layout.xml`) commit and retest
-
-** Push the branch to origin:
-+
-[source,bash,subs="attributes+"]
-----
-git push -u origin $CAUSEWAYBRANCH-jpa
-----
-
-
-* for `jdo`:
-+
-** Checkout the branch, bump versions, and commit:
+
-[source,bash,subs="attributes+"]
-----
-git checkout {page-causewaycurrmajorversion}-jdo-SNAPSHOT
-git pull --ff-only
-
-git checkout -b $CAUSEWAYBRANCH-jdo
-
-find . -name pom.xml -exec sed -i ''
"s/<version>${CAUSEWAYREL}-SNAPSHOT<\/version>/<version>${CAUSEWAYREL}<\/version>/g"
{} +
-
-git add .
-git commit -m "$CAUSEWAYJIRA - updates to $CAUSEWAYREL (jdo)"
-----
+The parent `pom.xml` references the ASF staging repository, so this will pull
down the release if not already present in `~/.m2/repository`.
-** Test the app
+* Test the app
+
[source,bash,subs="attributes+"]
----
@@ -738,30 +644,13 @@ mvnd clean install
mvnd -pl webapp 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 `jpa` branch.
+* Make any additional changes that might be required (eg update to
`menubars.layout.xml`) commit and retest
-** Merge in the `jpa` branch, discarding any conflicts.
+* Push the branch to origin:
+
[source,bash,subs="attributes+"]
----
-git merge $CAUSEWAYBRANCH-jpa --no-commit
-----
-+
-The idea here is to show equivalence between the two branches.
-The merge commit should end up with no changes:
-+
-[source,bash,subs="attributes+"]
-----
-git commit -m "$CAUSEWAYJIRA - merge in jpa"
-----
-
-** Push the branch to origin:
-+
-[source,bash,subs="attributes+"]
-----
-git push -u origin $CAUSEWAYBRANCH-jdo
+git push -u origin $CAUSEWAYBRANCH-jpa
----
