Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix JTE javadoc on the plugin site #193

Merged
merged 1 commit into from
Apr 5, 2021
Merged

Fix JTE javadoc on the plugin site #193

merged 1 commit into from
Apr 5, 2021

Conversation

steven-terrana
Copy link

PR Details

Right now, the JTE JavaDocs on the Plugin Site are only showing the contents of src/main/java.

This PR updates the build.groovy file to override the default behavior of the javadocJar task to "trick" the plugin site into showing the groovydocs (which include the src/main/java content as well).

How Has This Been Tested

I ran

./gradlew javadocJar

and then after switching to the build/libs directory, i exploded the javadoc jar file via:

jar xf *-javadoc.jar

and then validated that index.html was the groovydocs vs the javadocs.

Types of Changes

  • Added Unit Testing
  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have added the appropriate label for this PR
  • If necessary, I have updated the documentation accordingly.
  • All new and existing tests passed.

@steven-terrana steven-terrana added the documentation JTE Documentation Updates label Apr 3, 2021
@cokieffebah cokieffebah self-requested a review April 5, 2021 00:23
Copy link

@cokieffebah cokieffebah left a comment

Choose a reason for hiding this comment

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

wondering if the commands should be a justfile command? not sure.
./gradlew javadocJar
jar xf build/libs/*-javadoc.jar
open index.html // maybe?

@steven-terrana
Copy link
Author

for that i would run:

./gradlew groovydoc

which would output the same HTML to build/docs/groovydoc/index.html (i think)

We could add a groovydoc recipe to the Justfile.

@steven-terrana
Copy link
Author

additional info, the javadocJar task is part of what gets executed by ./gradlew publish.

So this change just overwrites the default javadocJar to use groovy docs instead.

@steven-terrana steven-terrana merged commit 7e4b2db into jenkinsci:main Apr 5, 2021
@steven-terrana steven-terrana deleted the groovydoc branch April 27, 2021 22:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation JTE Documentation Updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants