tisonkun commented on code in PR #301: URL: https://github.com/apache/pulsar-helm-chart/pull/301#discussion_r998937681
########## RELEASE.md: ########## @@ -0,0 +1,576 @@ +<!-- + 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. +--> +**Table of contents** + +- [Prepare the Apache Pulsar Helm Chart Release Candidate](#prepare-the-apache-pulsar-helm-chart-release-candidate) + - [Prerequisites](#prerequisites) + - [Build Release Notes](#build-release-notes) + - [Build RC artifacts](#build-rc-artifacts) + - [Prepare Vote email on the Apache Pulsar release candidate](#prepare-vote-email-on-the-apache-pulsar-release-candidate) +- [Verify the release candidate by PMCs](#verify-the-release-candidate-by-pmcs) + - [SVN check](#svn-check) + - [Licence check](#licence-check) + - [Signature check](#signature-check) + - [SHA512 sum check](#sha512-sum-check) +- [Verify release candidates by Contributors](#verify-release-candidates-by-contributors) +- [Publish the final release](#publish-the-final-release) + - [Summarize the voting for the release](#summarize-the-voting-for-the-release) + - [Publish release to SVN](#publish-release-to-svn) + - [Publish release tag](#publish-release-tag) + - [Notify developers of release](#notify-developers-of-release) + - [Create release on GitHub](#create-release-on-github) + - [Close the milestone](#close-the-milestone) + - [Announce the release on the community slack](#announce-the-release-on-the-community-slack) + - [Bump chart version in Chart.yaml](#bump-chart-version-in-chartyaml) + - [Remove old releases](#remove-old-releases) + +This document details the steps for releasing the Apache Pulsar Helm Chart. + +# Prepare the Apache Pulsar Helm Chart Release Candidate + +## Prerequisites + +- Helm version >= 3.0.2 +- Helm gpg plugin (one option: https://github.com/technosophos/helm-gpg) + +## Build Release Notes + +Before creating the RC, you need to build and commit the release notes for the release. + +## Build RC artifacts + +The Release Candidate artifacts we vote upon should be the exact ones we vote against, +without any modification than renaming – i.e. the contents of the files must be +the same between voted release candidate and final release. +Because of this the version in the built artifacts that will become the +official Apache releases must not include the rcN suffix. + +- Set environment variables + + ```shell + # Set Version + export VERSION=1.0.1-candidate-1 + export VERSION_WITHOUT_RC=${VERSION%-candidate-*} + + # Set PULSAR_REPO_ROOT to the path of your git repo + export PULSAR_REPO_ROOT=$(pwd) + + # Example after cloning + git clone https://github.com/apache/pulsar-helm-chart.git pulsar + cd pulsar-helm-chart + export PULSAR_REPO_ROOT=$(pwd) + ``` + +- We currently release Helm Chart from `master` branch: + + ```shell + git checkout master + ``` + +- Clean the checkout: the sdist step below will + + ```shell + git clean -fxd + ``` + +- Update Helm Chart version in `Chart.yaml`, example: `version: 1.0.0` (without + the RC tag). Verify that the `appVersion` matches the `values.yaml` versions for Pulsar components. + +- Add and commit the version change. + + ```shell + git add chart + git commit -m "Chart: Bump version to $VERSION_WITHOUT_RC" + ``` + + Note: You will tag this commit, you do not need to open a PR for it. + +- Tag your release + + ```shell + git tag -s pulsar-${VERSION} -m "Apache Pulsar Helm Chart $VERSION" + ``` + +- Tarball the repo + + NOTE: Make sure your checkout is clean at this stage - any untracked or changed files will otherwise be included + in the file produced. + + ```shell + git archive --format=tar.gz ${VERSION} --prefix=pulsar-chart-${VERSION_WITHOUT_RC}/ \ + -o pulsar-chart-${VERSION_WITHOUT_RC}-source.tar.gz chart .rat-excludes + ``` + +- Generate chart binary + + + ```shell + helm package chart --dependency-update + ``` + +- Sign the chart binary + + In the following command, replace the email address with your email address or your KEY ID + so GPG uses the right key to sign the chart. + (If you have not generated a key yet, generate it by following instructions on + http://www.apache.org/dev/openpgp.html#key-gen-generate-key) + + ```shell + helm gpg sign -u <apache_id>@apache.org pulsar-${VERSION_WITHOUT_RC}.tgz + ``` + + Warning: you need the `helm gpg` plugin to sign the chart. It can be found at: https://github.com/technosophos/helm-gpg + + This should also generate a provenance file (Example: `pulsar-1.0.0.tgz.prov`) as described in + https://helm.sh/docs/topics/provenance/, which can be used to verify integrity of the Helm chart. + + Verify the signed chart (with example output shown): + + ```shell + $ helm gpg verify pulsar-${VERSION_WITHOUT_RC}.tgz + gpg: Signature made Thu Jan 6 21:33:35 2022 MST + gpg: using RSA key E1A1E984F55B8F280BD9CBA20BB7163892A2E48E + gpg: Good signature from "Jed Cunningham <[email protected]>" [ultimate] + plugin: Chart SHA verified. sha256:b33eac716e0416a18af89fb4fa1043fcfcf24f9f903cda3912729815213525df + ``` + +- Generate SHA512/ASC + + ```shell + ${PULSAR_REPO_ROOT}/dev/sign.sh pulsar-chart-${VERSION_WITHOUT_RC}-source.tar.gz + ${PULSAR_REPO_ROOT}/dev/sign.sh pulsar-${VERSION_WITHOUT_RC}.tgz + ``` + +- Move the artifacts to ASF dev dist repo, generate convenience `index.yaml` & publish them + + ```shell + # First clone the repo + svn checkout https://dist.apache.org/repos/dist/dev/pulsar pulsar-dist-dev + + # Create new folder for the release + cd pulsar-dist-dev/helm-chart + svn mkdir ${VERSION} + + # Move the artifacts to svn folder + mv ${PULSAR_REPO_ROOT}/pulsar-${VERSION_WITHOUT_RC}.tgz* ${VERSION}/ + mv ${PULSAR_REPO_ROOT}/pulsar-chart-${VERSION_WITHOUT_RC}-source.tar.gz* ${VERSION}/ + cd ${VERSION} + + ###### Generate index.yaml file - Start + # Download the latest index.yaml on Pulsar Website + curl https://pulsar.apache.org/charts/index.yaml --output index.yaml + + # Replace the URLs from "https://downloads.apache.org"; to "https://archive.apache.org"; + # as the downloads.apache.org only contains latest releases. + sed -i 's|https://downloads.apache.org/pulsar/helm-chart/|https://archive.apache.org/dist/pulsar/helm-chart/|' index.yaml Review Comment: Yes. I notice that this command only affects the Apache releases. Than it looks good to me :) ########## RELEASE.md: ########## @@ -0,0 +1,576 @@ +<!-- + 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. +--> +**Table of contents** + +- [Prepare the Apache Pulsar Helm Chart Release Candidate](#prepare-the-apache-pulsar-helm-chart-release-candidate) + - [Prerequisites](#prerequisites) + - [Build Release Notes](#build-release-notes) + - [Build RC artifacts](#build-rc-artifacts) + - [Prepare Vote email on the Apache Pulsar release candidate](#prepare-vote-email-on-the-apache-pulsar-release-candidate) +- [Verify the release candidate by PMCs](#verify-the-release-candidate-by-pmcs) + - [SVN check](#svn-check) + - [Licence check](#licence-check) + - [Signature check](#signature-check) + - [SHA512 sum check](#sha512-sum-check) +- [Verify release candidates by Contributors](#verify-release-candidates-by-contributors) +- [Publish the final release](#publish-the-final-release) + - [Summarize the voting for the release](#summarize-the-voting-for-the-release) + - [Publish release to SVN](#publish-release-to-svn) + - [Publish release tag](#publish-release-tag) + - [Notify developers of release](#notify-developers-of-release) + - [Create release on GitHub](#create-release-on-github) + - [Close the milestone](#close-the-milestone) + - [Announce the release on the community slack](#announce-the-release-on-the-community-slack) + - [Bump chart version in Chart.yaml](#bump-chart-version-in-chartyaml) + - [Remove old releases](#remove-old-releases) + +This document details the steps for releasing the Apache Pulsar Helm Chart. + +# Prepare the Apache Pulsar Helm Chart Release Candidate + +## Prerequisites + +- Helm version >= 3.0.2 +- Helm gpg plugin (one option: https://github.com/technosophos/helm-gpg) + +## Build Release Notes + +Before creating the RC, you need to build and commit the release notes for the release. + +## Build RC artifacts + +The Release Candidate artifacts we vote upon should be the exact ones we vote against, +without any modification than renaming – i.e. the contents of the files must be +the same between voted release candidate and final release. +Because of this the version in the built artifacts that will become the +official Apache releases must not include the rcN suffix. + +- Set environment variables + + ```shell + # Set Version + export VERSION=1.0.1-candidate-1 + export VERSION_WITHOUT_RC=${VERSION%-candidate-*} + + # Set PULSAR_REPO_ROOT to the path of your git repo + export PULSAR_REPO_ROOT=$(pwd) + + # Example after cloning + git clone https://github.com/apache/pulsar-helm-chart.git pulsar + cd pulsar-helm-chart + export PULSAR_REPO_ROOT=$(pwd) + ``` + +- We currently release Helm Chart from `master` branch: + + ```shell + git checkout master + ``` + +- Clean the checkout: the sdist step below will + + ```shell + git clean -fxd + ``` + +- Update Helm Chart version in `Chart.yaml`, example: `version: 1.0.0` (without + the RC tag). Verify that the `appVersion` matches the `values.yaml` versions for Pulsar components. + +- Add and commit the version change. + + ```shell + git add chart + git commit -m "Chart: Bump version to $VERSION_WITHOUT_RC" + ``` + + Note: You will tag this commit, you do not need to open a PR for it. + +- Tag your release + + ```shell + git tag -s pulsar-${VERSION} -m "Apache Pulsar Helm Chart $VERSION" + ``` + +- Tarball the repo + + NOTE: Make sure your checkout is clean at this stage - any untracked or changed files will otherwise be included + in the file produced. + + ```shell + git archive --format=tar.gz ${VERSION} --prefix=pulsar-chart-${VERSION_WITHOUT_RC}/ \ + -o pulsar-chart-${VERSION_WITHOUT_RC}-source.tar.gz chart .rat-excludes + ``` + +- Generate chart binary + + + ```shell + helm package chart --dependency-update + ``` + +- Sign the chart binary + + In the following command, replace the email address with your email address or your KEY ID + so GPG uses the right key to sign the chart. + (If you have not generated a key yet, generate it by following instructions on + http://www.apache.org/dev/openpgp.html#key-gen-generate-key) + + ```shell + helm gpg sign -u <apache_id>@apache.org pulsar-${VERSION_WITHOUT_RC}.tgz + ``` + + Warning: you need the `helm gpg` plugin to sign the chart. It can be found at: https://github.com/technosophos/helm-gpg + + This should also generate a provenance file (Example: `pulsar-1.0.0.tgz.prov`) as described in + https://helm.sh/docs/topics/provenance/, which can be used to verify integrity of the Helm chart. + + Verify the signed chart (with example output shown): + + ```shell + $ helm gpg verify pulsar-${VERSION_WITHOUT_RC}.tgz + gpg: Signature made Thu Jan 6 21:33:35 2022 MST + gpg: using RSA key E1A1E984F55B8F280BD9CBA20BB7163892A2E48E + gpg: Good signature from "Jed Cunningham <[email protected]>" [ultimate] + plugin: Chart SHA verified. sha256:b33eac716e0416a18af89fb4fa1043fcfcf24f9f903cda3912729815213525df + ``` + +- Generate SHA512/ASC + + ```shell + ${PULSAR_REPO_ROOT}/dev/sign.sh pulsar-chart-${VERSION_WITHOUT_RC}-source.tar.gz + ${PULSAR_REPO_ROOT}/dev/sign.sh pulsar-${VERSION_WITHOUT_RC}.tgz + ``` + +- Move the artifacts to ASF dev dist repo, generate convenience `index.yaml` & publish them + + ```shell + # First clone the repo + svn checkout https://dist.apache.org/repos/dist/dev/pulsar pulsar-dist-dev + + # Create new folder for the release + cd pulsar-dist-dev/helm-chart + svn mkdir ${VERSION} + + # Move the artifacts to svn folder + mv ${PULSAR_REPO_ROOT}/pulsar-${VERSION_WITHOUT_RC}.tgz* ${VERSION}/ + mv ${PULSAR_REPO_ROOT}/pulsar-chart-${VERSION_WITHOUT_RC}-source.tar.gz* ${VERSION}/ + cd ${VERSION} + + ###### Generate index.yaml file - Start + # Download the latest index.yaml on Pulsar Website + curl https://pulsar.apache.org/charts/index.yaml --output index.yaml + + # Replace the URLs from "https://downloads.apache.org"; to "https://archive.apache.org"; + # as the downloads.apache.org only contains latest releases. + sed -i 's|https://downloads.apache.org/pulsar/helm-chart/|https://archive.apache.org/dist/pulsar/helm-chart/|' index.yaml Review Comment: Yes. I notice that this command only affects the Apache releases. Then it looks good to me :) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
