Skip to content

Gradle plugin bytecode enhancement configuration: updated the documentaiton and migration guide #10678

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

Merged
merged 1 commit into from
Aug 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 10 additions & 1 deletion documentation/src/main/asciidoc/introduction/Advanced.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -994,9 +994,18 @@ plugins {
id "org.hibernate.orm" version "{fullVersion}"
}
hibernate { enhancement }
hibernate {
enhancement {}
}
----

[CAUTION]
====
Some online documentation (including previous versions of the present one) suggest to use `hibernate { enhancement }`, which will _not_ work as it is interpreted by Gradle as a (pointless) getter call instead of actual configuration.
That form will result in bytecode enhancement NOT happening (unfortunately silently).
To enable bytecode enhancement, make sure to always use the block form (with `{}`).
====

// [discrete]
// ==== Attribute-level lazy fetching

Expand Down
15 changes: 15 additions & 0 deletions migration-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,21 @@ Applications should instead use proper object-oriented encapsulation, exposing m

Additionally, attempting to re-enhance a class with different options is no longer allowed and will result in a `FeatureMismatchException`.

The Gradle plugin configuration has changed slightly. When using the default setup:

```
hibernate { enhancement }
```

it should be updated to:

```
hibernate {
enhancement {}
}
```

in order to properly enable Bytecode Enhancement.

[[session-getLobHelper]]
=== Session#getLobHelper
Expand Down