This repository has been archived by the owner on Mar 17, 2024. It is now read-only.
chore: link javadocs in contributing resources #45
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: Docs | |
| on: | |
| # Update on pushes to main | |
| push: | |
| branches: ['main'] | |
| # Allow running workflow manually | |
| workflow_dispatch: | |
| # Restrict permissions to just Github Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Only run one at a time, but don't cancel in-progress deployments | |
| concurrency: | |
| group: 'pages' | |
| cancel-in-progress: false | |
| jobs: | |
| # Build the site and publish an artifact | |
| build-and-deploy: | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Setup JDK 11 | |
| uses: actions/setup-java@v3 | |
| with: | |
| java-version: 11 | |
| distribution: 'temurin' | |
| cache: 'gradle' | |
| - name: Build documentation | |
| run: | | |
| chmod +x ./gradlew | |
| ./gradlew dokkaHtml | |
| - name: Upload site artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: 'TeamCode/build/dokka/html' | |
| - name: Deploy to Github Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |