This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new bb02286bc20 Involve upgrade recipe tool in the upgrade guide (#19010)
bb02286bc20 is described below
commit bb02286bc2054eace7399a52d88f75458dd99613
Author: JiriOndrusek <[email protected]>
AuthorDate: Wed Aug 27 12:39:23 2025 +0200
Involve upgrade recipe tool in the upgrade guide (#19010)
---
.../modules/ROOT/pages/camel-4x-upgrade-guide.adoc | 5 ++++
.../ROOT/pages/camel-upgrade-recipes-tool.adoc | 28 ++++++++++++++++++++++
2 files changed, 33 insertions(+)
diff --git a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide.adoc
b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide.adoc
index 887826ed135..d75c4be0d53 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide.adoc
@@ -24,3 +24,8 @@ You can find the upgrade guide for each release in the
following pages:
- xref:camel-4x-upgrade-guide-4_13.adoc[Upgrade guide 4.12 -> 4.13]
- xref:camel-4x-upgrade-guide-4_14.adoc[Upgrade guide 4.13 -> 4.14]
- xref:camel-4x-upgrade-guide-4_15.adoc[Upgrade guide 4.14 -> 4.15]
+
+
+https://github.com/apache/camel-upgrade-recipes/[The Camel Upgrade Recipes
project] provides automated assistance for some common migration tasks.
+Note that manual migration is still required.
+See the xref:camel-upgrade-recipes-tool.adoc[documentation] page for details.
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-upgrade-recipes-tool.adoc
b/docs/user-manual/modules/ROOT/pages/camel-upgrade-recipes-tool.adoc
new file mode 100644
index 00000000000..5ce99b1c853
--- /dev/null
+++ b/docs/user-manual/modules/ROOT/pages/camel-upgrade-recipes-tool.adoc
@@ -0,0 +1,28 @@
+= Apache Camel Upgrade Recipes Project
+
+This document provides instructions on how to use the automatic update tool to
assist in the migration process.
+
+== Introduction
+
+To help with migration process, Camel Upgrade Recipes project based on
OpenRewrite was developed.
+
+NOTE: The project is not designed to provide fully automated migration but
rather to assist with manual migrations, making them more efficient and less
error-prone.
+
+Refer to the
https://github.com/apache/camel-upgrade-recipes/blob/main/release_notes.adoc[release
notes] of the Camel Upgrade Recipes Project to see the specific migrations
covered by the upgrade tool.
+
+== Running the Upgrade Tool
+
+The migration tool is easy to run.
+To upgrade to the latest version of Camel, you can either execute the
following script:
+
+[source,bash]
+----
+$ mvn -U org.openrewrite.maven:rewrite-maven-plugin:run
-Drewrite.recipeArtifactCoordinates=org.apache.camel.upgrade:camel-upgrade-recipes:LATEST
-Drewrite.activeRecipes=org.apache.camel.upgrade.CamelMigrationRecipe
+----
+
+or use camel-jbang
https://camel.apache.org/manual/camel-jbang.html#_update[update] action:
+
+[source,bas]
+----
+$ camel update run $VERSION
+----
\ No newline at end of file
