Skip to content

Fail documentation builds on missing includes #11247

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
Nov 17, 2025
Merged

Fail documentation builds on missing includes #11247

Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions documentation/documentation.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,8 @@ asciidoctorj {
'html-meta-version-family': ormBuildDetails.hibernateVersion.family

options logDocuments: true

fatalWarnings(missingIncludes())
}


Expand Down
6 changes: 3 additions & 3 deletions documentation/src/main/asciidoc/userguide/chapters/domain/entity.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ The https://docs.hibernate.org/orm/{majorMinorVersion}/javadocs/org/hibernate/an
====
[source,java]
----
include::{example-dir-proxy}/concrete/AbstractConcreteProxyTest.java[tag=entity-concrete-proxy-mapping,indent=0]
include::{example-dir-proxy}/concrete/ConcreteProxyTest.java[tag=entity-concrete-proxy-mapping,indent=0]
----
====

Expand All @@ -481,7 +481,7 @@ In the following example we load the parent's lazy association and resolve to th
====
[source,java]
----
include::{example-dir-proxy}/concrete/AbstractConcreteProxyTest.java[tag=entity-concrete-proxy-find,indent=0]
include::{example-dir-proxy}/concrete/ConcreteProxyTest.java[tag=entity-concrete-proxy-find,indent=0]
----

[source,sql]
Expand All @@ -505,7 +505,7 @@ In the following example, you can see how Hibernate issues a query to resolve th
====
[source,java]
----
include::{example-dir-proxy}/concrete/AbstractConcreteProxyTest.java[tag=entity-concrete-proxy-reference,indent=0]
include::{example-dir-proxy}/concrete/ConcreteProxyTest.java[tag=entity-concrete-proxy-reference,indent=0]
----

[source,sql]
Expand Down
4 changes: 2 additions & 2 deletions documentation/src/main/asciidoc/userguide/chapters/pc/PersistenceContext.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,7 +584,7 @@ if the `@Filter` defines a condition that uses predicates across multiple tables
====
[source, java, indent=0]
----
include::{example-dir-pc}/FilterSqlFragementAliasTest.java[tags=pc-filter-sql-fragment-alias-example]
include::{example-dir-pc}/FilterSqlFragmentAliasTest.java[tags=pc-filter-sql-fragment-alias-example]
----
====

Expand All @@ -596,7 +596,7 @@ Hibernate is going to apply the right table aliases to the filter predicates:
====
[source, java, indent=0]
----
include::{example-dir-pc}/FilterSqlFragementAliasTest.java[tags=pc-filter-sql-fragment-alias-query-example]
include::{example-dir-pc}/FilterSqlFragmentAliasTest.java[tags=pc-filter-sql-fragment-alias-query-example]
----

[source, sql, indent=0]
Expand Down
19 changes: 19 additions & 0 deletions hibernate-core/src/test/java/org/hibernate/orm/test/mapping/basic/bitset/BitSetTypeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@

import org.hibernate.annotations.Parameter;
import org.hibernate.annotations.Type;
import org.hibernate.boot.MetadataBuilder;
import org.hibernate.boot.MetadataSources;
import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
import org.hibernate.testing.orm.junit.DomainModel;
import org.hibernate.testing.orm.junit.ServiceRegistry;
import org.hibernate.testing.orm.junit.SessionFactory;
Expand Down Expand Up @@ -37,6 +40,22 @@ public void cleanup(SessionFactoryScope scope) {
scope.getSessionFactory().getSchemaManager().truncateMappedObjects();
}

/*
* We don't need this code for the test itself but we need to include it in the ref doc.
*/
public void ignoredJustForIncludeInSources() {
try (org.hibernate.service.ServiceRegistry standardRegistry = new StandardServiceRegistryBuilder().build()) {
//tag::basic-custom-type-register-BasicType-example[]
MetadataSources sources = new MetadataSources( standardRegistry );
MetadataBuilder metadataBuilder = sources.getMetadataBuilder();
metadataBuilder.applyBasicType( BitSetType.INSTANCE );
//end::basic-custom-type-register-BasicType-example[]
}
catch (Exception ignore) {

}
}

@Test
public void test(SessionFactoryScope scope) {

Expand Down