Skip to content

Remove outdated documentation from hibernate-gradle-plugin README #9553

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 6, 2025
+2 −43
Merged

Remove outdated documentation from hibernate-gradle-plugin README #9553

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 2 additions & 43 deletions tooling/hibernate-gradle-plugin/README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,9 @@ useSameVersion:: Specifies whether to have the plugin inject an `implementation`
sourceSet:: The source-set containing the project's domain model. Only one source-set is supported, although all languages (Java, Kotlin, etc)
within that source-set are considered.

It additionally defines 3 nested DSL extensions related to:
It additionally defines 2 nested DSL extensions related to:

* <<enhance>>
* <<jpa-metamodel>>
* <<hbm-xml>>


Expand Down Expand Up @@ -72,47 +71,7 @@ hibernate {
}
----


[[jpa-metamodel]]
== JPA Static Metamodel generation

The plugin can also generate the JPA static metamodel classes based on the application's domain model. To enable
the generation, simply refer to the DSL extension:

[source,groovy]
----
hibernate {
jpaMetamodel
}
----

The generation accepts a number of options:

[source,groovy]
----
hibernate {
jpaMetamodel {
// directory where the generated metamodel source files should be written
// - defaults to `${buildDir}/generated/sources/jpaMetamodel
generationOutputDirectory = "some/other/dir"

// directory where the compiled generated metamodel classes should be written
// - defaults to `${buildDir}/classes/java/jpaMetamodel
compileOutputDirectory = "special/classes/dir"

// should the `jakarta.annotation.Generated` annotation be applied?
// - defaults to true
applyGeneratedAnnotation = true

// error suppressions to be added to the generated source files
// - default is ["raw", "deprecation"]
suppressions = ...
}
}
----


[[hbm-xml]]
== Legacy `hbm.xml` Transformation

Coming soon...
Coming soon...