Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gnodet merged 1 commit into from
Jul 27, 2026
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,11 +136,13 @@ When merging a PR, an agent MUST perform the following steps **in order**:

- Every PR must include tests for new functionality or bug fixes.
- Every PR must include documentation updates where applicable.
Any user-visible change must be documented in the upgrade guide
(`docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_XX.adoc`) and in the relevant
command or component documentation page. This includes: changed defaults, new auto-detection
behavior, removed or renamed options, changed header names or values, API/SPI signature changes,
removed or deprecated components, migrated libraries, and renamed documentation pages.
New features must be documented in the relevant command or component documentation page.
Changes that affect existing users upgrading must also be documented in the upgrade guide
(`docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_XX.adoc`). This includes:
changed defaults, new auto-detection behavior, removed or renamed options, changed header
names or values, API/SPI signature changes, removed or deprecated components, migrated
libraries, and renamed documentation pages. The upgrade guide is for migration only — do
NOT add new features to it.
For backported changes, the upgrade guide entry must be added on the `main` branch (not on the
maintenance branch where the fix is backported).
- All code must pass formatting checks (`mvn formatter:format impsort:sort`) before pushing.
Expand Down