Bump org.apache.maven.plugins:maven-javadoc-plugin from 3.5.0 to 3.6.0 #297
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: docs | |
| on: | |
| push: | |
| branches: [ master ] | |
| paths: [ '**.java', '.github/workflows/docs.yml' ] | |
| pull_request: | |
| branches: [ master ] | |
| release: | |
| types: [created] | |
| workflow_dispatch: | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@v4 | |
| - name: Checkout the gh-pages branch | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| ref: gh-pages | |
| path: gh-pages | |
| - name: Set up JDK 17 | |
| uses: actions/setup-java@v3 | |
| with: | |
| distribution: 'adopt' | |
| java-version: '17' | |
| - name: Build docs with Maven | |
| run: mvn compile javadoc:javadoc | |
| - name: Copy to Documentation Website Location | |
| if: ${{ github.event_name == 'release' || github.event_name == 'workflow_dispatch' }} | |
| run: | | |
| rm -rf gh-pages/api | |
| cp -rf target/site/apidocs/. gh-pages/api | |
| - name: Tidy up the javadocs | |
| if: ${{ github.event_name == 'release' || github.event_name == 'workflow_dispatch' }} | |
| id: tidy | |
| uses: cicirello/javadoc-cleanup@v1 | |
| with: | |
| base-url-path: https://jpt.cicirello.org/ | |
| path-to-root: gh-pages | |
| user-defined-block: | | |
| <meta name="referrer" content="strict-origin-when-cross-origin"> | |
| <link rel="icon" href="/images/favicon.svg" sizes="any" type="image/svg+xml"> | |
| - name: Log javadoc-cleanup output | |
| if: ${{ github.event_name == 'release' || github.event_name == 'workflow_dispatch' }} | |
| run: | | |
| echo "modified-count = ${{ steps.tidy.outputs.modified-count }}" | |
| - name: Commit documentation changes without pushing yet | |
| if: ${{ github.event_name == 'release' || github.event_name == 'workflow_dispatch' }} | |
| run: | | |
| cd gh-pages | |
| if [[ `git status --porcelain` ]]; then | |
| git config --global user.name 'github-actions' | |
| git config --global user.email '41898282+github-actions[bot]@users.noreply.github.com' | |
| git add -A | |
| git commit -m "Automated API website updates." | |
| fi | |
| cd .. | |
| - name: Generate the sitemap | |
| if: ${{ github.event_name == 'release' || github.event_name == 'workflow_dispatch' }} | |
| id: sitemap | |
| uses: cicirello/generate-sitemap@v1 | |
| with: | |
| base-url-path: https://jpt.cicirello.org/ | |
| path-to-root: gh-pages | |
| - name: Output stats | |
| if: ${{ github.event_name == 'release' || github.event_name == 'workflow_dispatch' }} | |
| run: | | |
| echo "sitemap-path = ${{ steps.sitemap.outputs.sitemap-path }}" | |
| echo "url-count = ${{ steps.sitemap.outputs.url-count }}" | |
| echo "excluded-count = ${{ steps.sitemap.outputs.excluded-count }}" | |
| - name: Commit documentation website sitemap and push all commits | |
| if: ${{ github.event_name == 'release' || github.event_name == 'workflow_dispatch' }} | |
| run: | | |
| cd gh-pages | |
| if [[ `git status --porcelain` ]]; then | |
| git config --global user.name 'github-actions' | |
| git config --global user.email '41898282+github-actions[bot]@users.noreply.github.com' | |
| git add -A | |
| git commit -m "Automated API website sitemap update." | |
| fi | |
| git push | |
| cd .. |