Deploy Docs (antora) #8
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Deploy Docs | |
| 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 | |
| push: | |
| branches: docs-build | |
| env: | |
| GRADLE_ENTERPRISE_SECRET_ACCESS_KEY: ${{ secrets.GRADLE_ENTERPRISE_SECRET_ACCESS_KEY }} | |
| permissions: | |
| contents: write | |
| jobs: | |
| build: | |
| if: github.repository_owner == 'spring-cloud' | |
| 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: 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: Run Antora | |
| run: | | |
| ./mvnw --no-transfer-progress -B antora | |
| - name: Publish Docs | |
| uses: spring-io/spring-doc-actions/rsync-antora-reference@v0.0.11 | |
| 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/bust-cloudflare-antora-cache@v0.0.11 | |
| with: | |
| context-root: spring-cloud-task | |
| cloudflare-zone-id: ${{ secrets.CLOUDFLARE_ZONE_ID }} | |
| cloudflare-cache-token: ${{ secrets.CLOUDFLARE_CACHE_TOKEN }} |