This is an automated email from the ASF dual-hosted git repository. valdar pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-kafka-connector.git
commit f6cfdb9e6a7ce72447b4483ea60d0711d733f9fa Author: Andrea Tarocchi <[email protected]> AuthorDate: Mon Oct 7 11:19:57 2024 +0200 Updated release documentatio with some automation and added a missing step. --- .gitignore | 1 - .../pages/contributor-guide/release-guide.adoc | 15 +++++++- release-utils/release.sh | 44 ++++++++++++++++++++++ 3 files changed, 58 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index a8498b45c5..6d71b2cd2b 100644 --- a/.gitignore +++ b/.gitignore @@ -309,4 +309,3 @@ tags # End of https://www.gitignore.io/api/java,vim,emacs,visualstudiocode,eclipse,intellij .flattened-pom.xml -/release.exports diff --git a/docs/modules/ROOT/pages/contributor-guide/release-guide.adoc b/docs/modules/ROOT/pages/contributor-guide/release-guide.adoc index 77427edfb6..41bce14b1c 100644 --- a/docs/modules/ROOT/pages/contributor-guide/release-guide.adoc +++ b/docs/modules/ROOT/pages/contributor-guide/release-guide.adoc @@ -70,7 +70,6 @@ Add and commit all the updated json with a commit comment on the line of `"[afte [source,shell] ---- -$ git add *.json $ git checkout $RELEASE_TAG $ git add *.json $ git commit -m"[after release perform chore]: regen catalog descriptors with new version" @@ -92,6 +91,8 @@ If you feel brave, the above two steps could be performed together: $ ./mvnw -Pgpg clean release:clean release:prepare -DreleaseVersion=$RELEASE_VERSION -DdevelopmentVersion=$NEXT_VERSION -B release:perform ---- +TIP: All the steps above have been automated in a script that you can run with `./release-utils/release.sh` . You should input the requested information that are used to fill in the exported variable describe in xref:_export_local_variables_for_convenience section. + In case an issue occurs during `release:perform`, it could be worth trying to resume from the failing artifact. For instance, would an issue occurs while performing the release of `camel-splunk-kafka-connector`, a resume attempt could be triggered as below: @@ -204,6 +205,18 @@ $ ./release-utils/scripts/promote-release.sh $RELEASE_VERSION Create a release note in https://github.com/apache/camel-website/tree/master/content/releases/ckc by coping and changing one of the already present. +== Update Antora playbook + +Add the created release branch to https://github.com/apache/camel-website/blob/main/antora-playbook-snippets/antora-playbook.yml under: + +[source,yaml] +---- + - url: https://github.com/apache/camel-kafka-connector.git + branches: + - main + ... +---- + == Update latest released version Update last released version: diff --git a/release-utils/release.sh b/release-utils/release.sh new file mode 100755 index 0000000000..ce79c57c4a --- /dev/null +++ b/release-utils/release.sh @@ -0,0 +1,44 @@ +#!/bin/bash + +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +prefix=camel-kafka-connector- + +read -p "Enter release version: " releaseV +export RELEASE_VERSION=$releaseV +releaseVbranch="${releaseV%.*}.x" + +read -p "Enter next version: " nextV +export NEXT_VERSION=$nextV + +defaultReleaseBranch=$prefix$releaseVbranch +read -p "Enter release branch [$defaultReleaseBranch]: " releaseBranch +export RELEASE_BRANCH=${releaseBranch:-$defaultReleaseBranch} + +defaultReleaseTag=$prefix$releaseV +read -p "Enter release tag: [$defaultReleaseTag]" releaseTag +export RELEASE_TAG=${releaseTag:-$defaultReleaseTag} + +read -p "Enter apache username: " user +export APACHE_USER=$user + +read -p "Enter apache password: " pass +export APACHE_PASS=$pass + +git checkout -b $RELEASE_BRANCH && \ +./mvnw -Prelease -Pgpg -DreleaseVersion=$RELEASE_VERSION -DdevelopmentVersion=$NEXT_VERSION -Dtag=$RELEASE_TAG -Dusername=$APACHE_USER -Dpassword=$APACHE_PASS release:prepare && \ +git checkout $RELEASE_TAG && git add *.json && git commit -m"[after release perform chore]: regen catalog descriptors with new version" && git tag -f $RELEASE_TAG && git push -f upstream $RELEASE_TAG && git checkout $RELEASE_BRANCH && \ +./mvnw -Prelease -Pgpg -Dusername=$APACHE_USER -Dpassword=$APACHE_PASS release:perform
