reconfigure branch for local builds and as scheduler for docs workflows

- set up placeholder and trigger for Deploy Docs workflow in docs-build branch
- set up placeholder and trigger for Rebuild Search Index workflow in docs-build branch
- remove obsolete Deploy Reference workflow
- upgrade Antora to 3.1
- reconfigure docs build for local build only
- add patch to support using linked worktree as Antora content source
- remove Antora extensions only needed for the production docs build
This commit is contained in:
Dan Allen
2022-09-08 15:31:19 -06:00
committed by Rob Winch
parent 929b334588
commit d22ee32c7d
18 changed files with 151 additions and 407 deletions

View File

@@ -1,20 +0,0 @@
name: Update Algolia Index
on:
schedule:
- cron: '0 10 * * *' # Once per day at 10am UTC
workflow_dispatch: # Manual trigger
permissions:
contents: read
jobs:
update:
name: Update Algolia Index
runs-on: ubuntu-latest
if: ${{ github.repository == 'spring-projects/spring-security' }}
steps:
- name: Checkout Source
uses: actions/checkout@v2
- name: Update Index
run: ${GITHUB_WORKSPACE}/.github/actions/algolia-docsearch-scraper.sh "${{ secrets.ALGOLIA_APPLICATION_ID }}" "${{ secrets.ALGOLIA_WRITE_API_KEY }}" "${GITHUB_WORKSPACE}/.github/actions/algolia-config.json"

8
.github/workflows/deploy-docs.yml vendored Normal file
View File

@@ -0,0 +1,8 @@
name: Deploy Docs
on:
workflow_dispatch:
jobs:
register:
if: false
steps:
- run: echo Workflow registered!

View File

@@ -1,34 +0,0 @@
name: Build & Deploy Reference
on:
repository_dispatch:
types: request-build-reference
schedule:
- cron: '0 10 * * *' # Once per day at 10am UTC
workflow_dispatch: # Manual trigger
permissions:
contents: read
jobs:
deploy:
name: deploy
runs-on: ubuntu-latest
if: ${{ github.repository == 'spring-projects/spring-security' }}
steps:
- uses: actions/checkout@v2
- name: Set up gradle
uses: spring-io/spring-gradle-build-action@v1
with:
java-version: '17'
distribution: 'temurin'
- name: Cleanup Gradle Cache
# Remove some files from the Gradle cache, so they aren't cached by GitHub Actions.
# Restoring these files from a GitHub Actions cache might cause problems for future builds.
run: |
rm -f /home/runner/.gradle/caches/modules-2/modules-2.lock
rm -f /home/runner/.gradle/caches/modules-2/gc.properties
- name: Build with Gradle
run: ./gradlew :spring-security-docs:antora --stacktrace
- name: Deploy
run: ${GITHUB_WORKSPACE}/.github/actions/algolia-deploy.sh "${{ secrets.DOCS_USERNAME }}@${{ secrets.DOCS_HOST }}" "/opt/www/domains/spring.io/docs/htdocs/spring-security/reference/" "${{ secrets.DOCS_SSH_KEY }}" "${{ secrets.DOCS_SSH_HOST_KEY }}"

View File

@@ -0,0 +1,8 @@
name: Rebuild Search Index
on:
workflow_dispatch:
jobs:
register:
if: false
steps:
- run: echo Workflow registered!

View File

@@ -0,0 +1,22 @@
name: Trigger Deploy Docs
on:
repository_dispatch:
types: request-build-reference # legacy
schedule:
- cron: '0 10 * * *' # Once per day at 10am UTC
workflow_dispatch:
permissions: read-all
jobs:
build:
runs-on: ubuntu-latest
if: github.repository_owner == 'spring-projects'
steps:
- name: Checkout
uses: actions/checkout@v2
with:
ref: docs-build
fetch-depth: 1
- name: Dispatch
run: gh workflow run --ref $(git rev-parse --abbrev-ref HEAD) deploy-docs.yml
env:
GH_TOKEN: ${{ secrets.GH_ACTIONS_REPO_TOKEN }}

View File

@@ -0,0 +1,20 @@
name: Trigger Rebuild Search Index
on:
schedule:
- cron: '0 10 * * *' # Once per day at 10am UTC
workflow_dispatch:
permissions: read-all
jobs:
build:
runs-on: ubuntu-latest
if: github.repository_owner == 'spring-projects'
steps:
- name: Checkout
uses: actions/checkout@v2
with:
ref: docs-build
fetch-depth: 1
- name: Dispatch
run: gh workflow run --ref $(git rev-parse --abbrev-ref HEAD) rebuild-search-index.yml
env:
GH_TOKEN: ${{ secrets.GH_ACTIONS_REPO_TOKEN }}