This is an automated email from the ASF dual-hosted git repository. danhaywood pushed a commit to branch ISIS-3267 in repository https://gitbox.apache.org/repos/asf/isis.git
commit b36fd1e27a777a07fec4cc537df0f1197cd3d47a Author: Dan Haywood <[email protected]> AuthorDate: Fri Nov 4 10:00:24 2022 +0000 ISIS-3255: improves some docs --- .../modules/ROOT/pages/cutting-a-release.adoc | 18 ++++------------ .../ROOT/pages/post-release-successful.adoc | 3 ++- .../modules/ROOT/pages/updating-the-website.adoc | 25 +++------------------- preview.sh | 2 +- 4 files changed, 10 insertions(+), 38 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 ac27ac2108..36c64a487a 100644 --- a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc +++ b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc @@ -157,18 +157,7 @@ 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. -* Be careful that sometimes the configuration property pages (that are generated from the `core/config/target/classes/META-INF/spring-configuration-metadata.json` file) may be malformed; in particular for default values going missing. -+ -This seems to occur if the IDE (IntelliJ) has compiled the codebase. -+ -The workaround is to rebuild the `core/config` Maven module using `mvn` command line first. -+ -[source,bash,subs="attributes+"] ----- -mvn clean install -pl core/config -DskipTests ----- - -* It's also necessary to make sure the tooling is built: +* Make sure the tooling is built: + [source,bash,subs="attributes+"] ---- @@ -181,6 +170,8 @@ mvn -D module-tooling -D skip.essential install -DskipTests ---- sh preview.sh ---- ++ +NOTE: this now runs `mvn clean install -pl core/config` automatically. Check for any Asciidoc errors, and fix. Also double-check that the config property files are correctly formatted. @@ -791,7 +782,7 @@ popd ---- cd ../causeway-release -sh preview.sh -A +sh preview.sh -AB ---- + [WARNING] @@ -807,7 +798,6 @@ git checkout $CAUSEWAYBRANCH pushd bom mvn clean install -DskipTests -T1C -Dgithub popd -mvn clean install -pl core/config mvn -D module-tooling -D skip.essential install -DskipTests ---- 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 7851b00aa2..72f0afe50a 100644 --- a/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc +++ b/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc @@ -377,7 +377,6 @@ git checkout $CAUSEWAYBRANCH pushd bom mvn clean install -DskipTests -Dreleased popd -mvn clean install -pl core/config mvn -D module-tooling -D skip.essential install -DskipTests ---- @@ -388,6 +387,8 @@ mvn -D module-tooling -D skip.essential install -DskipTests sh preview.sh ---- + +NOTE: this now runs `mvn clean install -pl core/config` automatically. ++ This will write to `antora/target/site`; we'll use the results in the xref:#publish-website[next section]. Finally, revert the last commit (backing out changes to `site.yml`): diff --git a/antora/components/comguide/modules/ROOT/pages/updating-the-website.adoc b/antora/components/comguide/modules/ROOT/pages/updating-the-website.adoc index dc04bfd6fb..cdcd4e2f20 100644 --- a/antora/components/comguide/modules/ROOT/pages/updating-the-website.adoc +++ b/antora/components/comguide/modules/ROOT/pages/updating-the-website.adoc @@ -28,25 +28,6 @@ git checkout {page-causewayrel} * make documentation updates, and commit changes -* make sure config properties are up-to-date: -+ -This is most easily done by rebuilding all: -+ -[source,bash,subs="attributes+"] ----- -pushd bom -mvn clean install -DskipTests -Dreleased -popd ----- -+ -Though it might be sufficient to just build the core/config module -+ -[source,bash,subs="attributes+"] ----- -mvn clean install -pl core/config ----- - - * make sure the tooling is also built: + [source,bash,subs="attributes+"] @@ -61,9 +42,9 @@ mvn -D module-tooling -D skip.essential install -DskipTests sh preview.sh ---- + -This will write to `antora/target/site`; we'll use the results in the xref:#publish-website[next section]. -+ -NOTE: this requires Java 11 for the projdoc tooling. +NOTE: this now runs `mvn clean install -pl core/config` automatically (unless suppressed with a flag) + +This updated website is written to `antora/target/site`; we'll use the results in the xref:#publish-website[next section]. diff --git a/preview.sh b/preview.sh index f519e9e6b3..c55adcd127 100644 --- a/preview.sh +++ b/preview.sh @@ -175,7 +175,7 @@ fi if [[ "$BUILD_CONFIGS" == "skip" ]]; then echo "skipping mvn -pl core/config" else - mvn clean install -pl core/config + mvn clean install -pl core/config -DskipTests fi if [[ "$CLEAR_CACHE" == "skip" ]]; then
