This document describes how to prepare and publish a new Botkube release.
Obtain a GitHub Personal Access token with repo
and write:packages
permissions.
Install the following applications:
botkube
repositoryClone and navigate to the root of the botkube
repository.
Export required environment variables:
export GITHUB_USERNAME="{username}" # GitHub username
export GITHUB_TOKEN="{token}" # GitHub personal access token with packages write scope
Log in to Docker:
echo $GITHUB_TOKEN | docker login ghcr.io -u ${GITHUB_USERNAME} --password-stdin
Update .release
file with the new version in Semantic Versioning 2.0 format.
release=v{semVer version}
For example:
release=v0.12.5
Run release script:
./hack/release.sh
This script:
Update newly created GitHub release description using GitHub UI.
./CHANGELOG.md
file.Publish the modified Helm charts:
git clone -b gh-pages "https://github.com/kubeshop/botkube.git" /tmp/botkube-charts
helm package -d /tmp/botkube-charts ./helm/botkube
cd /tmp/botkube-charts
helm repo index --url "https://charts.botkube.io/" --merge ./index.yaml .
git add .
git commit -m "Release BotKube Helm chart"
git push
cd -
rm -rf /tmp/botkube-charts
botkube-docs
repositoryClone and navigate to the root of the botkube
repository.
Run the release script:
./hack/release.sh
You can customize the source repository by setting GITHUB_ORG
, GITHUB_REPO
and REPO_BRANCH
environment variables.
This script: