This is an automated email from the ASF dual-hosted git repository. danhaywood pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/causeway.git
commit 96644bad71268d05cb1150d3b5499f67c6ab3a96 Author: danhaywood <[email protected]> AuthorDate: Mon Mar 25 09:04:55 2024 +0000 CAUSEWAY-3666: doc fixes --- .../modules/ROOT/pages/cutting-a-release.adoc | 17 ++++++++--------- .../modules/ROOT/pages/post-release-successful.adoc | 19 +++++++++++-------- bom/pom.xml | 1 + 3 files changed, 20 insertions(+), 17 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 b4508f9da4..219e21c432 100644 --- a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc +++ b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc @@ -26,7 +26,7 @@ They should work on Linux and MacOS; for Windows, use mSysGit. [IMPORTANT] ==== -The release process should be performed on Java 11. +The release process should be performed on Java 17. ==== [IMPORTANT] @@ -57,6 +57,9 @@ git checkout master git pull --ff-only ---- +NOTE: if multiple branches are being supported, then repeat the process on other branches independently. +Each branch's release should be a separate vote. +However, the website should be generated referencing all appropriate releases. === License headers @@ -157,8 +160,6 @@ Locate this property in `bom/pom.xml` and update to the current date/time. The next step is to generate the website, ensuring that the config, examples, projdoc (system overview and global index) are all updated. -* Switch to Java 17 - * Make sure the tooling is built: + [source,bash,subs="attributes+"] @@ -175,8 +176,6 @@ sh preview.sh + NOTE: this now runs `mvnd clean install -pl core/config` automatically. -* Switch to Java 11 afterwards - Check for any Asciidoc errors, and fix. Also double-check that the config property files are correctly formatted. @@ -577,7 +576,7 @@ git pull --ff-only git checkout -b $CAUSEWAYBRANCH-jpa -mvnd versions:update-parent -DparentVersion=$CAUSEWAYREL -Dskip.nightly # <.> +mvnd versions:update-parent -DparentVersion=[$CAUSEWAYREL,$CAUSEWAYREL] -Dskip.nightly # <.> mvnd versions:set -DnewVersion=$CAUSEWAYREL git add . @@ -614,7 +613,7 @@ git pull --ff-only git checkout -b $CAUSEWAYBRANCH-jdo -mvnd versions:update-parent -DparentVersion=$CAUSEWAYREL -Dskip.nightly +mvnd versions:update-parent -DparentVersion=[$CAUSEWAYREL,$CAUSEWAYREL] -Dskip.nightly mvnd versions:set -DnewVersion=$CAUSEWAYREL git add . @@ -670,7 +669,7 @@ git pull --ff-only git checkout -b $CAUSEWAYBRANCH-jpa -mvnd versions:update-parent -DparentVersion=$CAUSEWAYREL -Dskip.nightly # <.> +mvnd versions:update-parent -DparentVersion=[$CAUSEWAYREL,$CAUSEWAYREL] -Dskip.nightly # <.> mvnd versions:set -DnewVersion=$CAUSEWAYREL git add . @@ -707,7 +706,7 @@ git pull --ff-only git checkout -b $CAUSEWAYBRANCH-jdo -mvnd versions:update-parent -DparentVersion=$CAUSEWAYREL -Dskip.nightly +mvnd versions:update-parent -DparentVersion=[$CAUSEWAYREL,$CAUSEWAYREL] -Dskip.nightly mvnd versions:set -DnewVersion=$CAUSEWAYREL git add . 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 8454fe4187..f5f43f9eb5 100644 --- a/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc +++ b/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc @@ -309,13 +309,16 @@ This has two benefits: first, the top-level `index.html` (in `supplemental-ui`) [#create-doc-branch] === Create doc branch +NOTE: At the time of writing we support two branches, `v2` and `v3`. +Adjust these instructions if necessary. + First, we update all versions in `antora.yml`: -* Update all `antora.yml` files: +* Update all `antora.yml` files to use the latest branch ({page-causewayrelv3}): + [source,bash,subs="attributes+"] ---- -find . -name antora.yml -exec sed -i 's/latest/{page-causewayrel}/g' {} \; +find . -name antora.yml -exec sed -i 's/latest/{page-causewayrelv3}/g' {} \; ---- * Commit all these changes: @@ -326,16 +329,16 @@ git add . git commit -m "$CAUSEWAYJIRA: bumps antora.yml versions to $CAUSEWAYREL" ---- -We now create a branch to reference in the `site.yml`, later on. +We now create a branch which can be referenced in the `site.yml`, later on. -* We create the `{page-causewayrel}` branch. +* We create the `{page-causewayrelv3}` branch. + -This mirrors the "rel/causeway-{page-causewayrel}" used for the formal (immutable) release tag, but is a branch because it allows us to move it, and must have this simplified name as it is used in the "edit page" link of the site template. +This mirrors the "rel/causeway-{page-causewayrelv3}" used for the formal (immutable) release tag, but is a branch because it allows us to move it, and must have this simplified name as it is used in the "edit page" link of the site template. + [source,bash,subs="attributes+"] ---- -git branch {page-causewayrel} -git push origin {page-causewayrel} +git branch {page-causewayrelv3} +git push origin {page-causewayrelv3} ---- Now we make sure that the docs in the new doc branch are actually up-to-date. @@ -345,7 +348,7 @@ Now we make sure that the docs in the new doc branch are actually up-to-date. + [source,bash,subs="attributes+"] ---- -git checkout {page-causewayrel} +git checkout {page-causewayrelv3} ---- * build framework diff --git a/bom/pom.xml b/bom/pom.xml index 9e9d20ab5c..57d668ba81 100644 --- a/bom/pom.xml +++ b/bom/pom.xml @@ -2539,6 +2539,7 @@ It is therefore a copy of org.apache:apache, with customisations clearly identif <exclude>**/test.data</exclude> <exclude>**/fixture-data/**</exclude> <exclude>**/*.approved.*</exclude> + <exclude>**/*.approved.xml</exclude> <exclude>**/approved/*.adoc</exclude> <exclude>**/secman-permissions.yml</exclude>
