This is an automated email from the ASF dual-hosted git repository.
oscerd pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 74a1c62c65c9 CAMEL-23510: flag camel-jgroups header rename as a
potential breaking change in 4.21 upgrade guide (#23451)
74a1c62c65c9 is described below
commit 74a1c62c65c9f308123f6fecd816e231cd6b81ca
Author: Andrea Cosentino <[email protected]>
AuthorDate: Fri May 22 11:31:07 2026 +0200
CAMEL-23510: flag camel-jgroups header rename as a potential breaking
change in 4.21 upgrade guide (#23451)
PR #23209 renamed the JGroups header constant string values and added a
4.21 upgrade-guide entry. @apupier pointed out (on the 4.14 doc-sync PR
#23422) that the entry does not explicitly call out that the rename is a
breaking change for routes that read or write these headers by their
literal string value.
Update the 4.21 guide entry to:
- Suffix the section heading with " - potential breaking change", which
is the established convention in the upgrade guides (e.g. the
=-= camel-grok - potential breaking change=- heading earlier in the
same guide).
- Lead the post-table prose with an explicit "This is a breaking change
for routes that ..." sentence, before the existing symbolic-vs-literal
guidance.
Keeps the 4.21 entry consistent with the equivalent wording change made
to the 4.14 guide on camel-4.14.x. No code changes; docs only.
Signed-off-by: Andrea Cosentino <[email protected]>
---
.../modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc
b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc
index 7ba0baf2cee0..f04d62c0afaa 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc
@@ -391,7 +391,7 @@ previous code path silently produced `null` whenever a
route mixed `converse` an
calls. If you were not setting the guardrail identifier via header, the
endpoint-level
`guardrailIdentifier` option continues to work without changes.
-=== camel-jgroups
+=== camel-jgroups - potential breaking change
The Exchange header constants in `JGroupsConstants` have been renamed to follow
the Camel naming convention used across the rest of the component catalog. The
@@ -406,11 +406,12 @@ Java field names are unchanged; only the header string
values have changed:
| `JGroupsConstants.HEADER_JGROUPS_ORIGINAL_MESSAGE` |
`JGROUPS_ORIGINAL_MESSAGE` | `CamelJGroupsOriginalMessage`
|===
-Routes that reference the constant symbolically (for example
-`setHeader(JGroupsConstants.HEADER_JGROUPS_DEST, ...)`) continue to work
-without changes. Routes that set the header by its literal string value
-(for example `setHeader("JGROUPS_DEST", ...)`) must be updated to use the
-new value (`setHeader("CamelJGroupsDest", ...)`).
+This is a breaking change for routes that read or write these headers by
+their literal string value. Routes that reference the constant symbolically
+(for example `setHeader(JGroupsConstants.HEADER_JGROUPS_DEST, ...)`) continue
+to work without changes. Routes that set the header by its literal string
+value (for example `setHeader("JGROUPS_DEST", ...)`) must be updated to use
+the new value (`setHeader("CamelJGroupsDest", ...)`).
=== camel-elasticsearch-rest-client
