MAIN-T-119 Publish JavaDoc to GitHub Pages #1
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: documentation | |
| on: | |
| # push: | |
| # branches: [ "main" ] | |
| pull_request: | |
| branches: [ "main" ] | |
| jobs: | |
| publish-javadoc: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write # if you have a protection rule on your repository, you'll need to give write permission to the workflow. | |
| steps: | |
| - name: Set up JDK 17 | |
| uses: actions/setup-java@v4 | |
| with: | |
| java-version: '17' | |
| distribution: 'temurin' | |
| - name: Setup Gradle | |
| uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0 | |
| - name: Generate documentation with Gradle Wrapper | |
| run: ./gradlew dokkaHtml | |
| - name: Deploy JavaDoc 🚀 | |
| uses: MathieuSoysal/[email protected] | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| javadoc-branch: javadoc | |
| java-version: 17 | |
| project: gradle | |
| target-folder: javadoc | |
| javadoc-source-folder: build/dokka/html |