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 Maven Plugin documentation #341

Merged
merged 4 commits into from
Apr 9, 2024

Conversation

marcospereira
Copy link
Contributor

Requirements

This requires #339. I will keep it as a draft until the other PR is merged/closed.

What

Add a new documentation page to detail the parameters, goals, and usage of the Maven Plugin.

Copy link

codecov bot commented Apr 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.38%. Comparing base (376f241) to head (720b88b).
Report is 2 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main     #341      +/-   ##
============================================
+ Coverage     91.31%   91.38%   +0.06%     
- Complexity     1218     1219       +1     
============================================
  Files            76       76              
  Lines          3168     3168              
  Branches        493      493              
============================================
+ Hits           2893     2895       +2     
+ Misses          164      163       -1     
+ Partials        111      110       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@casid
Copy link
Owner

casid commented Apr 5, 2024

@marcospereira wow, the quality of that maven plugin documentation is insane.

Looks very good to me, I'll have a look at the other PR that blocks this merge.

@marcospereira marcospereira marked this pull request as ready for review April 5, 2024 14:20
@marcospereira
Copy link
Contributor Author

Thanks! 😊

This is ready to go now. I will find the time to do the same for Gradle later.

docs/maven-plugin.md Outdated Show resolved Hide resolved

!!! warning "Clean all before precompiling"

The `precompile` goal cleans the directory containing the compiled template classes every time it runs. In your local development environment, it may make more sense to use [hot reloading](hot-reloading.md).
Copy link
Collaborator

Choose a reason for hiding this comment

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

The hint to hot reloading seems unrelated to the Clean all before precompiling warning.

docs/maven-plugin.md Outdated Show resolved Hide resolved
Co-authored-by: Niklas Keller <me@kelunik.com>
@casid casid merged commit 0f73648 into casid:main Apr 9, 2024
10 checks passed
@marcospereira marcospereira deleted the docs/build-tools branch April 9, 2024 19:35
@marcospereira
Copy link
Contributor Author

@casid, thanks for merging! 🎉

Maybe after merging #346, we can have another release that ships #339.

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