From 0edcb753c2edb62adc30f4cb81d4ea9d04f2ff06 Mon Sep 17 00:00:00 2001 From: Joe Grandja <10884212+jgrandja@users.noreply.github.com> Date: Fri, 21 Jun 2024 10:51:31 -0400 Subject: [PATCH] Update Antora configuration and dependencies --- .github/workflows/deploy-docs.yml | 8 ++++---- antora-playbook.yml | 10 ++-------- build.gradle | 14 -------------- .../templates/per-branch-antora-playbook.yml | 2 -- package.json | 10 ++++++++++ 5 files changed, 16 insertions(+), 28 deletions(-) create mode 100644 package.json diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 526251ee..4b23faf9 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -4,7 +4,7 @@ on: workflow_dispatch: inputs: build-refname: - description: Enter git refname to build (e.g., 5.7.x). + description: Enter git refname to build (e.g., 1.2.x). required: false push: branches: docs-build @@ -18,7 +18,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 5 - name: Set Up Gradle @@ -37,14 +37,14 @@ jobs: - 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.15 + uses: spring-io/spring-doc-actions/rsync-antora-reference@v0.0.17 with: docs-username: ${{ secrets.DOCS_USERNAME }} docs-host: ${{ secrets.DOCS_HOST }} 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.15 + uses: spring-io/spring-doc-actions/bust-cloudflare-antora-cache@v0.0.17 with: context-root: spring-authorization-server cloudflare-zone-id: ${{ secrets.CLOUDFLARE_ZONE_ID }} diff --git a/antora-playbook.yml b/antora-playbook.yml index 75d4b7cb..80800d64 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -1,13 +1,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' - - require: '@springio/antora-extensions/root-component-extension' + - require: '@springio/antora-extensions' root_component_name: 'authorization-server' - - '@springio/antora-extensions/static-page-extension' site: title: Spring Authorization Server url: https://docs.spring.io/spring-authorization-server/reference @@ -37,7 +31,7 @@ urls: redirect_facility: httpd ui: bundle: - url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.3/ui-bundle.zip + url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.16/ui-bundle.zip snapshot: true runtime: log: diff --git a/build.gradle b/build.gradle index 255445f9..e7d2bc51 100644 --- a/build.gradle +++ b/build.gradle @@ -4,19 +4,5 @@ plugins { } antora { - version = '3.2.0-alpha.2' options = [clean: true, fetch: true, stacktrace: true] - environment = [ - 'ALGOLIA_API_KEY': '9d489079e5ec46dbb238909fee5c9c29', - 'ALGOLIA_APP_ID': 'WB1FQYI187', - 'ALGOLIA_INDEX_NAME': 'springdocs', - ] - // NOTE remember to update the versions in lib/antora/templates/per-branch-antora-playbook.yml as well - dependencies = [ - '@antora/atlas-extension': '1.0.0-alpha.1', - '@antora/collector-extension': '1.0.0-alpha.3', - '@asciidoctor/tabs': '1.0.0-beta.3', - '@springio/antora-extensions': '1.7.0', - '@springio/asciidoctor-extensions': '1.0.0-alpha.8', - ] } diff --git a/lib/antora/templates/per-branch-antora-playbook.yml b/lib/antora/templates/per-branch-antora-playbook.yml index 1b527286..a4a8b96e 100644 --- a/lib/antora/templates/per-branch-antora-playbook.yml +++ b/lib/antora/templates/per-branch-antora-playbook.yml @@ -1,5 +1,3 @@ -# PACKAGES antora@3.2.0-alpha.2 @antora/atlas-extension@1.0.0-alpha.1 @antora/collector-extension@1.0.0-alpha.3 @asciidoctor/tabs@1.0.0-beta.3 @springio/antora-extensions@1.4.2 @springio/asciidoctor-extensions@1.0.0-alpha.8 -# # The purpose of this Antora playbook is to build the docs in the current branch. antora: extensions: diff --git a/package.json b/package.json new file mode 100644 index 00000000..3b82cf90 --- /dev/null +++ b/package.json @@ -0,0 +1,10 @@ +{ + "dependencies": { + "antora": "3.2.0-alpha.4", + "@antora/atlas-extension": "1.0.0-alpha.2", + "@antora/collector-extension": "1.0.0-alpha.4", + "@asciidoctor/tabs": "1.0.0-beta.6", + "@springio/antora-extensions": "1.11.1", + "@springio/asciidoctor-extensions": "1.0.0-alpha.10" + } +} \ No newline at end of file