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

docs: Add gradle commands shadowJar and aggregateJavadocs #1122

Merged
merged 1 commit into from
Apr 20, 2022

Conversation

barbeau
Copy link
Member

@barbeau barbeau commented Apr 19, 2022

Summary:

Gradle commands shadowJar and aggregateJavadocs are currently missing from the build docs. Currently you have to hunt through the GitHub Action CI code to find them.

This PR adds them to the build docs to make them more obvious.

Expected behavior:

I should be able to read the build docs and understand all the key Gradle tasks that help me to build and run the project.

Please make sure these boxes are checked before submitting your pull request - thanks!

  • Run the unit tests with gradle test to make sure you didn't break anything
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • Include screenshot(s) showing how this pull request works and fixes the issue(s)

Copy link
Contributor

@maximearmstrong maximearmstrong left a comment

Choose a reason for hiding this comment

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

Thanks @barbeau !

@maximearmstrong maximearmstrong merged commit 578c689 into master Apr 20, 2022
@maximearmstrong maximearmstrong deleted the sean/more-build-docs branch April 20, 2022 12:28
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.

None yet

3 participants