docs #21
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: docs | |
| env: | |
| GRADLE_OPTS: "-Dorg.gradle.jvmargs=-Xmx4g -Dorg.gradle.daemon=false -Dkotlin.incremental=false" | |
| RUNNING_ON_CI: "true" | |
| LC_ALL: C.UTF-8 | |
| LANG: C.UTF-8 | |
| on: | |
| push: | |
| tags: | |
| - v-** | |
| workflow_dispatch: | |
| inputs: | |
| ref: | |
| description: (Optional) Which tag to deploy | |
| type: string | |
| required: false | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| docs: | |
| name: Publish docs | |
| runs-on: macos-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ inputs.ref }} | |
| - name: Install JDK | |
| uses: actions/setup-java@v4 | |
| with: | |
| java-version: "17" | |
| distribution: "temurin" | |
| cache: "gradle" | |
| check-latest: true | |
| - name: Generate docs | |
| run: ./gradlew dokkaGenerate | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Upload Artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: 'build/docs/html' | |
| docs-deploy: | |
| name: Deploy docs | |
| needs: docs | |
| runs-on: macos-latest | |
| environment: | |
| name: github-pages | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |