Add example to demonstrate how to configure a custom Dokka plugin (#3… #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: Deploy examples to GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - master | |
| paths: | |
| - 'examples/**' | |
| jobs: | |
| build-examples: | |
| runs-on: ubuntu-latest | |
| if: github.repository == 'Kotlin/dokka' | |
| strategy: | |
| matrix: | |
| projects: [ | |
| dokka-gradle-example, | |
| dokka-kotlinAsJava-example, | |
| dokka-library-publishing-example, | |
| dokka-multiplatform-example, | |
| dokka-customFormat-example | |
| ] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dorny/paths-filter@v3 | |
| id: filter | |
| with: | |
| filters: | | |
| examples_changed: | |
| - 'examples/gradle/${{ matrix.projects }}/**' | |
| - uses: actions/setup-java@v4 | |
| with: | |
| distribution: 'zulu' | |
| java-version: 17 | |
| - uses: gradle/actions/setup-gradle@v4 | |
| with: | |
| develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }} | |
| - name: Build html | |
| run: ./gradlew dokkaHtml --no-daemon --stacktrace | |
| working-directory: examples/gradle/${{ matrix.projects }} | |
| if: steps.filter.outputs.examples_changed == 'true' | |
| - name: Upload artifact | |
| uses: actions/upload-artifact@v4 | |
| if: steps.filter.outputs.examples_changed == 'true' | |
| with: | |
| name: ${{ matrix.projects }} | |
| path: examples/gradle/${{ matrix.projects }}/build/dokka | |
| build-multimodule-examples: | |
| runs-on: ubuntu-latest | |
| if: github.repository == 'Kotlin/dokka' | |
| strategy: | |
| matrix: | |
| projects: [ | |
| dokka-versioning-multimodule-example, | |
| dokka-multimodule-example | |
| ] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dorny/paths-filter@v3 | |
| id: filter | |
| with: | |
| filters: | | |
| examples_changed: | |
| - 'examples/gradle/${{ matrix.projects }}/**' | |
| - uses: actions/setup-java@v4 | |
| with: | |
| distribution: 'zulu' | |
| java-version: 17 | |
| cache: 'maven' | |
| - uses: gradle/actions/setup-gradle@v4 | |
| with: | |
| develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }} | |
| - name: Build html | |
| run: ./gradlew dokkaHtmlMultiModule --no-daemon --stacktrace | |
| working-directory: examples/gradle/${{ matrix.projects }} | |
| if: steps.filter.outputs.examples_changed == 'true' | |
| - name: Upload artifact | |
| uses: actions/upload-artifact@v4 | |
| if: steps.filter.outputs.examples_changed == 'true' | |
| with: | |
| name: ${{ matrix.projects }} | |
| path: examples/gradle/${{ matrix.projects }}/parentProject/build/dokka | |
| deploy-examples: | |
| runs-on: ubuntu-latest | |
| needs: [ build-examples, build-multimodule-examples ] | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| path: public/examples | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| keep_files: true | |
| publish_dir: ./public | |
| full_commit_message: Publish examples |