Skip to content

Conversation

@lpatino10
Copy link
Contributor

This PR fixes my last one to make sure generating the Javadoc and pushing them to the gh-pages branch actually works. The changes I had to make were:

  • Calling the mvn javadoc:javadoc command to actually generate the docs
  • Modifying the new scripts to allow them to be executed
  • Fixing the path calling the generate-index-html script
@lpatino10 lpatino10 requested a review from padamstx April 27, 2019 19:50
Copy link
Contributor

@germanattanasio germanattanasio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@germanattanasio germanattanasio merged commit 72029dd into master Apr 28, 2019

script:
- mvn clean package
- mvn javadoc:javadoc
Copy link
Contributor

@padamstx padamstx Apr 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This additional command should work fine, but I think if you had changed the package goal in the first command to be install that it would also create the javadocs (I think... it might also require an additional pom.xml config change as well, not 100% sure)). Just for future reference :)

Edit: Actually, I just reminded myself that the original mvn clean package command already creates the javadocs as that is one of the jars that are deployed to the git repo's Release tab. Do we still need an additional mvn command to do that again?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, probably not then 😕 I wasn't sure originally if that was the issue we were having.

- provider: script
script: "./build/push-javadoc-to-gh-pages.sh"
skip_cleanup: true
on:
Copy link
Contributor

@padamstx padamstx Apr 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm, I don't think we want to deploy on all builds, do we? That's why I had set the on: tags qualifier.
Edit: never mind, I now see that this change was only done to the new javadoc deploy step :)

Copy link
Contributor

@germanattanasio germanattanasio Apr 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The script was designed to deploy branches too
See: http://watson-developer-cloud.github.io/java-sdk/
Users can see what's in master or any other branch

@padamstx padamstx deleted the javadoc-fix branch June 16, 2019 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

4 participants