HSEARCH-4971 Enforce copyright headers on more file types

.github/workflows/build.yml

@@ -1,3 +1,6 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright Red Hat Inc. and Hibernate Authors
+
 # The main CI of Hibernate Search is https://ci.hibernate.org/job/hibernate-search/.
 # However, Hibernate Search builds run on GitHub actions regularly
 # to build on Windows

build/config/src/main/resources/checkstyle.xml

@@ -21,6 +21,16 @@
         <property name="fileExtensions" value="xml"/>
     </module>
 
+    <module name="Header">
+        <property name="headerFile" value="classpath:/org/hibernate/search/headers/properties.header"/>
+        <property name="fileExtensions" value="properties"/>
+    </module>
+
+    <module name="Header">
+        <property name="headerFile" value="classpath:/org/hibernate/search/headers/adoc.header"/>
+        <property name="fileExtensions" value="adoc,asciidoc"/>
+    </module>
+
     <module name="TreeWalker">
 
         <module name="SuppressionCommentFilter" />

build/config/src/main/resources/org/hibernate/search/headers/adoc.header

@@ -0,0 +1,2 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright Red Hat Inc. and Hibernate Authors

build/config/src/main/resources/org/hibernate/search/headers/properties.header

@@ -0,0 +1,2 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright Red Hat Inc. and Hibernate Authors

documentation/src/main/asciidoc/internals/_configuration-properties-aggregated.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[configuration-properties-aggregated]]
 == List of all available configuration properties
 

documentation/src/main/asciidoc/internals/index.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 = Internals of Hibernate Search
 :doctype: book
 :revdate: {docdate}

documentation/src/main/asciidoc/migration/index.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 = Hibernate Search {hibernateSearchVersion}: Migration Guide from {hibernateSearchPreviousStableVersionShort}
 :doctype: book
 :revdate: {docdate}

documentation/src/main/asciidoc/public/components/_coordination-comparison-note.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [NOTE]
 ====
 Coordination is a complex topic,

documentation/src/main/asciidoc/public/components/_custom-projection-type-important.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [IMPORTANT]
 ====
 There are a few constraints to keep in mind when annotating a custom projection type:

documentation/src/main/asciidoc/public/components/_custom-projection-type-nonrecord-tip.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [TIP]
 ====
 Custom, non-record classes can also be annotated with `@ProjectionConstructor`,

documentation/src/main/asciidoc/public/components/_deprecated-warning.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [WARNING]
 ====
 Features detailed in this section are _deprecated_: they should be avoided in favor of non-deprecated alternatives.

documentation/src/main/asciidoc/public/components/_elasticsearch-json-warning.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [WARNING]
 ====
 This feature requires to directly manipulate JSON in application code.

documentation/src/main/asciidoc/public/components/_elasticsearch-request-response-warning.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [WARNING]
 ====
 Direct changes to the HTTP request may conflict with Hibernate Search features

documentation/src/main/asciidoc/public/components/_explanation-warning.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [WARNING]
 ====
 Regardless of the API used, explanations are rather costly performance-wise:

documentation/src/main/asciidoc/public/components/_field-aggregation-important.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [IMPORTANT]
 ====
 In order to use aggregations based on the value of a given field,

documentation/src/main/asciidoc/public/components/_field-projection-important.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [IMPORTANT]
 ====
 In order to use projections based on the value of a given field,

documentation/src/main/asciidoc/public/components/_field-sort-important.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [IMPORTANT]
 ====
 In order to use sorts based on the value of a given field,

documentation/src/main/asciidoc/public/components/_incubating-warning.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [WARNING]
 ====
 Features detailed below are _incubating_: they are still under active development.

documentation/src/main/asciidoc/public/components/_lucene-api-warning.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [WARNING]
 ====
 This feature implies that application code rely on Lucene APIs directly.

documentation/src/main/asciidoc/public/components/_mapper-orm-only-note.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [NOTE]
 ====
 This feature is only available with the <<mapper-orm,Hibernate ORM integration>>.

documentation/src/main/asciidoc/public/components/_search-entity-orm-warning.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [WARNING]
 ====
 `@SearchEntity` and its corresponding programmatic mapping `.searchEntity()`

documentation/src/main/asciidoc/public/components/_sharding-intro-note.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [NOTE]
 ====
 For a preliminary introduction to sharding,

documentation/src/main/asciidoc/public/components/_spi-warning.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [WARNING]
 ====
 Features detailed in this section rely on at least one _SPI_ (Service Provider Interface):

documentation/src/main/asciidoc/public/components/_timeout-besteffort-note.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [NOTE]
 ====
 Timeouts are handled on a best-effort basis.

documentation/src/main/asciidoc/public/components/_writing-reading-intro-note.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [NOTE]
 ====
 For a preliminary introduction to writing to and reading from indexes in Hibernate Search,

documentation/src/main/asciidoc/public/getting-started/index.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 :doctype: book
 :revdate: {docdate}
 :sectanchors:

documentation/src/main/asciidoc/public/getting-started/orm/index.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 :reference-documentation-location: ../../reference/index.adoc
 
 :doctype: book

documentation/src/main/asciidoc/public/getting-started/standalone/index.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 :reference-documentation-location: ../../reference/index.adoc
 
 :doctype: book

documentation/src/main/asciidoc/public/reference/_architecture.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[architecture]]
 = [[search-architecture]] Architecture
 

documentation/src/main/asciidoc/public/reference/_backend-elasticsearch.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[backend-elasticsearch]]
 = [[elasticsearch-integration]] Elasticsearch backend
 
@@ -428,7 +430,7 @@ include::{sourcedir}/org/hibernate/search/documentation/backend/elasticsearch/cl
 ====
 [source, XML, indent=0, subs="+callouts"]
 ----
-include::{resourcesdir}/configuration/http-client-configurer.properties[]
+include::{resourcesdir}/configuration/http-client-configurer.properties[tags=include]
 ----
 <1> Specify the HTTP client configurer.
 ====
@@ -1183,7 +1185,7 @@ must be defined separately and assigned a name.
 
 [source, XML, indent=0, subs="+callouts"]
 ----
-include::{resourcesdir}/analysis/elasticsearch-simple.properties[]
+include::{resourcesdir}/analysis/elasticsearch-simple.properties[tags=include]
 ----
 <1> Assign the configurer to the backend using a Hibernate Search configuration property.
 ====
@@ -1232,7 +1234,7 @@ but hardcoding `"default"` would work just as well.
 
 [source, XML, indent=0, subs="+callouts"]
 ----
-include::{resourcesdir}/analysis/elasticsearch-default-override.properties[]
+include::{resourcesdir}/analysis/elasticsearch-default-override.properties[tags=include]
 ----
 <1> Assign the configurer to the backend using a Hibernate Search configuration property.
 ====

documentation/src/main/asciidoc/public/reference/_backend-lucene.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[backend-lucene]]
 = [[search-lucene-native]] Lucene backend
 
@@ -660,7 +662,7 @@ include::{sourcedir}/org/hibernate/search/documentation/analysis/MyLuceneAnalysi
 
 [source, XML, indent=0, subs="+callouts"]
 ----
-include::{resourcesdir}/analysis/lucene-simple.properties[]
+include::{resourcesdir}/analysis/lucene-simple.properties[tags=include]
 ----
 <1> Assign the configurer to the backend using a Hibernate Search configuration property.
 ====
@@ -742,7 +744,7 @@ but hardcoding `"default"` would work just as well.
 
 [source, XML, indent=0, subs="+callouts"]
 ----
-include::{resourcesdir}/analysis/lucene-default-override.properties[]
+include::{resourcesdir}/analysis/lucene-default-override.properties[tags=include]
 ----
 <1> Assign the configurer to the backend using a Hibernate Search configuration property.
 ====

documentation/src/main/asciidoc/public/reference/_binding-basics.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[binding-basics]]
 = [[mapper-orm-bridge-basics]] [[section-custom-bridges]] Basics
 

documentation/src/main/asciidoc/public/reference/_binding-bridge-resolver.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[binding-bridge-resolver]]
 = [[mapper-orm-bridge-resolver]] [[_bridgeprovider_associate_a_bridge_to_a_given_return_type]] Assigning default bridges with the bridge resolver
 

documentation/src/main/asciidoc/public/reference/_binding-bridgeelement-dependencies.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[binding-bridgedelement-dependencies]]
 = [[mapper-orm-bridge-bridgedelement-dependencies]] Declaring dependencies to bridged elements
 

