This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/causeway.git
The following commit(s) were added to refs/heads/main by this push:
new 0dfbd094c6f CAUSEWAY-2445: introduces a playbook for local verify only
(Antora)
0dfbd094c6f is described below
commit 0dfbd094c6f8debb092f20ce13a4293c795ced81
Author: Andi Huber <[email protected]>
AuthorDate: Mon Oct 13 18:08:38 2025 +0200
CAUSEWAY-2445: introduces a playbook for local verify only (Antora)
---
....yml~disabled.txt => ci-build-site-no-push.yml} | 4 +-
antora/playbooks/site-verify.yml | 306 +++++++++++++++++++++
2 files changed, 308 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/ci-build-site-no-push.yml~disabled.txt
b/.github/workflows/ci-build-site-no-push.yml
similarity index 96%
rename from .github/workflows/ci-build-site-no-push.yml~disabled.txt
rename to .github/workflows/ci-build-site-no-push.yml
index 5d77df2696e..7ed8c4b7b77 100644
--- a/.github/workflows/ci-build-site-no-push.yml~disabled.txt
+++ b/.github/workflows/ci-build-site-no-push.yml
@@ -67,7 +67,7 @@ jobs:
working-directory: ${{ env.PROJECT_ROOT_PATH }}
# we install the 'node' modules into the project root under
'node_modules',
# because we have no privileges to install them globally with -g option
- run: npm i @antora/cli@^3.1.10 @antora/site-generator-default@^3.1.10
asciidoctor-kroki
+ run: npm i @antora/cli@^3.1.14 @antora/site-generator-default@^3.1.14
asciidoctor-kroki
- name: List Versions of installed NPM Packages
shell: bash
@@ -88,7 +88,7 @@ jobs:
- name: Build Apache Causeway Site
shell: bash
working-directory: ${{ env.PROJECT_ROOT_PATH }}
- run: bash -x $CI_SCRIPTS_PATH/_build-site.sh
$ANTORA_PLAYBOOKS_PATH/site.yml
+ run: bash -x $CI_SCRIPTS_PATH/_build-site.sh
$ANTORA_PLAYBOOKS_PATH/site-verify.yml
env:
REVISION: ${{ steps.revision.outputs.revision }}
SKIP_PROJDOC_GENERATION: true
diff --git a/antora/playbooks/site-verify.yml b/antora/playbooks/site-verify.yml
new file mode 100644
index 00000000000..efc6d13eaa8
--- /dev/null
+++ b/antora/playbooks/site-verify.yml
@@ -0,0 +1,306 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+### used for CI builds, to verify we can build the site
+### particularly useful to verify pull-requests
+
+site:
+ title: causeway
+ url: https://causeway.apache.org/
+ start_page: docs:ROOT:about.adoc
+
+urls:
+ latest_version_segment: latest
+
+content:
+ sources:
+
+ # antora
+ - url: .
+ start_path: antora/components/docs # docs
+ branches: HEAD
+ - url: .
+ start_path: antora/components/comguide # comguide
+ branches: HEAD
+ - url: .
+ start_path: antora/components/conguide # conguide
+ branches: HEAD
+ - url: .
+ start_path: antora/components/relnotes # relnotes
+ branches: HEAD
+ - url: .
+ start_path: antora/components/setupguide # setupguide
+ branches: HEAD
+ - url: .
+ start_path: antora/components/refguide # refguide
+ branches: HEAD
+ - url: .
+ start_path: antora/components/refguide-index # refguide
+ branches: HEAD
+ - url: .
+ start_path: antora/components/userguide # userguide
+ branches: HEAD
+
+ # api
+ - url: .
+ start_path: api/schema/src/main/adoc # refguide
+ branches: HEAD
+
+ # core
+ - url: .
+ start_path: core/adoc # core (design docs)
+ branches: HEAD
+ - url: .
+ start_path: core/codegen-bytebuddy/src/main/adoc # core
+ branches: HEAD
+ - url: .
+ start_path: commons/src/main/adoc # core
+ branches: HEAD
+ - url: .
+ start_path: core/config/src/main/adoc # refguide
+ branches: HEAD
+ - url: .
+ start_path: core/interaction/src/main/adoc # core
+ branches: HEAD
+ - url: .
+ start_path: core/internaltestsupport/src/main/adoc # core
+ branches: HEAD
+ - url: .
+ start_path: core/metamodel/src/main/adoc # core
+ branches: HEAD
+ - url: .
+ start_path: core/runtime/src/main/adoc # core
+ branches: HEAD
+ - url: .
+ start_path: core/runtimeservices/src/main/adoc # core
+ branches: HEAD
+ - url: .
+ start_path: core/security/src/main/adoc # security
+ branches: HEAD
+ - url: .
+ start_path: core/transaction/src/main/adoc # core
+ branches: HEAD
+ - url: .
+ start_path: core/webapp/src/main/adoc # core
+ branches: HEAD
+
+ # examples
+ - url: .
+ start_path: antora/components/tutorials # tutorials
+ branches: HEAD
+
+ # extensions
+ - url: .
+ start_path: extensions/adoc # extensions
+ branches: HEAD
+
+ - url: .
+ start_path: extensions/core/commandlog/adoc # userguide
+ branches: HEAD
+ - url: .
+ start_path: extensions/core/docgen/adoc # userguide
+ branches: HEAD
+ - url: .
+ start_path: extensions/core/excel/adoc # userguide
+ branches: HEAD
+ - url: .
+ start_path: extensions/core/executionlog/adoc # userguide
+ branches: HEAD
+ - url: .
+ start_path: extensions/core/executionoutbox/adoc # userguide
+ branches: HEAD
+ - url: .
+ start_path: extensions/core/executionrepublisher/adoc # userguide
+ branches: HEAD
+ - url: .
+ start_path: extensions/core/flyway/adoc # userguide
+ branches: HEAD
+ - url: .
+ start_path: extensions/core/layoutloaders/adoc # userguide
+ branches: HEAD
+ - url: .
+ start_path: extensions/core/titlecache/adoc # userguide
+ branches: HEAD
+
+ - url: .
+ start_path: extensions/security/audittrail/adoc # security
+ branches: HEAD
+ - url: .
+ start_path: extensions/security/secman/adoc # security
+ branches: HEAD
+ - url: .
+ start_path: extensions/security/sessionlog/adoc # security
+ branches: HEAD
+ - url: .
+ start_path: extensions/security/spring-oauth2/src/main/adoc # security
+ branches: HEAD
+
+ - url: .
+ start_path: extensions/vro/cors/adoc # vro
+ branches: HEAD
+
+ - url: .
+ start_path: extensions/vw/tabular/adoc # vw
+ branches: HEAD
+ - url: .
+ start_path: extensions/vw/fullcalendar/adoc # vw
+ branches: HEAD
+ - url: .
+ start_path: extensions/vw/pdfjs/adoc # vw
+ branches: HEAD
+ - url: .
+ start_path: extensions/vw/sse/adoc # vw
+ branches: HEAD
+
+ # incubator
+ - url: .
+ start_path: incubator/adoc # incubator
+ branches: HEAD
+ # - url: .
+ # start_path: incubator/clients/kroviz/adoc # incubator
+ # branches: HEAD
+ # - url: .
+ # start_path: incubator/extensions/core/commandreplay/adoc # incubator
+ # branches: HEAD
+
+ # mavendeps
+ - url: .
+ start_path: mavendeps/adoc # starters
+ branches: HEAD
+
+ # persistence
+ - url: .
+ start_path: persistence/jpa/adoc
+ branches: HEAD
+ - url: .
+ start_path: persistence/querydsl/adoc
+ branches: HEAD
+
+ # regression tests
+ - url: .
+ start_path: regressiontests/adoc # regressiontests
+ branches: HEAD
+
+ # security
+ - url: .
+ start_path: security/adoc # security
+ branches: HEAD
+ - url: .
+ start_path: security/bypass/src/main/adoc # security
+ branches: HEAD
+ - url: .
+ start_path: security/simple/src/main/adoc # security
+ branches: HEAD
+ - url: .
+ start_path: security/keycloak/src/main/adoc # security
+ branches: HEAD
+ - url: .
+ start_path: security/spring/src/main/adoc # security
+ branches: HEAD
+
+ # starters
+ - url: .
+ start_path: starters/adoc # toc
+ branches: HEAD
+
+
+ # testing
+ - url: .
+ start_path: testing/adoc # testing
+ branches: HEAD
+ - url: .
+ start_path: testing/archtestsupport/adoc # testing
+ branches: HEAD
+ - url: .
+ start_path: testing/fakedata/adoc # testing
+ branches: HEAD
+ - url: .
+ start_path: testing/fixtures/adoc # testing
+ branches: HEAD
+ - url: .
+ start_path: testing/h2console/adoc # testing
+ branches: HEAD
+ - url: .
+ start_path: testing/hsqldbmgr/adoc # testing
+ branches: HEAD
+ - url: .
+ start_path: testing/integtestsupport/adoc # testing
+ branches: HEAD
+ - url: .
+ start_path: testing/specsupport/adoc # testing
+ branches: HEAD
+ - url: .
+ start_path: testing/unittestsupport/adoc # testing
+ branches: HEAD
+
+ # valuetypes
+ - url: .
+ start_path: valuetypes/adoc # valuetypes
+ branches: HEAD
+ - url: .
+ start_path: valuetypes/asciidoc/adoc # valuetypes
+ branches: HEAD
+ - url: .
+ start_path: valuetypes/markdown/adoc # valuetypes
+ branches: HEAD
+ - url: .
+ start_path: valuetypes/vega/adoc # valuetypes
+ branches: HEAD
+
+ # viewers
+ - url: .
+ start_path: viewers/graphql/adoc
+ branches: HEAD
+ - url: .
+ start_path: viewers/restfulobjects/adoc # vro
+ branches: HEAD
+ - url: .
+ start_path: viewers/wicket/adoc # vw
+ branches: HEAD
+
+
+ui:
+ bundle:
+ # url: ../../causeway-antora/build/ui-bundle.zip
+ url:
https://github.com/apache/causeway-antora/blob/master/build/ui-bundle.zip?raw=true
+ snapshot: true
+ supplemental_files: antora/supplemental-ui
+
+asciidoc:
+ # npm i @antora/cli@^3.1.1 @antora/site-generator-default@^3.1.1
asciidoctor-kroki
+ extensions:
+ - asciidoctor-kroki
+ - ./antora/lib/lorem
+ - ./antora/lib/jira-issue
+ attributes:
+ experimental: ""
+ idprefix: ""
+ idseparator: "-"
+ # kroki
+ # for more options see https://github.com/Mogztter/asciidoctor-kroki
+ kroki-default-format: svg # (default)
+ 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.5.0-SNAPSHOT"
+ page-causewayreleaseversion: "3.4.0"
+ page-causewayjdkversion: "17"
+
+output:
+ dir: antora/target/site
