Added comments to JavaDoc publication yml file #3
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 | |
| #Note: The Javadoc-publisher action only commits to javadoc branch and triggers the GitHub pages update action if there | |
| # are changes in the JavaDoc, i.e. it ignores the Readme.md that is used as main landing page of the GitHub pages! | |
| # And these need to be merged into the javadoc branch. | |
| on: | |
| #release: # to trigger this only at new releases, comment this in and the next three lines out | |
| #types: [created, published, released] | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| publish: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Deploy JavaDoc 🚀 | |
| uses: MathieuSoysal/Javadoc-publisher.yml@v2.4.0 | |
| with: | |
| GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} | |
| javadoc-branch: javadoc | |
| java-version: 17 | |
| target-folder: javadoc | |
| project: gradle |