Add Gradle plugin for publishing JavaDoc to GitHub Pages #965
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.
r? @brandur-stripe @richardm-stripe
cc @stripe/api-libraries
This PR adds a Gradle plugin (
org.ajoberstar.git-publish
) that adds support for publishing the JavaDoc HTML output to GitHub pages.The plugin can be used like this:
This command will build the JavaDoc and push the results to the
gh-pages
branch. I've configured GitHub pages to use the contents of this branch. Apparently GitHub Pages even knows about the stripe.dev domain, so the results are available at https://stripe.dev/stripe-java.The intent is that we would run this command automatically in the release pipeline, so the JavaDoc stays up to date. We could then link to it from the README, as requested by a user some time ago (#770).