Skip to content

CAMEL-24228: Clarify upgrade guide is for migration only, not new features - #25159

Merged
gnodet merged 1 commit into
apache:mainfrom
gnodet:investigate-and-fix-camel-24228-agents-md-do-no
Jul 27, 2026
Merged

CAMEL-24228: Clarify upgrade guide is for migration only, not new features#25159
gnodet merged 1 commit into
apache:mainfrom
gnodet:investigate-and-fix-camel-24228-agents-md-do-no

Conversation

@gnodet

@gnodet gnodet commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Claude Code on behalf of gnodet

Summary

Fixes the overly broad wording in the Code Quality section of AGENTS.md (and CLAUDE.md which symlinks to it) that stated "Any user-visible change must be documented in the upgrade guide." This incorrectly suggested that new features should be added to the upgrade guide.

What changed

  • Before: "Any user-visible change must be documented in the upgrade guide (...) and in the relevant command or component documentation page."
  • After: Separates the guidance into two clear directives:
    1. New features → document in the relevant component/command docs page
    2. Migration-affecting changes (changed defaults, removed/renamed options, API/SPI changes, deprecations, etc.) → document in the upgrade guide
  • Adds an explicit statement: "The upgrade guide is for migration only — do NOT add new features to it."

What stays the same

  • The list of migration-relevant changes (changed defaults, renamed options, API changes, etc.) is preserved
  • The backport guidance ("upgrade guide entry must be on main branch") is unchanged
  • The Deprecation section (line 552) correctly references the upgrade guide and is unchanged
  • The Security checklist (line 474) correctly references upgrade-guide for relaxed defaults and is unchanged

Test plan

  • Verified CLAUDE.md is a symlink to AGENTS.md — only one file needs editing
  • Verified the diff only touches the Code Quality section
  • Cross-checked the remaining upgrade-guide references (Deprecation section, Security checklist) are correct and untouched
  • Verified the change aligns with the actual upgrade guide content (camel-4x-upgrade-guide-4_9.adoc documents API changes, renamed constants, changed behavior — not new features)

🤖 Generated with Claude Code

…tures

The Code Quality section previously stated "Any user-visible change must
be documented in the upgrade guide" which incorrectly suggested new
features should be added to the upgrade guide. The upgrade guide is only
for changes that affect existing users upgrading (changed defaults,
removed/renamed options, API changes, deprecations, etc.). New features
should be documented in component/command docs and release notes only.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gnodet
gnodet marked this pull request as ready for review July 27, 2026 14:23
@gnodet
gnodet requested review from apupier, davsclaus and oscerd July 27, 2026 14:23
@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 Jul 27, 2026
@gnodet gnodet added this to the 4.22.0 milestone Jul 27, 2026
@gnodet gnodet self-assigned this Jul 27, 2026
@gnodet gnodet added the task label Jul 27, 2026
@gnodet
gnodet merged commit 492ba8b into apache:main Jul 27, 2026
3 checks passed
@gnodet
gnodet deleted the investigate-and-fix-camel-24228-agents-md-do-no branch July 27, 2026 18:57
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.

2 participants