diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 5e068c88..282c804e 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -32,6 +32,19 @@ jobs: echo BUILD_REFNAME=${{ github.event.inputs.build-refname }} >> $GITHUB_ENV 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 --stacktrace + 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 - run: $GITHUB_WORKSPACE/.github/actions/publish-docs.sh "${{ secrets.DOCS_USERNAME }}@${{ secrets.DOCS_HOST }}" /opt/www/domains/spring.io/docs/htdocs/spring-session/reference/ "${{ secrets.DOCS_SSH_KEY }}" "${{ secrets.DOCS_SSH_HOST_KEY }}" "${{ secrets.CLOUDFLARE_ZONE_ID }}" "${{ secrets.CLOUDFLARE_CACHE_TOKEN }}" + uses: spring-io/spring-doc-actions/rsync-antora-reference@v0.0.9 + 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.9 + with: + context-root: spring-session + cloudflare-zone-id: ${{ secrets.CLOUDFLARE_ZONE_ID }} + cloudflare-cache-token: ${{ secrets.CLOUDFLARE_CACHE_TOKEN }} diff --git a/antora-playbook.yml b/antora-playbook.yml index 7dbfd213..9567d6ce 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -1,10 +1,16 @@ antora: extensions: - '@springio/antora-extensions/partial-build-extension' + # Run before latest-version-extension + - ./lib/antora/extensions/fix-component-name-display.js + # Run before collector so that it doesn't operate on too many tags - require: '@springio/antora-extensions/latest-version-extension' - ./lib/antora/extensions/inject-collector-config.js + - require: '@springio/antora-extensions/inject-collector-cache-config-extension' - '@antora/collector-extension' - ./lib/antora/extensions/version-fix.js + # Operate again after the collector to override the incorrect values from the collector + - ./lib/antora/extensions/fix-component-name-display.js - '@antora/atlas-extension' - '@opendevise/antora-release-line-extension' - require: '@springio/antora-extensions/tabs-migration-extension' @@ -24,7 +30,7 @@ git: content: sources: - url: https://github.com/spring-projects/spring-session - branches: [main, '*.x', '!(1.*.x)', '!(2.{0..5}.x)'] + branches: [main, '{0..9}+.{0..9}+.x', '!(1.*.x)', '!(2.{0..5}.x)'] tags: ['2.{6..9}.*', '3.+({0..9}).+({0..9})?(-{RC,M}*)?', '!2.6.0-M*','!2.6.0-RC*','!2.7.0-M1','!3.0.0-M1'] start_path: spring-session-docs asciidoc: diff --git a/build.gradle b/build.gradle index 91058b3f..82798d5f 100644 --- a/build.gradle +++ b/build.gradle @@ -7,9 +7,9 @@ antora { version = '3.2.0-alpha.2' options = [clean: true, fetch: true, stacktrace: true] environment = [ - 'ALGOLIA_API_KEY': '82c7ead946afbac3cf98c32446154691', - 'ALGOLIA_APP_ID': '244V8V9FGG', - 'ALGOLIA_INDEX_NAME': 'session-docs' + 'ALGOLIA_API_KEY': '9d489079e5ec46dbb238909fee5c9c29', + 'ALGOLIA_APP_ID': 'WB1FQYI187', + 'ALGOLIA_INDEX_NAME': 'springsession' ] dependencies = [ '@antora/atlas-extension': '1.0.0-alpha.1', diff --git a/lib/antora/extensions/fix-component-name-display.js b/lib/antora/extensions/fix-component-name-display.js new file mode 100644 index 00000000..bd926cd6 --- /dev/null +++ b/lib/antora/extensions/fix-component-name-display.js @@ -0,0 +1,9 @@ +'use strict' + +module.exports.register = function () { + this.once('contentAggregated', ({ contentAggregate }) => { + contentAggregate.forEach((componentVersionBucket) => { + Object.assign(componentVersionBucket, { name: 'session', display: 'Spring Session', title: 'Spring Session' }) + }) + }) +} diff --git a/lib/antora/extensions/inject-collector-config.js b/lib/antora/extensions/inject-collector-config.js index 0a7f8167..8efef7cc 100644 --- a/lib/antora/extensions/inject-collector-config.js +++ b/lib/antora/extensions/inject-collector-config.js @@ -9,7 +9,8 @@ const TASK_NAME=':spring-session-docs:generateAntora' * Set of tags that contain a collector config, but the antora command fails on GitHub Actions. */ const VERSIONS_TO_OVERRIDE = [ - '6.0.0-RC1' + '2.6.3', + '2.7.2', ] /** diff --git a/lib/antora/extensions/version-fix.js b/lib/antora/extensions/version-fix.js index 21938c05..f189d7ca 100644 --- a/lib/antora/extensions/version-fix.js +++ b/lib/antora/extensions/version-fix.js @@ -8,6 +8,9 @@ module.exports.register = function () { componentVersionBucket.version += componentVersionBucket.prerelease componentVersionBucket.prerelease = true } + if (componentVersionBucket.version === '2.7.2') { + delete componentVersionBucket.prerelease + } }) }) }