Issue 149: Add auto-generation and publication of API JavaDocs #150
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses issue #149, by adding automatic generation and publication of API JavaDocs upon push of a PR to the
master
branch (note: there may be a better condition to ensure this job only fires when a new version of the library is released / published - I'm not familiar enough with the project's branching / tagging approach to have set that up in this PR).This PR is necessary but not sufficient to enable API JavaDoc generation and publication - it will also require some configuration of the GitHub project itself by a project owner. Note that in the past I've noticed a one-time "chicken and egg" problem with these setup steps:
gh-pages
branch that needs to be referenced in that configuration)This is a minor one-time annoyance, but I thought it worth noting as I've been bitten by it in the past and thought something had gone wrong.