docs: update README.md #47
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: Generate Docs | |
on: | |
push: | |
branches: ["master"] | |
workflow_dispatch: | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
concurrency: | |
group: "pages" | |
cancel-in-progress: false | |
jobs: | |
build: | |
name: Build new docs | |
runs-on: ubuntu-latest | |
steps: | |
- name: Pull code | |
uses: actions/checkout@v3 | |
with: | |
persist-credentials: false | |
- name: Set up JDK | |
uses: actions/setup-java@v3 | |
with: | |
java-version: 21 | |
distribution: adopt | |
cache: gradle | |
- name: Build documentation | |
run: ./gradlew --no-daemon docs # --no-configuration-cache | |
- name: Save built docs | |
uses: actions/cache/save@v3 | |
with: | |
path: docs | |
key: ${{ github.sha }}-${{ github.workflow }} | |
# Single deploy job since we're just deploying | |
deploy: | |
name: Deploy to GitHub Pages | |
needs: build | |
# environment: | |
# name: github-pages | |
# url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v3 | |
- name: Restore built docs | |
uses: actions/cache/restore@v3 | |
with: | |
path: docs | |
key: ${{ github.sha }}-${{ github.workflow }} | |
- name: Setup Pages | |
uses: actions/configure-pages@v3 | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
# Upload entire repository | |
path: 'docs' | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v2 |