Skip to content

CAMEL-24422: docs - add the camel-docling input-source note to the 4.22 and 4.18 upgrade guides - #26013

Open
oscerd wants to merge 1 commit into
apache:mainfrom
oscerd:doc/CAMEL-24422-guide-sync-4_22
Open

CAMEL-24422: docs - add the camel-docling input-source note to the 4.22 and 4.18 upgrade guides#26013
oscerd wants to merge 1 commit into
apache:mainfrom
oscerd:doc/CAMEL-24422-guide-sync-4_22

Conversation

@oscerd

@oscerd oscerd commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Why

The camel-docling input-source change shipped on three lines — 4.23.0, and by backport 4.22.1 (#25733) and 4.18.5 (#25744) — but only camel-4x-upgrade-guide-4_23.adoc carried the migration note.

The upgrade guides for every release line live on main, and backports deliberately carry no guide edit, so the note has to be added here for the other two lines. Without it, 4.22.1 and 4.18.5 ship a changed default with nothing in their own upgrade sections.

What

Adds the same note to:

  • camel-4x-upgrade-guide-4_22.adocUpgrading from 4.22.0 to 4.22.1
  • camel-4x-upgrade-guide-4_18.adocUpgrading from 4.18.4 to 4.18.5

Documentation only, purely additive (60 insertions, 0 deletions).

Wording is verbatim on purpose

Guide notes should be worded per line, since what is true on one branch may not hold on another. I checked each claim against camel-4.18.x — the weakest of the three, where the backport was materially adapted — and all of them hold there: allowUrlSource, allowFilePathSource, inputBaseDirectory, containBatchPaths and the File not found failure are all present.

The two ways 4.18.x genuinely differs — the chunking operations are absent, and the security = "insecure:dev" marker was stripped because that branch's @UriParam has no such attribute — are not user-facing behaviour and are not mentioned in the note, so the same text is accurate for all three lines.

…22 and 4.18 upgrade guides

The camel-docling change shipped on three lines - 4.23.0, and by backport
4.22.1 and 4.18.5 - but only the 4_23 guide carried the note. The guides for
every line live on main, so the 4.22.1 and 4.18.5 sections were missing a
migration note for a changed default that affects them.

Adds the same note to the "Upgrading from 4.22.0 to 4.22.1" and "Upgrading
from 4.18.4 to 4.18.5" sections. The text applies verbatim to both lines:
allowUrlSource, allowFilePathSource, inputBaseDirectory, the ungated header
and typed bodies, the batch path containment and the File not found failure
all behave the same there as on main.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
@github-actions github-actions Bot added the docs label Sep 1, 2026
@github-actions

github-actions Bot commented Sep 1, 2026

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.

@gnodet gnodet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Clean documentation PR that adds the camel-docling input-source migration note (already present in the 4.23 guide) to the 4.22 and 4.18 upgrade guides on main. Text is verbatim from the existing note, correctly placed, and follows all AsciiDoc conventions.

Observations:

  • Added text is character-for-character identical to the existing note in camel-4x-upgrade-guide-4_23.adoc, confirming consistency across all three upgrade guides
  • Placement is correct: sections sit under the appropriate version upgrade headings
  • PR description is thorough — explains why the verbatim wording is accurate even for the 4.18 line (the weakest backport)

📋 PR Metadata

Aspect Current Suggested
Milestone (none) 4.23.0

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of Guillaume Nodet

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

🧪 CI tested the following changed modules:

  • docs

🔬 Scalpel shadow comparison — Scalpel: 1 tested, 0 compile-only — current: 0 all tested

Maveniverse Scalpel detected 1 affected modules (current approach: 0).

⚠️ Modules only in Scalpel (1)
  • docs

Skip-tests mode would test 1 modules (1 direct + 0 downstream), skip tests for 0 (generated code, meta-modules)

Modules Scalpel would test (1)
  • docs

ℹ️ Shadow mode — Scalpel observes but does not affect test execution. Learn more


⚙️ View full build and test results

@oscerd oscerd self-assigned this Sep 2, 2026
@oscerd oscerd added this to the 4.23.0 milestone Sep 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants