improve package readme navigation #7
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: javadoc pages | |
| on: | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| name: build javadoc | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: checkout | |
| uses: actions/checkout@v5 | |
| - name: set up jdk 25 | |
| uses: actions/setup-java@v5 | |
| with: | |
| distribution: oracle | |
| java-version: '25' | |
| cache: maven | |
| - name: generate javadoc | |
| run: make docs | |
| - name: configure pages | |
| uses: actions/configure-pages@v5 | |
| - name: upload pages artifact | |
| uses: actions/upload-pages-artifact@v4 | |
| with: | |
| path: target/site/apidocs | |
| deploy: | |
| name: deploy javadoc | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: deploy pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |