Website update (main) #73
This file contains hidden or 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: publish-website | |
| on: | |
| workflow_dispatch: {} | |
| push: | |
| tags: | |
| - '*' | |
| run-name: "Website update (${{ github.ref_name }})" | |
| permissions: | |
| contents: write # to push to the gh-pages branch | |
| jobs: | |
| publish-website: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v7 | |
| with: | |
| fetch-depth: 0 # to fetch all tags for proper version | |
| - name: Set up JDK ${{ matrix.jdk-version }} | |
| uses: actions/setup-java@v5 | |
| with: | |
| distribution: 'temurin' | |
| java-version: 17 | |
| - name: Set up Gradle | |
| uses: gradle/actions/setup-gradle@v5 | |
| - name: Generate KDocs | |
| run: ./gradlew generateWebsiteKDocs | |
| - name: Setup Python | |
| uses: actions/setup-python@v7 | |
| with: | |
| python-version: 3.x | |
| - name: Install MkDocs Material | |
| run: | | |
| pip install \ | |
| mkdocs-material \ | |
| mkdocs-macros-plugin \ | |
| mkdocs-git-revision-date-localized-plugin \ | |
| "mkdocs-material[imaging]" | |
| - name: Deploy doc to GitHub pages | |
| # --strict aborts on any warning | |
| # --force forces the push to the repo (gh-pages branch) | |
| run: | | |
| cd docs | |
| mkdocs gh-deploy --strict --force |