Browse Source

Update Antora configuration and dependencies

pull/1739/head
Joe Grandja 2 years ago
parent
commit
0edcb753c2
  1. 8
      .github/workflows/deploy-docs.yml
  2. 10
      antora-playbook.yml
  3. 14
      build.gradle
  4. 2
      lib/antora/templates/per-branch-antora-playbook.yml
  5. 10
      package.json

8
.github/workflows/deploy-docs.yml

@ -4,7 +4,7 @@ on: @@ -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: @@ -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: @@ -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 }}

10
antora-playbook.yml

@ -1,13 +1,7 @@ @@ -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: @@ -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:

14
build.gradle

@ -4,19 +4,5 @@ plugins { @@ -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',
]
}

2
lib/antora/templates/per-branch-antora-playbook.yml

@ -1,5 +1,3 @@ @@ -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:

10
package.json

@ -0,0 +1,10 @@ @@ -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"
}
}
Loading…
Cancel
Save