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

Adds javadoc generator test #1182

Merged
merged 9 commits into from
Jul 6, 2022
Merged

Adds javadoc generator test #1182

merged 9 commits into from
Jul 6, 2022

Conversation

adrian-kong
Copy link
Contributor

Description

Checks whether javadocs can be built successfully to prevent gradle errors

JIRA Reference

https://swift-nav.atlassian.net/browse/DEVINFRA-807

@adrian-kong adrian-kong requested a review from a team as a code owner July 5, 2022 23:58
Base automatically changed from adrian/release4.5.0 to master July 6, 2022 01:29
@adrian-kong adrian-kong requested review from a team, silverjam and notoriaga as code owners July 6, 2022 01:29
@@ -504,6 +504,11 @@ java-examples:
cd $(SWIFTNAV_ROOT)/java/example && gradle clean fatjar
$(call announce-end,"Finished building fat jar")

javadoc javadocs:
Copy link
Contributor

Choose a reason for hiding this comment

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

We could make the dependency of the Java target so that it runs locally-- would there be any downsides to that?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As in - instead of the additional workflow we just add make javadocs to make java or make test-java when it is locally ran?
Not sure if the make javadocs is necessary overall - just to verify whether there are any errors preventing javadocs built when publishing i.e. #1180 probably not needed since errors should rarely occur(?) so can probably close this PR

Copy link
Contributor

Choose a reason for hiding this comment

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

If errors are rare then this is a good place to verify, making everyone check it locally sounds unnecessary

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants