Skip to content
Open
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
6 changes: 3 additions & 3 deletions build/parents/build/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<version.org.jboss.logging.jboss-logging>3.6.1.Final</version.org.jboss.logging.jboss-logging>
<!--Once the tools version is upgraded see if org.codehaus.plexus can be upgraded as well and update the dependabot config accordingly. -->
<version.org.jboss.logging.jboss-logging-tools>3.0.4.Final</version.org.jboss.logging.jboss-logging-tools>
<javadoc.org.hibernate.search.url>https://docs.jboss.org/hibernate/search/${parsed-version.org.hibernate.search.majorVersion}.${parsed-version.org.hibernate.search.minorVersion}/api/</javadoc.org.hibernate.search.url>
<javadoc.org.hibernate.search.url>https://docs.hibernate.org/search/${parsed-version.org.hibernate.search.majorVersion}.${parsed-version.org.hibernate.search.minorVersion}/api/</javadoc.org.hibernate.search.url>

<!-- >>> Engine -->
<!-- Nothing beyond common dependencies -->
Expand Down Expand Up @@ -105,8 +105,8 @@
-->
<version.org.hibernate.orm>7.2.0.CR2</version.org.hibernate.orm>

<javadoc.org.hibernate.orm.url>https://docs.jboss.org/hibernate/orm/${parsed-version.org.hibernate.orm.majorVersion}.${parsed-version.org.hibernate.orm.minorVersion}/javadocs/</javadoc.org.hibernate.orm.url>
<documentation.org.hibernate.orm.url>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</documentation.org.hibernate.orm.url>
<javadoc.org.hibernate.orm.url>https://docs.hibernate.org/orm/${parsed-version.org.hibernate.orm.majorVersion}.${parsed-version.org.hibernate.orm.minorVersion}/javadocs/</javadoc.org.hibernate.orm.url>
<documentation.org.hibernate.orm.url>https://docs.hibernate.org/orm/${parsed-version.org.hibernate.orm.majorVersion}.${parsed-version.org.hibernate.orm.minorVersion}/userguide/html_single/Hibernate_User_Guide.html</documentation.org.hibernate.orm.url>
<!-- These version must be kept in sync with the version of the dependency in Hibernate ORM 7.
DO NOT USE DEPENDENCY MANAGEMENT FOR THESE DEPENDENCIES!
Thanks to not using dependency management for these dependencies, we get a build failure
Expand Down
2 changes: 2 additions & 0 deletions ci/release/Jenkinsfile
Original file line number Diff line number Diff line change
Expand Up @@ -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()}
"""
}
Expand Down
4 changes: 2 additions & 2 deletions documentation/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -438,8 +438,8 @@
<hibernateSearchVersionShort>${parsed-version.org.hibernate.search.majorVersion}.${parsed-version.org.hibernate.search.minorVersion}</hibernateSearchVersionShort>
<hibernateSearchPreviousStableVersionShort>${parsed-version.org.hibernate.search.previous-stable.majorVersion}.${parsed-version.org.hibernate.search.previous-stable.minorVersion}</hibernateSearchPreviousStableVersionShort>
<hibernateSearchJavadocUrl>${javadoc.org.hibernate.search.url}</hibernateSearchJavadocUrl>
<hibernateSearchDocUrl>https://docs.jboss.org/hibernate/search/${parsed-version.org.hibernate.search.majorVersion}.${parsed-version.org.hibernate.search.minorVersion}/reference/en-US/html_single/</hibernateSearchDocUrl>
<hibernateSearchPreviousStableDocUrl>https://docs.jboss.org/hibernate/search/${parsed-version.org.hibernate.search.previous-stable.majorVersion}.${parsed-version.org.hibernate.search.previous-stable.minorVersion}/reference/en-US/html_single/</hibernateSearchPreviousStableDocUrl>
<hibernateSearchDocUrl>https://docs.hibernate.org/search/${parsed-version.org.hibernate.search.majorVersion}.${parsed-version.org.hibernate.search.minorVersion}/reference/en-US/html_single/</hibernateSearchDocUrl>
<hibernateSearchPreviousStableDocUrl>https://docs.hibernate.org/search/${parsed-version.org.hibernate.search.previous-stable.majorVersion}.${parsed-version.org.hibernate.search.previous-stable.minorVersion}/reference/en-US/html_single/</hibernateSearchPreviousStableDocUrl>
<hibernateSearchJiraUrl>https://hibernate.atlassian.net/browse</hibernateSearchJiraUrl>
<hibernateSearchMigrationGuidesIndexUrl>https://hibernate.org/search/documentation/migrate/</hibernateSearchMigrationGuidesIndexUrl>
<hibernateCommunityUrl>https://hibernate.org/community</hibernateCommunityUrl>
Expand Down
2 changes: 1 addition & 1 deletion documentation/src/main/asciidoc/internals/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
:title-logo-image: image:hibernate_logo_a.png[align=left,pdfwidth=33%]
:html-meta-description: Hibernate Search, full text search for your entities - Internals of Hibernate Search
:html-meta-keywords: hibernate, search, hibernate search, full text, lucene, elasticsearch, opensearch
:html-meta-canonical-link: https://docs.jboss.org/hibernate/stable/search/internals/html_single/
:html-meta-canonical-link: https://docs.hibernate.org/stable/search/internals/html_single/
:html-meta-version-family: {hibernateSearchVersionShort}

This section is intended for new Hibernate Search contributors looking for an introduction
Expand Down
6 changes: 3 additions & 3 deletions documentation/src/main/asciidoc/migration/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
:title-logo-image: image:hibernate_logo_a.png[align=left,pdfwidth=33%]
:html-meta-description: Hibernate Search, full text search for your entities - Migration Guide
:html-meta-keywords: hibernate, search, hibernate search, full text, lucene, elasticsearch, opensearch
:html-meta-canonical-link: https://docs.jboss.org/hibernate/search/{hibernateSearchVersionShort}/migration/html_single/
:html-meta-canonical-link: https://docs.hibernate.org/search/{hibernateSearchVersionShort}/migration/html_single/
:html-meta-version-family: {hibernateSearchVersionShort}

[[introduction]]
Expand All @@ -37,7 +37,7 @@ others because of more fundamental changes
(like moving away from using Lucene types in Hibernate Search APIs).

When migrating from Hibernate Search 5, you are encouraged to migrate first to Hibernate Search 6.0
using the https://docs.jboss.org/hibernate/search/6.0/migration/html_single/[6.0 migration guide],
using the https://docs.hibernate.org/search/6.0/migration/html_single/[6.0 migration guide],
and only then to later versions (which will be significantly easier).
====

Expand Down Expand Up @@ -76,7 +76,7 @@ older indexes can be read from and written to without reindexing.
=== Outbox polling database tables

The event and agent database tables used for
link:https://docs.jboss.org/hibernate/search/{hibernateSearchVersionShort}/reference/en-US/html_single/#coordination-database-polling[outbox-polling]
link:https://docs.hibernate.org/search/{hibernateSearchVersionShort}/reference/en-US/html_single/#coordination-database-polling[outbox-polling]
in Hibernate Search {hibernateSearchVersion}
are backward-compatible with Hibernate Search {hibernateSearchPreviousStableVersionShort}:
no database schema update is necessary for these tables.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
:title-logo-image: image:hibernate_logo_a.png[align=left,pdfwidth=33%]
:html-meta-description: Hibernate Search, full text search for your entities - Getting Started Guides
:html-meta-keywords: hibernate, search, hibernate search, full text, lucene, elasticsearch, opensearch
:html-meta-canonical-link: https://docs.jboss.org/hibernate/stable/search/getting-started/en-US/html_single/
:html-meta-canonical-link: https://docs.hibernate.org/stable/search/getting-started/en-US/html_single/
:html-meta-version-family: {hibernateSearchVersionShort}

:relfileprefix: ../../
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
:title-logo-image: image:hibernate_logo_a.png[align=left,pdfwidth=33%]
:html-meta-description: Hibernate Search, full text search for your entities - Getting started with Hibernate Search in Hibernate ORM
:html-meta-keywords: hibernate, search, hibernate search, full text, lucene, elasticsearch, opensearch
:html-meta-canonical-link: https://docs.jboss.org/hibernate/stable/search/getting-started/orm/en-US/html_single/
:html-meta-canonical-link: https://docs.hibernate.org/stable/search/getting-started/orm/en-US/html_single/
:html-meta-version-family: {hibernateSearchVersionShort}

:relfileprefix: ../../
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
:title-logo-image: image:hibernate_logo_a.png[align=left,pdfwidth=33%]
:html-meta-description: Hibernate Search, full text search for your entities - Getting started with Hibernate Search’s Standalone POJO Mapper
:html-meta-keywords: hibernate, search, hibernate search, full text, lucene, elasticsearch, opensearch
:html-meta-canonical-link: https://docs.jboss.org/hibernate/stable/search/getting-started/standalone/en-US/html_single/
:html-meta-canonical-link: https://docs.hibernate.org/stable/search/getting-started/standalone/en-US/html_single/
:html-meta-version-family: {hibernateSearchVersionShort}

:relfileprefix: ../../
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ Additionally, be aware that a lot of APIs have changed, some only because of a p
others because of more fundamental changes
(like moving away from using Lucene types in Hibernate Search APIs).
For that reason, you are encouraged to migrate first to Hibernate Search 6.0
using the https://docs.jboss.org/hibernate/search/6.0/migration/html_single/[6.0 migration guide],
using the https://docs.hibernate.org/search/6.0/migration/html_single/[6.0 migration guide],
and only then to later versions (which will be significantly easier).
====
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
: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/
:html-meta-canonical-link: https://docs.hibernate.org/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
Expand Down
81 changes: 81 additions & 0 deletions documentation/src/main/asciidoc/public/whats-new/index.adoc
Original file line number Diff line number Diff line change
@@ -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.hibernate.org/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.
3 changes: 3 additions & 0 deletions github_release_notes.md
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<id name="id" type="integer"/>
<property name="author" type="string"/>
<property name="content" type="string"/>
<!-- https://docs.jboss.org/hibernate/orm/4.3/manual/en-US/html_single/#assoc-bidirectional-121 -->
<!-- https://docs.hibernate.org/orm/4.3/manual/en-US/html_single/#assoc-bidirectional-121 -->
<many-to-one name="book" entity-name="Book" unique="true" />
</class>
</hibernate-mapping>