[DEVOPS] [DOCS] Modularization and dokka setup #3
Workflow file for this run
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: "PR Checks for `main` documentation" | |
| on: | |
| pull_request: | |
| types: | |
| - opened # initially opened | |
| - reopened # closed then opened again | |
| - synchronize # any changes pushed | |
| branches: | |
| - main | |
| paths: # Only run checks on changes to documentation | |
| - "**/docs/*" | |
| - "*/README.md" | |
| jobs: | |
| build: | |
| name: "Generate Latest Documentation" | |
| runs-on: [ubuntu-22.04] | |
| if: github.event.pull_request.draft == false # ignore draft pull requests | |
| # env: | |
| # | |
| # outputs: | |
| # | |
| steps: | |
| - name: "Checkout Project" | |
| uses: actions/checkout@v4 | |
| - name: "Setup Java 17" | |
| uses: actions/setup-java@v4 | |
| with: | |
| distribution: 'temurin' # See 'Supported distributions' for available options | |
| java-version: '17' | |
| - name: "Setup Gradle" | |
| uses: gradle/actions/setup-gradle@v3 | |
| - name: "Generate Documentation" | |
| run: ./gradlew dokka | |
| # - run: upload documentation to GitHub pages site |