Skip to content

Commit

Permalink
chore: Add Helm releasing instructions to RELEASING.md
Browse files Browse the repository at this point in the history
Also prepare the Helm chart for release right after this gets merged.

Signed-off-by: Gerhard Lazu <[email protected]>
  • Loading branch information
gerhard committed May 3, 2024
1 parent 78f8a3a commit 3c9eb4e
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish-helm-chart.yml
Expand Up @@ -30,4 +30,4 @@ jobs:
uses: ./.github/workflows/_new_release_notification.yml
secrets: inherit
with:
message: "🎡 Helm Chart: https://github.com/${{ github.repository }}/releases/tag/${{ github.ref_name }}"
message: "☸️ Helm Chart: https://github.com/${{ github.repository }}/releases/tag/${{ github.ref_name }}"
30 changes: 26 additions & 4 deletions RELEASING.md
Expand Up @@ -8,6 +8,7 @@ This describes how to release Dagger:
- [⬢ TypeScript SDK ⏱ `5mins`](#-typescript-sdk--5mins)
- [🧪 Elixir SDK ⏱ `5mins`](#-elixir-sdk--5mins)
- [🐘 PHP SDK ⏱ `5mins`](#-php-sdk--5mins)
- [☸️ Helm chart ⏱ `2mins`](#-helm-chart--2mins)
- [📒 Documentation ⏱ `5mins`](#-documentation--5mins)
- [🛝 Playground ⏱ `2mins`](#-playground--2mins)
- [🌌 Daggerverse ⏱ `2mins`](#-daggerverse--2mins)
Expand All @@ -24,9 +25,8 @@ This is a high-level diagram of how all the pieces fit together:
flowchart TB
repo(["🐙 github.com/dagger/dagger"])
docs["📒 Documentation"]
playground["🛝 Playground"]
ci["⚙️ CI"]
repo -.-> docs & playground & ci
repo -.-> docs & ci
subgraph Dagger
engine("🚙 Engine")
Expand All @@ -39,7 +39,7 @@ flowchart TB
brew-tap["🐙 github.com/dagger/homebrew-tap"]
github-action["🐙 github.com/dagger/dagger-for-github"]
nix["❄️ github.com/dagger/nix"]
cli --> S3 --> brew-tap & github-action & nix
cli --> S3 ------> brew-tap & github-action & nix
registry["📦 registry.dagger.io/engine"]
ghcr["🐙 ghcr.io/dagger/engine"]
Expand All @@ -49,12 +49,15 @@ flowchart TB
go-repo["🐙 github.com/dagger/dagger-go-sdk"]
go-pkg["🐹 dagger.io/dagger"]
go-ref["🐹 pkg.go.dev/dagger.io/dagger"]
playground["🛝 Playground"]
daggerverse["🌌 Daggerverse"]
cloud["☁️ Dagger Cloud"]
repo ==> go --> go-repo --> go-pkg & go-ref
go-pkg -.-> daggerverse & cloud
registry -.- S3 -.- go & python & typescript & elixir
registry -.- S3 -.- go & python & typescript & elixir & php & helm
registry -.....- playground
python["🐍 Python SDK"]
pypi["🐍 pypi.org/project/dagger-io"]
Expand All @@ -73,6 +76,9 @@ flowchart TB
php-repo["🐙 github.com/dagger/dagger-php-sdk"]
php-pkg["🐘 packagist.org/packages/dagger/dagger"]
repo ======> php --> php-repo --> php-pkg
helm["☸️ Helm chart"]
repo ======> helm
```

## Let the team know
Expand Down Expand Up @@ -224,6 +230,7 @@ changie merge
cd ../..
```

- [ ] For the Helm chart, bump `version` & `appVersion` in `helm/dagger/Chart.yaml`
- [ ] Commit and push the changes with the message `Add SDK release notes`
- [ ] `30mins` Open this draft PR in
[github.com/dagger/dagger/pulls](https://github.com/dagger/dagger/pulls) &
Expand Down Expand Up @@ -420,6 +427,21 @@ gh release create "sdk/php/${PHP_SDK_VERSION:?must be set}" \
- [ ] ⚠️ De-select **Set as the latest release** (only used for 🚙 Engine + 🚗 CLI releases)
- [ ] Click on **Publish release**

## ☸️ Helm chart ⏱ `2mins`

- [ ] Tag & publish:

```console
export HELM_CHART_VERSION=$(awk '/^version: / { print $2 }' helm/dagger/Chart.yaml)
git tag "helm/chart/v${HELM_CHART_VERSION:?must be set}" "${SDK_GIT_SHA:?must be set}"
git push "${DAGGER_REPO_REMOTE:?must be set}" "helm/chart/v${HELM_CHART_VERSION:?must be set}"
```

This will trigger the [`publish-helm-chart`
workflow](https://github.com/dagger/dagger/actions/workflows/publish-helm-chart.yml)
which publishes to [🐙
registry.dagger.io/dagger-helm](https://github.com/dagger/dagger/pkgs/container/dagger-helm).

## 📒 Documentation ⏱ `5mins`

> [!WARNING]
Expand Down
4 changes: 2 additions & 2 deletions helm/dagger/Chart.yaml
Expand Up @@ -3,5 +3,5 @@ name: dagger-helm
description: Dagger Helm chart

type: application
version: 0.1.2
appVersion: v0.11.1
version: 0.1.3
appVersion: v0.11.2

0 comments on commit 3c9eb4e

Please sign in to comment.