This is an automated email from the ASF dual-hosted git repository. orpiske pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git
commit 06128540b24146263361ed9557dd3a0ec4278f09 Author: Otavio Rodolfo Piske <angusyo...@gmail.com> AuthorDate: Wed Sep 4 14:42:51 2024 +0200 CAMEL-21066: removed karaf information from development docs --- .../modules/ROOT/pages/release-guide-website.adoc | 16 +-- .../modules/ROOT/pages/release-guide.adoc | 134 +-------------------- 2 files changed, 4 insertions(+), 146 deletions(-) diff --git a/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc b/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc index 1f214dc0de7..0b08a95c9c8 100644 --- a/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc +++ b/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc @@ -5,7 +5,7 @@ There are several cases: * A single repository release, such as `camel-kafka-connector`. * A set of separately versioned repositories, such as `camel-k`, `camel-k-runtime`, and `camel-kamelets`. -* The set of main `camel`, `camel-spring-boot`, and `camel-karaf` which are versioned together. +* The set of main `camel` and `camel-spring-boot` which are versioned together. Changes in the content repositories may be done as part of release preparation, or later. Changes in the `camel-website` `antora-playbook.yml` can be supplied in a PR at any time but should be merged only after the release is voted on and approved. @@ -100,20 +100,6 @@ Note that your `camel-website` PR will definitely need to be merged after removi === Notes for specific projects -==== camel-karaf - -In `camel-karaf:tooling/camel-karaf-docs-maven-plugin/src/main/java/org/apache/camel/karaf/maven/ExtMvelHelper.java`:: - -change -+ -[source,java] -private final static String CAMEL_VERSION = "next";` -+ -to e.g. -+ -[source,java] -private final static String CAMEL_VERSION = "3.13.x"; - ==== camel-quarkus Many of the versions in the `antora.yml` component descriptor are set by the maven build from `pom.xml` properties. diff --git a/docs/user-manual/modules/ROOT/pages/release-guide.adoc b/docs/user-manual/modules/ROOT/pages/release-guide.adoc index 8328e9aeec8..92f8c373198 100644 --- a/docs/user-manual/modules/ROOT/pages/release-guide.adoc +++ b/docs/user-manual/modules/ROOT/pages/release-guide.adoc @@ -256,96 +256,6 @@ your username and ip. Click "Release" on the tool bar above. This will release the artifacts. -[[ReleaseGuide-CreatingTheRelease-Camel-karaf]] -== Creating the Release for camel-karaf - -Complete the following steps to create a new Camel-karaf release: - -. Grab the latest source from Git and checkout the target branch (`BRANCH_NAME`) to build from: - - $ git clone https://git-wip-us.apache.org/repos/asf/camel-karaf.git - $ cd camel - $ git checkout BRANCH_NAME - -. From Camel 3.3.0 ahead, the camel-karaf project uses camel-dependencies as parent. -You'll need to set the version here https://github.com/apache/camel-karaf/blob/main/pom.xml#L26 -To the version released from the main Camel repository as first step. - -. Perform a license check with http://creadur.apache.org/rat/apache-rat-plugin[Apache Rat]: - - ./mvnw -e org.apache.rat:apache-rat-plugin:check - grep -e ' !?????' target/rat.txt - -* The latter command will provide a list of all files without valid license headers. - Ideally this list is empty, otherwise fix the issues by adding valid license headers and rerun the above commands before - proceeding with the next step. - -. You already have built the main camel repo for releasing, so you already have a final version in your local repository. -Change the camel-version property in https://github.com/apache/camel-karaf/blob/main/pom.xml accordingly and commit. - -. Do a release dry run to check for problems: - - ./mvnw release:prepare -DdryRun -Prelease - - * The release plugin will prompt for a release version, an SCM tag and next release version. - -* Use a three digit release version of the form: `MAJOR.MINOR.PATCH`, e.g. `3.0.0`. - -* For the tag use a string of the form: `camel-MAJOR.MINOR.PATCH`, e.g. `camel-3.0.0`. - -* For the next version increase the patch version and append `-SNAPSHOT`, e.g. `3.0.1-SNAPSHOT`. - -* Make sure to check the generated signature files: - - $ gpg core/camel-core-osgi/target/camel-core-osgi-3.0.0-SNAPSHOT.jar.asc - gpg: assuming signed data in `core/camel-core-osgi/target/camel-core-osgi-3.0.0-SNAPSHOT.jar' - gpg: Signature made Sat 06 Apr 2019 03:58:01 AM PDT using RSA key ID 5942C049 - gpg: Good signature from "Gregor Zurowski <gzurow...@apache.org>" - -. Prepare the release: - -* First clean up the dry run results: - - $ ./mvnw release:clean -Prelease - -* Next prepare the release: - - $ ./mvnw release:prepare -Prelease - -* This command will create the tag and update all pom files with the given version number. - -. Perform the release and publish to the Apache staging repository: - - $ ./mvnw release:perform -Prelease - -. Close the Apache staging repository: - -* Login to https://repository.apache.org using your Apache LDAP credentials. -Click on "Staging Repositories". Then select "org.apache.camel-xxx" in the list of repositories, where xxx represents -your username and ip. -Click "Close" on the tool bar above. -This will close the repository from future deployments and make it available for others to view. -If you are staging multiple releases together, skip this step until you have staged everything. -Enter the name and version of the artifact being released in the "Description" field and then click "Close". -This will make it easier to identify it later. - -. Verify staged artifacts: - -* If you click on your repository, a tree view will appear below. -You can then browse the contents to ensure the artifacts are as you expect them. -Pay particular attention to the existence of *.asc (signature) files. -If the you don't like the content of the repository, right click your repository and choose "Drop". -You can then rollback your release and repeat the process. -Note the repository URL, you will need this in your vote email. - -. Once the release has been voted - -* Login to https://repository.apache.org using your Apache LDAP credentials. -Click on "Staging Repositories". Then select "org.apache.camel-xxx" in the list of repositories, where xxx represents -your username and ip. -Click "Release" on the tool bar above. -This will release the artifacts. - [[ReleaseGuide-PublishingTheRelease-Camel]] == Publishing the Release @@ -395,16 +305,15 @@ This will release the artifacts. [[Publish-xsd-schemas]] == Publish xsd schemas -* On https://github.com/apache/camel-website/tree/main/static/schema the xsd related to blueprint,cxf,spring-security and spring +* On https://github.com/apache/camel-website/tree/main/static/schema the xsd related to cxf,spring-security and spring must be pushed to make them available to end users. -* The blueprint one is under the camel-karaf release [[Tagging-examples]] == Tagging examples These steps are optional and they could be done later too. -Once the release train (camel, camel-karaf and camel-spring-boot) has been voted and published, there are some additional steps needed for the camel examples. +Once the release train (camel and camel-spring-boot) has been voted and published, there are some additional steps needed for the camel examples. . Camel-examples @@ -470,41 +379,4 @@ Once the release train (camel, camel-karaf and camel-spring-boot) has been voted * To be sure everything is fine run - $ ./mvnw clean install - -. Camel-karaf-examples - -* On https://github.com/apache/camel-karaf-examples in the examples/pom.xml file the following steps are needed: - -* Update the camel-dependencies version to the version coming from the release-train - -* Update the camel.version properties to the version coming from the release-train - -* Update the camel.karaf.version properties to the version coming from the release-train - -* To be sure everything is fine run - - $ ./mvnw clean install - -* Commit - - $ git commit -a - $ git push origin master (or the branch related to the release, eg. camel-3.4.x) - $ git tag -a camel-karaf-examples-$version -m "$version" - $ git push origin camel-karaf-examples-$version - -* Now we pushed the tag and we need to advance the version of the examples - -* Update the camel-dependencies version to the next version - -* Update the camel.version properties to the next version - -* Update the camel.karaf.version properties to the next version - -* Run the following command to advance the version in the examples - - $ find . -type f -exec sed -i 's/$oldVersion/$newVersion/g' {} + - -* To be sure everything is fine run - - $ ./mvnw clean install + $ ./mvnw clean install \ No newline at end of file