From 026dab69e8f1ab61320a5542c7c7470ca8599910 Mon Sep 17 00:00:00 2001 From: marko-bekhta Date: Mon, 3 Nov 2025 10:09:03 +0100 Subject: [PATCH 1/3] HSEARCH-5513 Add a "What's New" document for series --- .../main/asciidoc/public/whats-new/index.adoc | 81 +++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 documentation/src/main/asciidoc/public/whats-new/index.adoc diff --git a/documentation/src/main/asciidoc/public/whats-new/index.adoc b/documentation/src/main/asciidoc/public/whats-new/index.adoc new file mode 100644 index 00000000000..a2b4a37a2b3 --- /dev/null +++ b/documentation/src/main/asciidoc/public/whats-new/index.adoc @@ -0,0 +1,81 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright Red Hat Inc. and Hibernate Authors += What's New in {hibernateSearchVersion} +:doctype: book +:revdate: {docdate} +:sectanchors: +:anchor: +:toc: left +:toclevels: 4 +:docinfodir: {docinfodir} +:docinfo: shared,private +:html-meta-description: Hibernate Search, full text search for your entities - Reference Documentation +:html-meta-keywords: hibernate, search, hibernate search, full text, lucene, elasticsearch, opensearch +:html-meta-canonical-link: https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/ +:title-logo-image: image:hibernate_logo_a.png[align=left,pdfwidth=33%] +:html-meta-version-family: {hibernateSearchVersionShort} +:version-selector-enabled: true +:stem: latexmath + +== Dependency upgrades + +[[orm-version]] +Hibernate ORM:: +Hibernate Search targets the Hibernate ORM 7.2 series. +[[lucene-version]] +Lucene:: +The Lucene backend now uses Lucene 9.12.2, while the `lucene-next` backend relies on Lucene 10.2.2 +[[elasticsearch-version]] +Elasticsearch:: +The Elasticsearch backend works with Elasticsearch 9.2, as well as other already compatible versions. +[[opensearch-version]] +OpenSearch:: +The Elasticsearch backend works with OpenSearch 3.2 and 3.3, as well as other already compatible versions. + +[[pluggable-clients]] +=== Pluggable Elasticsearch backend REST clients + +This version of Hibernate Search introduces pluggable REST clients for the Elasticsearch backend. +Historically, the Elasticsearch backend relied on the Elasticsearch low-level REST client, +which is based on Apache HTTP Client 4. With the new pluggable client architecture, +it is possible to switch to a different REST client as needed. +This may be useful when you are running Hibernate Search in an environment relying on a different HTTP client type (e.g. Vert.x). +or when you need to use some distribution specific client features and need to switch to the OpenSearch REST client. + +Hibernate Search provides the following REST client options out of the box: + +[[backend-elasticsearch-configuration-client-elasticsearch-client-rest4]] +==== Elasticsearch low level REST client (Apache HTTP Client 4) + +Coordinates:: +GroupID::: `org.hibernate.search` +ArtifactID::: `hibernate-search-backend-elasticsearch-client-rest4` +Underlying HTTP Client::: Apache HTTP Client 4 + +This Elasticsearch backend REST client is based on the Elasticsearch low level client (`org.elasticsearch.client:elasticsearch-rest-client`). +Currently, the default REST client used by the Elasticsearch backend. + +[[backend-elasticsearch-configuration-client-elasticsearch-client-rest5]] +==== Elasticsearch low level REST client (Apache HTTP Client 5) + +Coordinates:: +GroupID::: `org.hibernate.search` +ArtifactID::: `hibernate-search-backend-elasticsearch-client-rest5` +Underlying HTTP Client::: Apache HTTP Client 5 + +This Elasticsearch backend REST client is based on the newer Elasticsearch low level client (`co.elastic.clients:elasticsearch-rest5-client`), +which is also used in the `co.elastic.clients:elasticsearch-java`. + +[[backend-elasticsearch-configuration-client-elasticsearch-client-opensearch]] +==== OpenSearch low level REST client (Apache HTTP Client 5) + +Coordinates:: +GroupID::: `org.hibernate.search` +ArtifactID::: `hibernate-search-backend-elasticsearch-client-opensearch-rest` +Underlying HTTP Client::: Apache HTTP Client 5 + +This Elasticsearch backend REST client is based on the OpenSearch low level client (`org.opensearch.client:opensearch-rest-client`). + +NOTE: It is recommended to explicitly add a client that you prefer as a dependency, since in the future version +of Hibernate Search we will remove the implicit dependency on `hibernate-search-backend-elasticsearch-client-rest4` +from the Elasticsearch backend. From f3b084e0e1dbdcd0223482bea6c5469633b65c7f Mon Sep 17 00:00:00 2001 From: marko-bekhta Date: Thu, 13 Nov 2025 12:46:18 +0100 Subject: [PATCH 2/3] HSEARCH-5513 Add a GitHub release template --- ci/release/Jenkinsfile | 2 ++ github_release_notes.md | 3 +++ 2 files changed, 5 insertions(+) create mode 100644 github_release_notes.md diff --git a/ci/release/Jenkinsfile b/ci/release/Jenkinsfile index f2ac2ccae83..063b424bf63 100644 --- a/ci/release/Jenkinsfile +++ b/ci/release/Jenkinsfile @@ -85,8 +85,10 @@ pipeline { dir('.release/scripts') { sh 'git clone https://github.com/hibernate/hibernate-release-scripts.git .' } + def ghReleaseNote = sh(script: 'realpath -e github_release_notes.md 2>/dev/null', returnStdout: true).trim() sh """ bash -xe .release/scripts/release.sh -j ${params.RELEASE_DRY_RUN ? '-d' : ''} \ + ${ghReleaseNote != '' ? '--notes=' + ghReleaseNote : ''} \ search ${releaseVersion.toString()} ${developmentVersion.toString()} """ } diff --git a/github_release_notes.md b/github_release_notes.md new file mode 100644 index 00000000000..0ad38949e78 --- /dev/null +++ b/github_release_notes.md @@ -0,0 +1,3 @@ + +* See the [website](https://hibernate.org/search/releases/{{releaseVersionFamily}}) for requirements and compatibilities. +* See the [What's New](https://docs.hibernate.org/search/{{releaseVersionFamily}}/whats-new/en-US/html_single/) guide for details about new features and capabilities. From 1616695f81a64c8aa6856cf0b8942b57b7f1ceb2 Mon Sep 17 00:00:00 2001 From: marko-bekhta Date: Thu, 13 Nov 2025 12:50:50 +0100 Subject: [PATCH 3/3] HSEARCH-5513 Use docs.hibernate.org instead of docs.jboss.org/hibernate --- build/parents/build/pom.xml | 6 +++--- documentation/pom.xml | 4 ++-- documentation/src/main/asciidoc/internals/index.adoc | 2 +- documentation/src/main/asciidoc/migration/index.adoc | 6 +++--- .../src/main/asciidoc/public/getting-started/index.adoc | 2 +- .../src/main/asciidoc/public/getting-started/orm/index.adoc | 2 +- .../asciidoc/public/getting-started/standalone/index.adoc | 2 +- .../src/main/asciidoc/public/reference/_migrating.adoc | 2 +- documentation/src/main/asciidoc/public/reference/index.adoc | 2 +- documentation/src/main/asciidoc/public/whats-new/index.adoc | 2 +- .../orm/src/test/resources/DynamicMapBaseIT/toone.hbm.xml | 2 +- 11 files changed, 16 insertions(+), 16 deletions(-) diff --git a/build/parents/build/pom.xml b/build/parents/build/pom.xml index 9d2f5c728a9..d848ab1f42e 100644 --- a/build/parents/build/pom.xml +++ b/build/parents/build/pom.xml @@ -24,7 +24,7 @@ 3.6.1.Final 3.0.4.Final - https://docs.jboss.org/hibernate/search/${parsed-version.org.hibernate.search.majorVersion}.${parsed-version.org.hibernate.search.minorVersion}/api/ + https://docs.hibernate.org/search/${parsed-version.org.hibernate.search.majorVersion}.${parsed-version.org.hibernate.search.minorVersion}/api/ @@ -105,8 +105,8 @@ --> 7.2.0.CR2 - https://docs.jboss.org/hibernate/orm/${parsed-version.org.hibernate.orm.majorVersion}.${parsed-version.org.hibernate.orm.minorVersion}/javadocs/ - https://docs.jboss.org/hibernate/orm/${parsed-version.org.hibernate.orm.majorVersion}.${parsed-version.org.hibernate.orm.minorVersion}/userguide/html_single/Hibernate_User_Guide.html + https://docs.hibernate.org/orm/${parsed-version.org.hibernate.orm.majorVersion}.${parsed-version.org.hibernate.orm.minorVersion}/javadocs/ + https://docs.hibernate.org/orm/${parsed-version.org.hibernate.orm.majorVersion}.${parsed-version.org.hibernate.orm.minorVersion}/userguide/html_single/Hibernate_User_Guide.html +