HHH-19519: Document breaking changes in new Hibernate Maven Plugin #10835
Conversation
- Add JavaDoc style documentation to the plugin parameters to improve the Maven plugin description - Change the parameter defaults for 'enableLazyInitialization' and 'enableDirtyTracking' to bring it in line with the former behaviour - Modify the 'groupId' and 'artifactId' in the documentation - Provide complete documentation in the User Guide in line with the Ant task for bytecode enhancement
- Rename 'HibernateEnhancerMojo' to 'EnhancerMojo' - Rename 'HibernateEnhancerMojoTest' to 'EnhancerMojoTest' - Add integration test 'HibernateEnhancerMojoTestIT' to test the different configuration options - Make sure that the enhancer is not doing anything if all the enablement parameters are false Signed-off-by: Koen Aers <koen.aers@gmail.com>
- Add dependencies on 'maven-resolver-transport-http' and 'maven-resolver-connector-basic' for MavenCli to be able to download dependencies Signed-off-by: Koen Aers <koen.aers@gmail.com>
|
This finally has built fine... Thanks @marko-bekhta for your help! |
tooling/hibernate-maven-plugin/src/main/java/org/hibernate/orm/tooling/maven/EnhancerMojo.java
Show resolved
Hide resolved
tooling/hibernate-maven-plugin/src/main/java/org/hibernate/orm/tooling/maven/EnhancerMojo.java
Show resolved
Hide resolved
| build-time enhancement of the domain model as they are compiled as part of a Maven | ||
| build. See the section on <<BytecodeEnhancement>> for details | ||
| on the configuration settings. By default, all enhancements are disabled. | ||
| on the configuration settings. |
There was a problem hiding this comment.
As discussed, if anything changed, we will need the changes documented in migration-guide.adoc at the root of the repository. That needs to happen on the branch where the changes happened, though -- which I think would be 7.0.
From the top of my head, the changes are:
- Renaming of the plugin
- Default settings
- Maybe some Maven plugin configuration e.g. filesets?
There was a problem hiding this comment.
I believe this is only the renaming of the plugin. I included this in the other PR I just opened but I'll need to account for your other comments in that one as well.
| While this parameter is mandatory, its value will be ignored if the <<maven-enhance-filesets-parameter, fileSets>> | ||
| parameter is specified. |
There was a problem hiding this comment.
It is not mandatory if it has a default.
| While this parameter is mandatory, its value will be ignored if the <<maven-enhance-filesets-parameter, fileSets>> | |
| parameter is specified. | |
| If both `classesDirectory` and <<maven-enhance-filesets-parameter,fileSets>> are set, `fileSets` takes precedence. |
| This is an optional parameter but if it is specified the | ||
| <<maven-enhance-classesDirectory-parameter, classesDirectory>> parameter described above is ignored. |
There was a problem hiding this comment.
| This is an optional parameter but if it is specified the | |
| <<maven-enhance-classesDirectory-parameter, classesDirectory>> parameter described above is ignored. | |
| If both <<maven-enhance-classesDirectory-parameter, classesDirectory>> and `fileSets` are set, `fileSets` takes precedence. |
|
@yrodiere I completely messed this up... For some reason I didn't see your comments and I thought it was merged so I created a backport and opened a new PR deleting this topic branch... |
|
I think this was intended to be closed in favor of #11013 So... closing |
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license
and can be relicensed under the terms of the LGPL v2.1 license in the future at the maintainers' discretion.
For more information on licensing, please check here.
https://hibernate.atlassian.net/browse/HHH-19519