Dokka #2
Workflow file for this run
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: Verify API Docs | |
| on: | |
| pull_request: | |
| permissions: | |
| contents: read | |
| jobs: | |
| verify-api-docs: | |
| name: Up-To-Date Check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Sources | |
| uses: actions/checkout@v4 | |
| - name: Setup Gradle | |
| uses: gradle/actions/setup-gradle@v3 | |
| - name: Check Dokka generation is up-to-date | |
| run: ./gradlew dokkaGenerate | |
| - name: Check Dokka HTML output is up-to-date | |
| run: git status --porcelain | grep "docs/pages/api/" && echo "Run `./gradlew dokkaGenerate` to update API docs and commit changes" && exit 1 || exit 0 |