documentation/src/main/asciidoc/public/reference/_binding-identifierbridge.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[binding-identifierbridge]]
 = [[mapper-orm-bridge-identifierbridge]] Identifier bridge
 

documentation/src/main/asciidoc/public/reference/_binding-index-field-dsl.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[binding-index-field-dsl]]
 = [[mapper-orm-bridge-index-field-dsl]] Declaring and writing to index fields
 

documentation/src/main/asciidoc/public/reference/_binding-index-field-type-dsl.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[binding-index-field-type-dsl]]
 = [[mapper-orm-bridge-index-field-type-dsl]] Defining index field types
 

documentation/src/main/asciidoc/public/reference/_binding-named-predicate.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[binding-named-predicate]]
 = [[mapper-orm-bridge-named-predicate]] Defining named predicates
 

documentation/src/main/asciidoc/public/reference/_binding-projection.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[binding-projection]]
 = Projection binder
 

documentation/src/main/asciidoc/public/reference/_binding-propertybridge.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[binding-propertybridge]]
 = [[mapper-orm-bridge-propertybridge]] [[section-field-bridge]] Property bridge
 

documentation/src/main/asciidoc/public/reference/_binding-routingbridge.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[binding-routingbridge]]
 = [[mapper-orm-bridge-routingbridge]] [[mapper-orm-bridge-routingkeybridge]] Routing bridge
 

documentation/src/main/asciidoc/public/reference/_binding-typebridge.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[binding-typebridge]]
 = [[mapper-orm-bridge-typebridge]] [[_classbridge]] Type bridge
 

documentation/src/main/asciidoc/public/reference/_binding-valuebridge.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[binding-valuebridge]]
 = [[mapper-orm-bridge-valuebridge]] [[_stringbridge]] Value bridge
 

documentation/src/main/asciidoc/public/reference/_binding.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[binding]]
 = [[mapper-orm-bridge]] [[search-mapping-bridge]] Binding and bridges
 

documentation/src/main/asciidoc/public/reference/_compatibility.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[compatibility]]
 = [[getting-started-compatibility]] Compatibility
 

documentation/src/main/asciidoc/public/reference/_concepts.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[concepts]]
 = [[_concepts]] Concepts
 

documentation/src/main/asciidoc/public/reference/_configuration-properties-aggregated.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [appendix]
 [[configuration-properties-aggregated]]
 = List of all available configuration properties

documentation/src/main/asciidoc/public/reference/_configuration.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[configuration]]
 = [[search-configuration]] Configuration
 
@@ -432,7 +434,7 @@ the context also lists references to entities that could not be indexed correctl
 
 [source, XML, indent=0, subs="+callouts"]
 ----
-include::{resourcesdir}/reporting/failurehandler.properties[]
+include::{resourcesdir}/reporting/failurehandler.properties[tags=include]
 ----
 Assign the background failure handler using a Hibernate Search configuration property.
 ====

documentation/src/main/asciidoc/public/reference/_coordination.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[coordination]]
 = Coordination
 

documentation/src/main/asciidoc/public/reference/_credits.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[credits]]
 = Credits
 

documentation/src/main/asciidoc/public/reference/_entrypoints.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[entrypoints]]
 = Main API Entry Points
 

documentation/src/main/asciidoc/public/reference/_explicit_backend_index_operations.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[explicit-backend-index-operations]]
 = Explicit backend/index operations
 :leveloffset: +1

documentation/src/main/asciidoc/public/reference/_explicit_backend_index_operations_common.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[explicit-backend-index-operations-analysis-run-analysis]]
 = Applying configured analyzers/normalizers to a string
 

documentation/src/main/asciidoc/public/reference/_explicit_operations_elasticsearch-specific.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[explicit-backend-index-operations-elasticsearch]]
 = Elasticsearch-specific explicit backend/index operations
 

documentation/src/main/asciidoc/public/reference/_explicit_operations_lucene-specific.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[explicit-backend-index-operations-lucene]]
 = Lucene-specific explicit backend/index operations
 

documentation/src/main/asciidoc/public/reference/_further-reading.adoc

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Red Hat Inc. and Hibernate Authors
 [[further-reading]]
 = [[_further_reading]] Further reading