From 1e3b4cdc3422ff127e41e2540efaa58e6586976e Mon Sep 17 00:00:00 2001 From: Rob Winch Date: Wed, 9 Aug 2023 17:04:47 -0500 Subject: [PATCH 1/8] Fix site.url This was causing the .htaccess file to be generated incorrectly which prevented redirects from happening properly. Closes gh-31018 --- antora-playbook.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/antora-playbook.yml b/antora-playbook.yml index 967dc14b62..b1085551e3 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -8,7 +8,7 @@ antora: root_component_name: 'framework' site: title: Spring Framework - url: https://docs.spring.io/spring-security/reference + url: https://docs.spring.io/spring-framework/reference robots: allow git: ensure_git_suffix: false From 37717430825d00f49a3eea53845e45bb366d6f24 Mon Sep 17 00:00:00 2001 From: Rob Winch Date: Wed, 9 Aug 2023 17:06:36 -0500 Subject: [PATCH 2/8] Use a map for antora.options --- build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index 6982b477d4..76b04cd636 100644 --- a/build.gradle +++ b/build.gradle @@ -5,7 +5,7 @@ plugins { antora { version = '3.2.0-alpha.2' - options = ['--clean', '--fetch', '--stacktrace'] + options = [clean: true, fetch: true, stacktrace: true] environment = [ 'ALGOLIA_API_KEY': '042f6aaab6ce998d2ea29e60167e1660', 'ALGOLIA_APP_ID': 'WB1FQYI187', From 6455960cf19e92be9178f3de6542c3805323753f Mon Sep 17 00:00:00 2001 From: Rob Winch Date: Wed, 9 Aug 2023 17:06:53 -0500 Subject: [PATCH 3/8] Fix space to tabs --- build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index 76b04cd636..a588f02d51 100644 --- a/build.gradle +++ b/build.gradle @@ -4,7 +4,7 @@ plugins { } antora { - version = '3.2.0-alpha.2' + version = '3.2.0-alpha.2' options = [clean: true, fetch: true, stacktrace: true] environment = [ 'ALGOLIA_API_KEY': '042f6aaab6ce998d2ea29e60167e1660', From 6236ed56e49cc83c36fcea494ded491175a50f03 Mon Sep 17 00:00:00 2001 From: Rob Winch Date: Wed, 9 Aug 2023 17:07:06 -0500 Subject: [PATCH 4/8] Update to antora-extensions 1.4.2 --- build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index a588f02d51..2d6e30e77d 100644 --- a/build.gradle +++ b/build.gradle @@ -17,7 +17,7 @@ antora { '@antora/collector-extension': '1.0.0-alpha.3', '@asciidoctor/tabs': '1.0.0-beta.3', '@opendevise/antora-release-line-extension': '1.0.0', - '@springio/antora-extensions': '1.3.0', + '@springio/antora-extensions': '1.4.2', '@springio/asciidoctor-extensions': '1.0.0-alpha.9', ] } From 6c95ee2334bec64e5c8cb7ebc46dce83fb1cbeb1 Mon Sep 17 00:00:00 2001 From: Rob Winch Date: Wed, 9 Aug 2023 17:07:57 -0500 Subject: [PATCH 5/8] latest-version-extension before collector-extension This ensures that the versions that do not need to be built will be removed prior to running the collector on them and thus saving time. --- antora-playbook.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/antora-playbook.yml b/antora-playbook.yml index b1085551e3..063c5c48ea 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -1,9 +1,9 @@ antora: extensions: + - require: '@springio/antora-extensions/latest-version-extension' - '@antora/collector-extension' - '@antora/atlas-extension' - '@opendevise/antora-release-line-extension' - - '@springio/antora-extensions/latest-version-extension' - require: '@springio/antora-extensions/root-component-extension' root_component_name: 'framework' site: From a53a17c01a3f5cbe0ea8adb43e020206b102d3dd Mon Sep 17 00:00:00 2001 From: Rob Winch Date: Wed, 9 Aug 2023 17:08:29 -0500 Subject: [PATCH 6/8] Add the partial build extension Allows partial builds to occur from other branches. --- antora-playbook.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/antora-playbook.yml b/antora-playbook.yml index 063c5c48ea..b2db28f702 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -1,5 +1,6 @@ antora: extensions: + - '@springio/antora-extensions/partial-build-extension' - require: '@springio/antora-extensions/latest-version-extension' - '@antora/collector-extension' - '@antora/atlas-extension' From edc01f4957bb114bc660d215e9ac305a049640d3 Mon Sep 17 00:00:00 2001 From: Rob Winch Date: Wed, 9 Aug 2023 17:09:03 -0500 Subject: [PATCH 7/8] Add caching for the collector Cache the collector output for tags which speeds up builds with tags. - Add inject-collector-cache-config-extension - Update deployment to include the cache in the site - Update rsync-antora-referece to handle the cache properly --- .github/workflows/deploy-docs.yml | 4 +++- antora-playbook.yml | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index b63522ec5d..847a55c126 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -33,8 +33,10 @@ jobs: echo BUILD_VERSION=$(git cat-file --textconv FETCH_HEAD:gradle.properties | sed -n '/^version=/ { s/^version=//;p }') >> $GITHUB_ENV - name: Run Antora run: ./gradlew antora + - name: Copy the cache to be included in the site + run: cp -rf build/antora/inject-collector-cache-config-extension/.cache build/site/ - name: Publish Docs - uses: spring-io/spring-doc-actions/rsync-antora-reference@v0.0.8 + uses: spring-io/spring-doc-actions/rsync-antora-reference@v0.0.11 with: docs-username: ${{ secrets.DOCS_USERNAME }} docs-host: ${{ secrets.DOCS_HOST }} diff --git a/antora-playbook.yml b/antora-playbook.yml index b2db28f702..756f851a92 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -2,6 +2,7 @@ antora: extensions: - '@springio/antora-extensions/partial-build-extension' - require: '@springio/antora-extensions/latest-version-extension' + - require: '@springio/antora-extensions/inject-collector-cache-config-extension' - '@antora/collector-extension' - '@antora/atlas-extension' - '@opendevise/antora-release-line-extension' From e30e453bb4f12ddcc7b74f3bae4681adaa4f6d3e Mon Sep 17 00:00:00 2001 From: Rob Winch Date: Wed, 9 Aug 2023 17:11:59 -0500 Subject: [PATCH 8/8] Use bust-cloudflare-antora-cache@v0.0.11 Various bug fixes and features --- .github/workflows/deploy-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 847a55c126..556f2682b2 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -43,7 +43,7 @@ jobs: docs-ssh-key: ${{ secrets.DOCS_SSH_KEY }} docs-ssh-host-key: ${{ secrets.DOCS_SSH_HOST_KEY }} - name: Bust Clouflare Cache - uses: spring-io/spring-doc-actions/bust-cloudflare-antora-cache@v0.0.8 + uses: spring-io/spring-doc-actions/bust-cloudflare-antora-cache@v0.0.11 with: context-root: spring-framework cloudflare-zone-id: ${{ secrets.CLOUDFLARE_ZONE_ID }}