You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "gnodet (via GitHub)" <gi...@apache.org> on 2026/07/27 13:57:35 UTC

[PR] CAMEL-24228: Clarify upgrade guide is for migration only, not new features [camel]

gnodet opened a new pull request, #25159:
URL: https://github.com/apache/camel/pull/25159

   _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
   
   - [x] Verified `CLAUDE.md` is a symlink to `AGENTS.md` — only one file needs editing
   - [x] Verified the diff only touches the Code Quality section
   - [x] Cross-checked the remaining upgrade-guide references (Deprecation section, Security checklist) are correct and untouched
   - [x] 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](https://claude.com/claude-code)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] CAMEL-24228: Clarify upgrade guide is for migration only, not new features [camel]

Posted by "gnodet (via GitHub)" <gi...@apache.org>.
gnodet merged PR #25159:
URL: https://github.com/apache/camel/pull/25159


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] CAMEL-24228: Clarify upgrade guide is for migration only, not new features [camel]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #25159:
URL: https://github.com/apache/camel/pull/25159#issuecomment-5092646494

   :star2: Thank you for your contribution to the Apache Camel project! :star2:
     :robot: CI automation will test this PR automatically.
   
     :camel: 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](https://camel.apache.org/community/team/#committers) have access to the summary.
     
     :warning: Be careful when sharing logs. Review their contents before sharing them publicly.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org