Generate javadoc and publish on Jitpack
Closed this issue · 1 comments
Description
I noticed it is possible to publish javadoc on Jitpack. It is then possible to go to a specific release of Eiffel Intelligence and check out the javadoc for only that version.
All Jitpack requires is a jar file named javadoc.jar: https://jitpack.io/docs/#javadoc-publishing
and we can add that to our build step since Jitpack runs the command mvn install for building maven projects.
The maven plugin https://maven.apache.org/plugins/maven-javadoc-plugin/index.html can be used to create the jar file out of existing javadoc. This plugin also automatically lints the javadoc for us and we can see any issues and correct them easily.
Perhaps it's even possible to add it as an extra step in Travis? I'm unsure if an extra job in Travis would bring additional benefits but being able to run it locally and in connection to mvn install would be great - as Jitpack handles the rest for us when we release new versions of Eiffel Intelligence.
Motivation
Exemplification
Benefits
With the maven javadoc plugin we get automatic linting of our javadoc when we build the javadoc jar file. It highlights if we have any issues in our javadoc (or if we've forgotten to update it when changing code).
Possible Drawbacks
Since I have not heard any response from this, I assume the interest is low or non-existent. I will close this issue for now. If, we in the future decide to go for this then a new issue can be opened.