dashiodevs/Deploy Javadoc to GitHub Pages
Automate the publishing of Javadoc documentation to GitHub Pages using a GitHub Action.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| GITHUB_TOKEN | The GitHub token used for repository access and authentication. | yes | — |
| BRANCH | The name of the branch where the Javadoc documentation will be published. Defaults to 'gh-pages'. | no | gh-pages |
| BRANCH_CLEANUP | Whether to clean up old branches. Set to 'true' to delete the old branch before publishing. Defaults to 'false'. | no | false |
| JAVA_VERSION | The version of Java that your project is using (e.g., 17). | yes | 17 |
| JAVA_DISTRIBUTION | The JDK distribution to use (e.g., 'adopt', 'zulu'). Defaults to 'adopt'. | no | adopt |
| SKIP_TESTS | Whether to skip tests during the build process. Set to 'true' to skip tests, 'false' otherwise. | no | false |
| DOC_DIRECTORY | The directory where the Javadoc documentation is generated. Defaults to 'target/reports/apidocs'. | no | target/reports/apidocs |
Outputs
no outputs