Documentation passing #4
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: Deploy Javadoc with Custom Index | |
| on: | |
| push: | |
| branches: | |
| - dev | |
| jobs: | |
| javadoc: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| - name: Set up JDK | |
| uses: actions/setup-java@v3 | |
| with: | |
| java-version: '17' | |
| distribution: 'temurin' # You can choose 'zulu' or other distributions if needed | |
| - name: Generate Javadoc | |
| run: mvn javadoc:javadoc | |
| # Copy the custom index.html to the Javadoc output directory | |
| - name: Replace Javadoc index.html with custom file | |
| run: cp docs/index.html target/site/apidocs/index.html | |
| # Deploy Javadoc to GitHub Pages | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: target/site/apidocs |