apache/pulsar-helm-chart
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve clarity of release instructions

Browse Source 
- use VERSION_RC and VERSION_WITHOUT_RC that are consistent across
  the instructions
This commit is contained in:
Lari Hotari 2023-12-21 10:19:54 +02:00
parent d9630564ac
commit 99380d98d5
1 changed files with 43 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
RELEASE.md
View File

@ -42,8 +42,8 @@ official Apache releases must not include the rcN suffix.
```shell ```shell
# Set Version # Set Version
export VERSION=3.0.0-candidate-1 export VERSION_RC=3.0.0-candidate-1
export VERSION_WITHOUT_RC=${VERSION%-candidate-*} export VERSION_WITHOUT_RC=${VERSION_RC%-candidate-*}
# Clone and set PULSAR_REPO_ROOT # Clone and set PULSAR_REPO_ROOT
git clone https://github.com/apache/pulsar-helm-chart.git pulsar git clone https://github.com/apache/pulsar-helm-chart.git pulsar
@ -78,7 +78,7 @@ official Apache releases must not include the rcN suffix.
- Tag your release - Tag your release
```shell ```shell
git tag -s pulsar-${VERSION} -m "Apache Pulsar Helm Chart $VERSION" git tag -s pulsar-${VERSION_RC} -m "Apache Pulsar Helm Chart $VERSION_RC"
``` ```
- Tarball the repo - Tarball the repo
@ -87,7 +87,7 @@ official Apache releases must not include the rcN suffix.
in the file produced. in the file produced.
```shell ```shell
git archive --format=tar.gz pulsar-${VERSION} --prefix=pulsar-chart-${VERSION_WITHOUT_RC}/ \ git archive --format=tar.gz pulsar-${VERSION_RC} --prefix=pulsar-chart-${VERSION_WITHOUT_RC}/ \
-o pulsar-chart-${VERSION_WITHOUT_RC}-source.tar.gz . -o pulsar-chart-${VERSION_WITHOUT_RC}-source.tar.gz .
``` ```
@ -137,14 +137,14 @@ official Apache releases must not include the rcN suffix.
```shell ```shell
APACHE_USER=<your ASF userid> APACHE_USER=<your ASF userid>
# Create new folder for the release # Create new folder for the release
svn mkdir --username $APACHE_USER -m "Add directory for pulsar-helm-chart $VERSION release" https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/$VERSION svn mkdir --username $APACHE_USER -m "Add directory for pulsar-helm-chart $VERSION_RC release" https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/$VERSION_RC
# checkout the directory # checkout the directory
svn co --username $APACHE_USER https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/$VERSION helm-chart-$VERSION svn co --username $APACHE_USER https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/$VERSION_RC helm-chart-$VERSION_RC
# Move the artifacts to svn folder # Move the artifacts to svn folder
mv ${PULSAR_REPO_ROOT}/pulsar-${VERSION_WITHOUT_RC}.tgz* helm-chart-${VERSION}/ mv ${PULSAR_REPO_ROOT}/pulsar-${VERSION_WITHOUT_RC}.tgz* helm-chart-${VERSION_RC}/
mv ${PULSAR_REPO_ROOT}/pulsar-chart-${VERSION_WITHOUT_RC}-source.tar.gz* helm-chart-${VERSION}/ mv ${PULSAR_REPO_ROOT}/pulsar-chart-${VERSION_WITHOUT_RC}-source.tar.gz* helm-chart-${VERSION_RC}/
cd helm-chart-${VERSION}/ cd helm-chart-${VERSION_RC}/
###### Generate index.yaml file - Start ###### Generate index.yaml file - Start
# Download the latest index.yaml on Pulsar Website # Download the latest index.yaml on Pulsar Website
@ -155,27 +155,27 @@ official Apache releases must not include the rcN suffix.
sed -i 's|https://downloads.apache.org/pulsar/helm-chart/|https://archive.apache.org/dist/pulsar/helm-chart/|' index.yaml sed -i 's|https://downloads.apache.org/pulsar/helm-chart/|https://archive.apache.org/dist/pulsar/helm-chart/|' index.yaml
# Generate / Merge the new version with existing index.yaml # Generate / Merge the new version with existing index.yaml
helm repo index --merge ./index.yaml . --url "https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/${VERSION}" helm repo index --merge ./index.yaml . --url "https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/${VERSION_RC}"
###### Generate index.yaml file - End ###### Generate index.yaml file - End
# Commit the artifacts # Commit the artifacts
svn add * svn add *
svn commit -m "Add artifacts for Helm Chart ${VERSION}" svn commit -m "Add artifacts for Helm Chart ${VERSION_RC}"
``` ```
- Remove old Helm Chart versions from the dev repo - Remove old Helm Chart versions from the dev repo
```shell ```shell
export PREVIOUS_VERSION=3.0.0-candidate-1 export PREVIOUS_VERSION_RC=3.0.0-candidate-1
svn rm --username $APACHE_USER -m "Remove old Helm Chart release: ${PREVIOUS_VERSION}" https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/${PREVIOUS_VERSION} svn rm --username $APACHE_USER -m "Remove old Helm Chart release: ${PREVIOUS_VERSION_RC}" https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/${PREVIOUS_VERSION_RC}
``` ```
- Push Tag for the release candidate - Push Tag for the release candidate
```shell ```shell
cd ${PULSAR_REPO_ROOT} cd ${PULSAR_REPO_ROOT}
git push upstream tag pulsar-${VERSION} git push upstream tag pulsar-${VERSION_RC}
``` ```
## Prepare Vote email on the Apache Pulsar release candidate ## Prepare Vote email on the Apache Pulsar release candidate
@ -186,7 +186,7 @@ Subject:
```shell ```shell
cat <<EOF cat <<EOF
[VOTE] Release Apache Pulsar Helm Chart ${VERSION_WITHOUT_RC} based on ${VERSION} [VOTE] Release Apache Pulsar Helm Chart ${VERSION_WITHOUT_RC} based on ${VERSION_RC}
EOF EOF
``` ```
@ -199,7 +199,7 @@ Hello Apache Pulsar Community,
This is a call for the vote to release the Apache Pulsar Helm Chart version ${VERSION_WITHOUT_RC}. This is a call for the vote to release the Apache Pulsar Helm Chart version ${VERSION_WITHOUT_RC}.
The release candidate is available at: The release candidate is available at:
https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/$VERSION/ https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/$VERSION_RC/
pulsar-chart-${VERSION_WITHOUT_RC}-source.tar.gz - is the "main source release". pulsar-chart-${VERSION_WITHOUT_RC}-source.tar.gz - is the "main source release".
pulsar-${VERSION_WITHOUT_RC}.tgz - is the binary Helm Chart release. pulsar-${VERSION_WITHOUT_RC}.tgz - is the binary Helm Chart release.
@ -208,7 +208,7 @@ Public keys are available at: https://www.apache.org/dist/pulsar/KEYS
For convenience "index.yaml" has been uploaded (though excluded from voting), so you can also run the below commands. For convenience "index.yaml" has been uploaded (though excluded from voting), so you can also run the below commands.
helm repo add apache-pulsar-dist-dev https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/$VERSION/ helm repo add apache-pulsar-dist-dev https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/$VERSION_RC/
helm repo update helm repo update
helm install pulsar apache-pulsar-dist-dev/pulsar --set affinity.anti_affinity=false helm install pulsar apache-pulsar-dist-dev/pulsar --set affinity.anti_affinity=false
@ -367,8 +367,8 @@ Checking pulsar-chart-1.0.0-source.tar.gz.sha512
Contributors can run below commands to test the Helm Chart Contributors can run below commands to test the Helm Chart
```shell ```shell
export VERSION=3.0.0-candidate-1 export VERSION_RC=3.0.0-candidate-1
helm repo add apache-pulsar-dist-dev https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/${VERSION}/ helm repo add apache-pulsar-dist-dev https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/${VERSION_RC}/
helm repo update helm repo update
helm install pulsar apache-pulsar-dist-dev/pulsar --set affinity.anti_affinity=false helm install pulsar apache-pulsar-dist-dev/pulsar --set affinity.anti_affinity=false
``` ```
@ -386,7 +386,7 @@ Subject:
```shell ```shell
cat <<EOF cat <<EOF
[RESULT][VOTE] Release Apache Pulsar Helm Chart ${VERSION_WITHOUT_RC} based on ${VERSION} [RESULT][VOTE] Release Apache Pulsar Helm Chart ${VERSION_WITHOUT_RC} based on ${VERSION_RC}
EOF EOF
``` ```
@ -396,7 +396,7 @@ Message:
cat <<EOF cat <<EOF
Hello all, Hello all,
The vote to release Apache Pulsar Helm Chart version ${VERSION_WITHOUT_RC} based on ${VERSION} is now closed. The vote to release Apache Pulsar Helm Chart version ${VERSION_WITHOUT_RC} based on ${VERSION_RC} is now closed.
The vote PASSED with X binding "+1", Y non-binding "+1" and 0 "-1" votes: The vote PASSED with X binding "+1", Y non-binding "+1" and 0 "-1" votes:
@ -425,12 +425,12 @@ The best way of doing this is to svn cp between the two repos (this avoids havin
the binaries again, and gives a clearer history in the svn commit logs): the binaries again, and gives a clearer history in the svn commit logs):
```shell ```shell
export VERSION=3.0.0-candidate-1 export VERSION_RC=3.0.0-candidate-1
export VERSION_WITHOUT_RC=${VERSION%-candidate-*} export VERSION_WITHOUT_RC=${VERSION_RC%-candidate-*}
APACHE_USER=<your ASF userid> APACHE_USER=<your ASF userid>
svn rm --username $APACHE_USER -m "Remove temporary index.yaml file" https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/${VERSION}/index.yaml svn rm --username $APACHE_USER -m "Remove temporary index.yaml file" https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/${VERSION_RC}/index.yaml
svn move --username $APACHE_USER -m "Release Pulsar Helm Chart ${VERSION_WITHOUT_RC} from ${VERSION}" \ svn move --username $APACHE_USER -m "Release Pulsar Helm Chart ${VERSION_WITHOUT_RC} from ${VERSION_RC}" \
https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/${VERSION} \ https://dist.apache.org/repos/dist/dev/pulsar/helm-chart/${VERSION_RC} \
https://dist.apache.org/repos/dist/release/pulsar/helm-chart/${VERSION_WITHOUT_RC} https://dist.apache.org/repos/dist/release/pulsar/helm-chart/${VERSION_WITHOUT_RC}
``` ```
@ -442,9 +442,9 @@ Create and push the release tag:
```shell ```shell
cd "${PULSAR_REPO_ROOT}" cd "${PULSAR_REPO_ROOT}"
git checkout pulsar-${RC} git checkout pulsar-${VERSION_RC}
git tag -s pulsar-${VERSION} -m "Apache Pulsar Helm Chart ${VERSION}" git tag -s pulsar-${VERSION_WITHOUT_RC} -m "Apache Pulsar Helm Chart ${VERSION_WITHOUT_RC}"
git push upstream pulsar-${VERSION} git push upstream pulsar-${VERSION_WITHOUT_RC}
``` ```
## Update index.yaml ## Update index.yaml
@ -457,15 +457,14 @@ Then, run the following command from within `github.com/apache/pulsar-site` in t
```shell ```shell
# Run on a branch based on main branch # Run on a branch based on main branch
cd site2/website-next/static/charts cd site2/website-next/static/charts
cp ${PULSAR_SVN_RELEASE_HELM}/${VERSION}/pulsar-${VERSION}.tgz . helm repo index --merge ./index.yaml . --url "https://downloads.apache.org/pulsar/helm-chart/${VERSION_WITHOUT_RC}"
helm repo index --merge ./index.yaml . --url "https://downloads.apache.org/pulsar/helm-chart/${VERSION}"
``` ```
Verify that the updated `index.yaml` file has the most recent version. Then run: Verify that the updated `index.yaml` file has the most recent version. Then run:
```shell ```shell
git add index.yaml git add index.yaml
git commit -m "Adding Pulsar Helm Chart ${VERSION} to index.yaml" git commit -m "Adding Pulsar Helm Chart ${VERSION_WITHOUT_RC} to index.yaml"
``` ```
Then open a PR. Then open a PR.
@ -481,7 +480,7 @@ Subject:
```shell ```shell
cat <<EOF cat <<EOF
[ANNOUNCE] Apache Pulsar Helm Chart version ${VERSION} Released [ANNOUNCE] Apache Pulsar Helm Chart version ${VERSION_WITHOUT_RC} Released
EOF EOF
``` ```
@ -492,14 +491,14 @@ cat <<EOF
Dear Pulsar community, Dear Pulsar community,
The Apache Pulsar team is pleased to announce the release of Apache Pulsar Helm The Apache Pulsar team is pleased to announce the release of Apache Pulsar Helm
Chart $VERSION. Chart $VERSION_WITHOUT_RC.
The source release, as well as the "binary" Helm Chart release, are available: The source release, as well as the "binary" Helm Chart release, are available:
Official Sources: https://pulsar.apache.org/download/ Official Sources: https://pulsar.apache.org/download/
ArtifactHub: https://artifacthub.io/packages/helm/apache/pulsar/$VERSION ArtifactHub: https://artifacthub.io/packages/helm/apache/pulsar/$VERSION_WITHOUT_RC
Docs: https://pulsar.apache.org/docs/helm-overview Docs: https://pulsar.apache.org/docs/helm-overview
Release Notes: https://github.com/apache/pulsar-helm-chart/releases/tag/pulsar-$VERSION Release Notes: https://github.com/apache/pulsar-helm-chart/releases/tag/pulsar-$VERSION_WITHOUT_RC
Thanks to all the contributors who made this possible. Thanks to all the contributors who made this possible.
@ -527,29 +526,21 @@ Post this in the #announce channel:
```shell ```shell
cat <<EOF cat <<EOF
We've just released Apache Pulsar Helm Chart ${VERSION} 🎉 We've just released Apache Pulsar Helm Chart ${VERSION_WITHOUT_RC} 🎉
Official Sources: https://pulsar.apache.org/download/ Official Sources: https://pulsar.apache.org/download/
ArtifactHub: https://artifacthub.io/packages/helm/apache/pulsar/$VERSION ArtifactHub: https://artifacthub.io/packages/helm/apache/pulsar/$VERSION_WITHOUT_RC
Docs: https://pulsar.apache.org/docs/helm-overview Docs: https://pulsar.apache.org/docs/helm-overview
Release Notes: https://pulsar.apache.org/docs/helm-chart/$VERSION/release_notes.html Release Notes: https://pulsar.apache.org/docs/helm-chart/$VERSION_WITHOUT_RC/release_notes.html
Thanks to all the contributors who made this possible. Thanks to all the contributors who made this possible.
EOF EOF
``` ```
## Remove old releases ## Maintaining svn https://dist.apache.org/repos/dist/release/pulsar/helm-chart/ content
We should keep the old version a little longer than a day. We updated the `index.yaml` earlier so that it points to the The chart references the files in https://downloads.apache.org/pulsar/helm-chart/ which are maintained
older releases. The short delay will help avoid errors for users who haven't run ``helm repo update`` to get the latest by SVN directory https://dist.apache.org/repos/dist/release/pulsar/helm-chart/.
`index.yaml`.
It is probably ok if we leave last 2 versions on release svn repo too. If you remove releases from this directory, the URLs in index.yaml should be updated point to the
https://archive.apache.org/dist/pulsar/helm-chart/ URL base instead of https://downloads.apache.org/pulsar/helm-chart/.
```shell
# https://www.apache.org/legal/release-policy.html#when-to-archive
cd pulsar-dist-release/helm-chart
export PREVIOUS_VERSION=1.0.0
svn rm ${PREVIOUS_VERSION}
svn commit -m "Remove old Helm Chart release: ${PREVIOUS_VERSION}"
```