Merge pull request #25 from railsware/fix/package-naming #8
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: Build and Deploy Javadocs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| name: Build Javadocs and DocFX Site | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up JDK 17 | |
| uses: actions/setup-java@v4 | |
| with: | |
| java-version: 17 | |
| distribution: 'temurin' | |
| - name: Install .NET SDK # required for DocFX as a .NET tool | |
| uses: actions/setup-dotnet@v4 | |
| - name: Install DocFX Tool | |
| run: dotnet tool install -g docfx | |
| - name: Install dependencies and generate Javadocs | |
| run: mvn clean install -B -q -Dgpg.skip=true javadoc:javadoc javadoc:jar | |
| - name: Build Documentation Site | |
| run: docfx ./docs/docfx.json | |
| - name: Copy Javadocs to _site/api-docs | |
| run: | | |
| mkdir -p docs/_site/java-docs | |
| mv -v target/reports/apidocs/* docs/_site/java-docs/ | |
| # Upload the Javadocs as an artifact to be deployed | |
| - name: Upload Artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/_site | |
| deploy: | |
| name: Deploy to GitHub Pages | |
| runs-on: ubuntu-latest | |
| needs: build | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |