Skip to content

CAMEL-23577: doc-sync 4.18.x/4.14.x header-rename upgrade-guide entries to main#23615

Merged
oscerd merged 1 commit into
apache:mainfrom
oscerd:docs/CAMEL-23577-guide-doc-sync
Jun 8, 2026
Merged

CAMEL-23577: doc-sync 4.18.x/4.14.x header-rename upgrade-guide entries to main#23615
oscerd merged 1 commit into
apache:mainfrom
oscerd:docs/CAMEL-23577-guide-doc-sync

Conversation

@oscerd

@oscerd oscerd commented May 29, 2026

Copy link
Copy Markdown
Contributor

Motivation

Per the project's backport-upgrade-guide policy, the camel-4x-upgrade-guide-4_XX.adoc files on main are the canonical history across all release lines. The 2026-05 Exchange-header-constant rename cascade (umbrella CAMEL-23577) was backported to camel-4.18.x and camel-4.14.x, and each backport added its upgrade-guide entry on the respective maintenance branch — but those entries were never mirrored back into the canonical guides on main. As a result main's 4_18 / 4_14 guides were missing the rename family that actually shipped on the LTS branches.

What this PR does

Copies the missing sections verbatim from the maintenance branches into the matching guide files on main, inserted right after the existing === camel-jira section so they group with the rest of the rename family. Documentation only — no code changes.

camel-4x-upgrade-guide-4_18.adoc — 11 sections added:
pdf, arangodb, jt400, mail, github2, elasticsearch / opensearch, google-functions / google-secret-manager, openstack, shiro, web3j, milo

camel-4x-upgrade-guide-4_14.adoc — 8 sections added:
pdf, arangodb, jt400, mail, openstack, shiro, web3j, google-functions / google-secret-manager

Notes:

Verification

  • No conflict markers; no empty sections (every added heading has its full body).
  • Section bodies preserved verbatim from the maintenance branches (e.g. milo 28 lines, es+os 62 lines on 4_18).
  • Sections placed under the correct version heading (== Upgrading from 4.18.1 to 4.18.3 on 4_18; top/current section on 4_14), adjacent to the existing camel-jira rename entry.

Reviewers

@davsclaus @gnodet

🤖 Generated with Claude Code

@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 github-actions Bot added the docs label May 29, 2026
@github-actions

github-actions Bot commented May 29, 2026

Copy link
Copy Markdown
Contributor

🧪 CI tested the following changed modules:

  • docs

⚙️ View full build and test results

@oscerd oscerd force-pushed the docs/CAMEL-23577-guide-doc-sync branch from aa1a03d to 41e850d Compare May 29, 2026 07:31
…es to main

The camel-4x-upgrade-guide-4_XX.adoc files on main act as the canonical
history across all release lines. The 2026-05 Exchange-header-constant
rename cascade (CAMEL-23577) was backported to camel-4.18.x and
camel-4.14.x with the corresponding upgrade-guide entries added on those
maintenance branches, but the matching entries were never mirrored back
into the canonical guides on main, leaving main's 4_18 / 4_14 guides out
of sync with what actually shipped.

This commit copies the missing sections verbatim from the maintenance
branches into the matching guide files on main, inserted immediately
after the existing camel-jira section so they group with the rest of the
rename family.

camel-4x-upgrade-guide-4_18.adoc (11 sections): pdf, arangodb, jt400,
  mail, github2, elasticsearch/opensearch, google-functions/secret-manager,
  openstack, shiro, web3j, milo

camel-4x-upgrade-guide-4_14.adoc (9 sections): pdf, arangodb, jt400, mail,
  elasticsearch/opensearch, google-functions/secret-manager, openstack,
  shiro, web3j

(github2 and milo are intentionally 4.18-only — those components do not
exist on the 4.14.x branch.)

Documentation only; no code changes.

Tracker: CAMEL-23577
Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
@oscerd oscerd force-pushed the docs/CAMEL-23577-guide-doc-sync branch from 41e850d to 7c01136 Compare June 8, 2026 07:31
@oscerd oscerd requested review from davsclaus and gnodet June 8, 2026 07:47
@oscerd oscerd merged commit 2f3acdc into apache:main Jun 8, 2026
6 checks passed
oscerd added a commit that referenced this pull request Jun 8, 2026
The camel-web3j entry in camel-4x-upgrade-guide-4_18.adoc was missing its
opening table delimiter: the section jumped straight from the intro
paragraph to the data rows, with only a closing |=== and no
[options="header"] / |=== / header row. Asciidoctor reports
"table missing leading separator; recovering automatically" and its
table-recovery then cascades into the following tables (solr, cxf, dns)
in the same file.

This was latent on camel-4.18.x because the camel-website Antora
validation only aggregates each repository's main branch, never the
maintenance branches, so the broken table was never exercised. It
surfaced when the 4_18 entries were doc-synced to main (apache/camel
PR #23615), failing that PR's "PR doc validation" check.

The equivalent table is well-formed on main (4_21 guide) and on
camel-4.14.x; only this 4_18 copy lost its opening delimiter during the
web3j 4.18.x backport. This commit restores the three missing lines so
the table renders correctly. Documentation only; no code changes.

Tracker: CAMEL-23577

Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
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