Add build infrastructure for Antora site.

See #810

Author: mp911de

.github/workflows/docs-build.yml

@@ -0,0 +1,61 @@
+name: Antora Site
+run-name: ${{ format('{0} ({1})', github.workflow, github.event.inputs.build-refname || 'all') }}
+on:
+  workflow_dispatch:
+    inputs:
+      build-refname:
+        description: Enter git refname to build (e.g., 5.7.x).
+        required: false
+permissions:
+  contents: write
+jobs:
+  build:
+    if: github.repository_owner == 'spring-projects'
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 5
+    - name: Set up JDK 17
+      uses: actions/setup-java@v3
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+    - name: Setup Maven Action
+      uses: s4u/[email protected]
+      with:
+        java-version: 17
+    - name: Set up refname build
+      if: github.event.inputs.build-refname
+      run: |
+        git fetch --depth 1 https://github.com/$GITHUB_REPOSITORY ${{ github.event.inputs.build-refname }}
+        export BUILD_REFNAME=${{ github.event.inputs.build-refname }}
+        echo "BUILD_REFNAME=$BUILD_REFNAME" >> $GITHUB_ENV
+        export BUILD_VERSION=$(git cat-file --textconv FETCH_HEAD:pom.xml | python3 -c "import xml.etree.ElementTree as xml; from sys import stdin; print(xml.parse(stdin).getroot().find('{http://maven.apache.org/POM/4.0.0}version').text)")
+        echo BUILD_VERSION=$BUILD_VERSION >> $GITHUB_ENV
+    - name: Cache nodejs
+      uses: actions/cache@v3
+      with:
+        path: |
+          node
+          node_modules
+          package.json
+          package-lock.json
+        key: ${{ runner.os }}-nodejs-${{ hashFiles('pom.xml') }}
+    - name: Run Antora
+      run: ./mvnw -B antora -Dantora.playbook=playbooks/${{ github.event.inputs.module }}.yml
+    - name: Publish Docs
+      uses: spring-io/spring-doc-actions/[email protected]
+      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 }}
+        site-path: target/antora/site
+    - name: Bust Cloudflare Cache
+      uses: spring-io/spring-doc-actions/[email protected]
+      with:
+        context-root: spring-vault
+        cloudflare-zone-id: ${{ secrets.CLOUDFLARE_ZONE_ID }}
+        cloudflare-cache-token: ${{ secrets.CLOUDFLARE_CACHE_TOKEN }}

.gitignore

@@ -0,0 +1,17 @@
+*.iml
+*.ipr
+*.iws
+*.crt
+*.hcl
+*.key
+.classpath
+.idea
+.project
+build
+target
+pom.xml.releaseBackup
+
+node
+node_modules
+package.json
+package-lock.json

.mvn/wrapper/maven-wrapper.jar

@@ -0,0 +1 @@
+distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip

.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,23 @@
+= Spring Vault Docs Build
+
+You're currently viewing the Antora playbook branch.
+The playbook branch hosts the docs build that is used to build and publish the production docs site.
+
+The Spring Vault reference docs are built using https://antora.org[Antora].
+This README covers how to build the docs in a software branch as well as how to build the production docs site locally.
+
+== Building the Site
+
+You can build the entire site by invoking the following on the docs-build branch and then viewing the site at `target/site/index.html`
+
+[source,bash]
+----
+mvn antora
+----
+
+== Building a Specific Branch
+
+[source,bash]
+----
+mvn antora
+----

README.adoc

@@ -0,0 +1,45 @@
+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/lib/version-fix.js'
+  - '@antora/atlas-extension'
+  - require: '@springio/antora-extensions/root-component-extension'
+    root_component_name: 'vault'
+site:
+  title: Spring Vault
+  url: https://docs.spring.io/spring-vault/reference
+  robots: allow
+git:
+  ensure_git_suffix: false
+content:
+  sources:
+  - url: https://github.com/spring-projects/spring-vault
+    # Refname matching:
+    # https://docs.antora.org/antora/latest/playbook/content-refname-matching/
+    branches: [ main,'({3..9}).+({1..9}).x', '!(3.0.x)' ]
+    tags: [ '({3..9}).+({1..9}).+({0..9})?(-{RC,M}+({0..9}))' ]
+    start_path: src/main/antora
+asciidoc:
+  attributes:
+    page-stackoverflow-url: https://stackoverflow.com/tags/spring-vault
+    page-pagination: ''
+    hide-uri-scheme: '@'
+    tabs-sync-option: '@'
+  extensions:
+  - '@asciidoctor/tabs'
+  - '@springio/asciidoctor-extensions'
+urls:
+  latest_version_segment_strategy: redirect:to
+  latest_version_segment: ''
+  redirect_facility: httpd
+ui:
+  bundle:
+    url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.3/ui-bundle.zip
+    snapshot: true
+runtime:
+  log:
+    failure_level: warn
+    format: pretty

antora-playbook.yml

@@ -0,0 +1,18 @@
+'use strict'
+
+/**
+ * The purpose of this extension is to fix invalid metadata saved to either antora.yml or gradle.properties in certain
+ * tags. This invalid metadata prevents Antora from classifying the component versions properly.
+ *
+ * This extension should be listed directly after @antora/collector-extension.
+ */
+ module.exports.register = function () {
+   this.once('contentAggregated', ({ contentAggregate }) => {
+       contentAggregate.forEach((componentVersionBucket) => {
+         if (componentVersionBucket.version === '3.2.0-SNAPSHOT') {
+           componentVersionBucket.version = '3.2.0'
+           componentVersionBucket.prerelease = '-SNAPSHOT'
+         }
+       })
+     })
+ }