Skip to content

CAMEL-23510: flag camel-jgroups header rename as potential breaking change in 4.18 upgrade guide#23471

Merged
oscerd merged 1 commit into
apache:mainfrom
oscerd:chore/CAMEL-23510-jgroups-breaking-change-4_18-main
May 22, 2026
Merged

CAMEL-23510: flag camel-jgroups header rename as potential breaking change in 4.18 upgrade guide#23471
oscerd merged 1 commit into
apache:mainfrom
oscerd:chore/CAMEL-23510-jgroups-breaking-change-4_18-main

Conversation

@oscerd
Copy link
Copy Markdown
Contributor

@oscerd oscerd commented May 22, 2026

Summary

Follow-up to #23209 (CAMEL-23510) completing the breaking-change labelling across all affected upgrade guides.

The JGroups header constant rename was also backported to camel-4.18.x (#23213) and documented on main's camel-4x-upgrade-guide-4_18.adoc via the doc-sync #23219. Like the 4.14 and 4.21 guides, that entry did not explicitly flag the rename as a breaking change — which @apupier asked for on #23422.

This PR applies the same wording to the 4.18 guide entry.

Changes

  • docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_18.adoc:
    • Heading: === camel-jgroups=== camel-jgroups - potential breaking change (matching the existing === camel-grok - potential breaking change convention).
    • Prose: prepend an explicit "This is a breaking change for routes that read or write these headers by their literal string value." sentence.

No code changes; pure docs update (7 insertions, 6 deletions).

Consistency across all guides

The identical wording now applies to every place the JGroups rename is documented:

Guide Branch PR
4.14 camel-4.14.x #23441
4.14 main #23422 (merged)
4.18 main this PR
4.21 main #23451 (merged)

Note: the 4.18 rename backport (#23213) did not add an entry to camel-4x-upgrade-guide-4_18.adoc on the camel-4.18.x maintenance branch — the 4.18 note lives only on main (added by #23219), consistent with the "upgrade-guide entry on main, not the maintenance branch" convention. So no maintenance-branch change is needed here.

Related

Test plan

  • Docs-only change.
  • Heading style matches the existing === camel-grok - potential breaking change convention.

Claude Code on behalf of Andrea Cosentino

… change in 4.18 upgrade guide

The JGroups header constant rename was also backported to camel-4.18.x
(apache#23213) and documented in the 4.18 upgrade guide on main via the
doc-sync apache#23219. As with the 4.14 and 4.21 guides, that 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.18 guide entry to:

- Suffix the section heading with " - potential breaking change", the
  established convention in the upgrade guides.
- Lead the post-table prose with an explicit "This is a breaking change
  for routes that ..." sentence.

Keeps the 4.18 entry consistent with the equivalent wording on the 4.14
guide (apache#23422 / apache#23441) and the 4.21 guide (apache#23451). No code changes;
docs only.

Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
@oscerd oscerd added the docs label May 22, 2026
@oscerd oscerd requested review from Croway, apupier and davsclaus May 22, 2026 09:50
Copy link
Copy Markdown
Contributor

@gnodet gnodet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. The heading change matches the === camel-grok - potential breaking change convention already established in the 4.21 guide, and the added sentence clearly calls out the breaking-change impact for literal-string-based header references.

The wording is consistent with the already-merged companion PRs (#23422 for 4.14-on-main and #23451 for 4.21).

LGTM.

Claude Code on behalf of Guillaume Nodet

@github-actions
Copy link
Copy Markdown
Contributor

🌟 Thank you for your contribution to the Apache Camel project! 🌟
🤖 CI automation will test this PR automatically.

🐫 Apache Camel Committers, please review the following items:

  • First-time contributors require MANUAL approval for the GitHub Actions to run
  • You can use the command /component-test (camel-)component-name1 (camel-)component-name2.. to request a test from the test bot although they are normally detected and executed by CI.
  • You can label PRs using skip-tests and test-dependents to fine-tune the checks executed by this PR.
  • Build and test logs are available in the summary page. Only Apache Camel committers have access to the summary.

⚠️ Be careful when sharing logs. Review their contents before sharing them publicly.

@github-actions
Copy link
Copy Markdown
Contributor

🧪 CI tested the following changed modules:

  • docs

⚙️ View full build and test results

oscerd added a commit that referenced this pull request May 22, 2026
…hange in 4.14 upgrade guide (#23441)

Follow-up to the camel-4.14.x backport #23421. Addresses @apupier's review
comment on #23422: the JGroups header constant rename is a breaking change
for routes that read or write the headers by their literal string value,
so the 4.14 upgrade-guide entry now says so explicitly.

- Heading suffixed with " - potential breaking change" (matching the
  camel-grok convention).
- Prose leads with an explicit "This is a breaking change for routes that ..."
  sentence.

Docs only; consistent with the same wording on the 4.14 guide on main
(#23422), the 4.18 guide (#23471) and the 4.21 guide (#23451).
@oscerd oscerd merged commit 9d3395e into apache:main May 22, 2026
7 checks passed
@oscerd oscerd deleted the chore/CAMEL-23510-jgroups-breaking-change-4_18-main branch May 22, 2026 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants