Skip to content

CAMEL-23577: docs - add "potential breaking change" suffix to 9 header-rename sub-task entries in the 4.21 upgrade guide#23505

Merged
oscerd merged 1 commit into
apache:mainfrom
oscerd:docs/CAMEL-23577-heading-suffix
May 26, 2026
Merged

CAMEL-23577: docs - add "potential breaking change" suffix to 9 header-rename sub-task entries in the 4.21 upgrade guide#23505
oscerd merged 1 commit into
apache:mainfrom
oscerd:docs/CAMEL-23577-heading-suffix

Conversation

@oscerd
Copy link
Copy Markdown
Contributor

@oscerd oscerd commented May 25, 2026

Summary

Aligns nine CAMEL-23577 sub-task upgrade-guide entries with the convention
established for the camel-jira entry (and used for camel-grok,
camel-jgroups, camel-dns, camel-milo): the heading is suffixed with
- potential breaking change to make it obvious to readers scanning the
upgrade guide that the section describes a header-value rename that may break
routes which set the header by its literal string value.

The 9 originally-merged entries (#23435 web3j · #23438 openstack · #23437 pdf
· #23442 elasticsearch+opensearch · #23454 github2 · #23467 google×5 · #23469
arangodb · #23470 jt400 · #23478 mail) shipped with a plain heading by
oversight; this PR adds the same - potential breaking change suffix that
camel-milo (#23474) shipped with on the same day.

Diff

Pure heading-line edit — no section body content changes:

Before After
=== camel-web3j === camel-web3j - potential breaking change
=== camel-openstack === camel-openstack - potential breaking change
=== camel-pdf === camel-pdf - potential breaking change
=== camel-elasticsearch / camel-opensearch === camel-elasticsearch / camel-opensearch - potential breaking change
=== camel-github2 === camel-github2 - potential breaking change
=== camel-google-functions / camel-google-secret-manager / camel-google-vision / camel-google-text-to-speech / camel-google-speech-to-text (same, suffixed)
=== camel-arangodb === camel-arangodb - potential breaking change
=== camel-jt400 === camel-jt400 - potential breaking change
=== camel-mail === camel-mail - potential breaking change

Total diff: 9 insertions, 9 deletions, one file.

Precedent

Same pattern as the camel-jgroups (#23451) and camel-jira (#23475) follow-up
doc PRs.

Test plan

  • git diff --stat shows only the 4.21 upgrade guide modified
  • Every -/+ line in the diff is a heading line (verified grep of ^[-+][^-+])
  • grep -c "potential breaking change" count goes from 5 → 14 (5 pre-existing + 9 newly added)
  • camel-milo heading is already suffixed and is not touched by this PR

Tracker: CAMEL-23577

Reported by Claude Code on behalf of Andrea Cosentino

…r-rename sub-task entries in the 4.21 upgrade guide

Aligns nine CAMEL-23577 sub-task upgrade-guide entries with the convention
established for the camel-jira entry (and used for camel-grok, camel-jgroups,
camel-dns, camel-milo): the heading is suffixed with `- potential breaking
change` to make it obvious to readers scanning the upgrade guide that the
section describes a header-value rename that may break routes that set the
header by its literal string value.

Headings updated:
- camel-web3j (CAMEL-23578, apache#23435)
- camel-openstack (CAMEL-23580, apache#23438)
- camel-pdf (CAMEL-23579, apache#23437)
- camel-elasticsearch / camel-opensearch (CAMEL-23581, apache#23442)
- camel-github2 (CAMEL-23582, apache#23454)
- camel-google-functions / camel-google-secret-manager / camel-google-vision /
  camel-google-text-to-speech / camel-google-speech-to-text (CAMEL-23583, apache#23467)
- camel-arangodb (CAMEL-23585, apache#23469)
- camel-jt400 (CAMEL-23587, apache#23470)
- camel-mail (CAMEL-23591, apache#23478)

The camel-milo entry (CAMEL-23590, apache#23474) already shipped with the suffix
and is unchanged. No section content changes; only the 9 heading lines are
modified.

Tracker: CAMEL-23577

Reported by Claude Code on behalf of Andrea Cosentino

Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
@oscerd oscerd requested review from davsclaus and gnodet May 25, 2026 09:40
@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

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.

Docs-only consistency fix adding the - potential breaking change suffix to 9 header-rename sub-task entries in the 4.21 upgrade guide that were missing it. Aligns with the pattern already used for other header rename entries.

LGTM.

Claude Code on behalf of Guillaume Nodet

@oscerd oscerd merged commit a11ac9d into apache:main May 26, 2026
7 checks passed
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.

3 participants