Apache Camel Quarkus release process

When releasing after a recent Quarkus release, check for new releases of third party Quarkus extensions we depend on. They are listed in the Primary dependencies section of the top level pom.xml. If there are new releases, upgrade the versions accordingly and run mvn cq:sync-versions -N from the root directory of the source tree.

Close the GitHub release milestone and assign any remaining issues that aren’t covered by the release to the next milestone

First find out from the console output, in which module the release:perform task failed. Say that there was an upload timeout in camel-quarkus-openapi-java module.

Then locate the directory mvn release:perform used for checking out the tag and running the deploy goal. It is usually <root_of_the_project>/target/checkout:

$ cd target/checkout

And finally resume the deploy build as follows:

$ mvn deploy -Papache-release -DskipTests -Denforcer.skip -Dquarkus.build.skip -Dformatter.skip -Dimpsort.skip -Dskip.installyarn -Dskip.yarn -rf :camel-quarkus-openapi-java

Login to the Apache staging repository using your Apache LDAP credentials.

Click on Staging Repositories

Then select org.apache.camel-quarkus-xxx in the list of repositories, where xxx represents your username and ip

Click Close on the toolbar above

This will close the repository from future deployments and make it available for others to view

After that, a popup window is created, enter the name and version of the artifact being released in the Description field and finally click Close

Specify the camel-quarkus staging repository url, e.g. when doing the release from a machine and checking regression from another

Specify the camel staging repository url, e.g. when the camel release is still under vote

Perform regression tests in JVM mode only, e.g. on machine where quarkus.native.container-build could not be used

Run longer tests, e.g. to confirm that a potential regression detected with 10 minutes long scenarios remains with 1h long scenarios

Run shorter tests, e.g. to have quick feedback when trying to tune the perf-regression tool options

Login to the Apache staging repository using your Apache LDAP credentials.

Click on Staging Repositories

Then select org.apache.camel-quarkus-xxx in the list of repositories, where xxx represents your username and ip

Click Release on the toolbar above

This will release the repository and make artifacts generally available

After that, a popup window is created, click Close

Clone Quarkus Platform unless you have done it in the past

$ git clone git@github.com:quarkusio/quarkus-platform.git

Change camel-quarkus.version property in the Quarkus platform top level pom.xml to the newly released version:

$ cd quarkus-platform
$ export NEW_VERSION=... # the version you just released, e.g. 0.1.0
$ sed -i "s|<camel-quarkus.version>[^<]*</camel-quarkus.version>|<camel-quarkus.version>$NEW_VERSION</camel-quarkus.version>|" pom.xml
# Make sure that it worked
$ git status

Re-generate the BOMs

$ ./mvnw clean install -DskipTests
# ^ This will take a couple of minutes because it resolves
# every single dependency of every single extension included
# in the platform
#
# double check files are well formatted
$ ./mvnw -Dsync


# Then commit the generated changes
$ git add -A
$ git commit -m "Upgrade to Camel Quarkus $NEW_VERSION"

Run Camel Quarkus integration tests at least in JVM mode:

cd generated-platform-project/quarkus-camel/integration-tests
mvn clean test

If all tests are passing, send a pull request to the Platform. If there are some new features, fixes, etc. in the release that would be worth to mention in the upcoming Quarkus announcement, you can tag the pull request with release/noteworthy-feature label and provide a short text about those features in the PR description.

Go to https://github.com/apache/camel-quarkus/releases.

Click the tag you want to promote to a GitHub release

Click "Edit Tag" button

In the "New release" form:

Leave "Release title" empty

Choose the tag of the previous release from the "Previous tag" select field

Click the "Generate release notes" button. It should generate a summary all changes for the release.

In addition you can add links to blog posts if required. e.g. something like

Check the full [release announcement](https://camel.apache.org/blog/2021/06/camel-quarkus-release-2.0.0/)

Click the green "Publish release" button at the bottom

Make sure all PRs against camel-quarkus-main branch are merged.

Since Camel Quarkus 2.3.0, the examples should use Quarkus Platform BOMs in the main branch. To set it do the following:

$ NEW_PLATFORM_VERSION=... # E.g. 2.2.0.Final
$ git fetch upstream
$ git checkout camel-quarkus-main
$ git reset --hard upstream/camel-quarkus-main
$ mvn org.l2x6.cq:cq-maven-plugin:2.10.0:examples-set-platform -Dcq.quarkus.platform.version=$NEW_PLATFORM_VERSION
$ git add -A
$ git commit -m "Upgrade to Quarkus Platform $NEW_PLATFORM_VERSION"

Make sure that the tests are still passing:

$ ./mvnw-for-each.sh clean verify -Pnative

If everything works for you locally, open a PR to merge camel-quarkus-main to main

Once the PR is merged, tag the main branch with the $NEW_CQ_VERSION:

$ NEW_CQ_VERSION=... # the recent release of Camel Quarkus; e.g. 2.2.0
$ git checkout main
$ git fetch upstream
$ git reset --hard upstream/main
$ ./mvnw-for-each.sh versions:set -DnewVersion=$NEW_CQ_VERSION
# Update version labels in Kubernetes resources
$ ./mvnw process-sources -f file-bindy-ftp/pom.xml
$ git add -A
$ git commit -m "Tag $NEW_CQ_VERSION"
$ git tag $NEW_CQ_VERSION
$ git push upstream main
$ git push upstream $NEW_CQ_VERSION
# Create a maintenance branch for the release unless this is a micro release
$ export BRANCH=$(echo $NEW_CQ_VERSION | sed 's|.[0-9][0-9]*$|.x|')
$ git checkout -b $BRANCH $NEW_CQ_VERSION
$ git push upstream $BRANCH

Prepare the camel-quarkus-main branch for the next development iteration:

$ NEXT_CQ_VERSION=... # The version used in the current Camel Quarkus main branch without the -SNAPSHOT suffix; e.g. 2.3.0
$ git checkout camel-quarkus-main
$ git reset --hard main
$ ./mvnw org.l2x6.cq:cq-maven-plugin:2.10.0:examples-set-platform -Dcq.camel-quarkus.version=${NEXT_CQ_VERSION}-SNAPSHOT -Dcq.newVersion=${NEXT_CQ_VERSION}-SNAPSHOT
# Update version labels in Kubernetes resources
$ ./mvnw process-sources -f file-bindy-ftp/pom.xml
$ git add -A
$ git commit -m "Next is $NEXT_CQ_VERSION"
$ git push upstream camel-quarkus-main --force-with-lease

Create a ticket asking a PMC member to update the Apache Committee Report Helper. The ticket title could be as follow. Release: The Apache Committee Report Helper should be updated by a PMC member as camel-quarkus-X.Y.Z has been released on YYYY-MM-DD.

When writing the release announcement blog post, do not forget to add the release note section in https://github.com/apache/camel-website/tree/main/content/releases/q, and to add the branch for documentation in antora-playbook.yml.