From 9bab1d4b61f93441356fd02ae5239b2af1b4a551 Mon Sep 17 00:00:00 2001 From: Fredrik Strand Oseberg Date: Tue, 5 Dec 2023 11:26:07 +0100 Subject: [PATCH] docs: document release process (#117) --- .github/workflows/release.yaml | 2 -- README.md | 10 ++++++++++ 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 63ee42e..fcc232f 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -26,7 +26,5 @@ jobs: - name: Run chart-releaser uses: helm/chart-releaser-action@v1.5.0 - with: - charts_repo_url: https://docs.getunleash.io/helm-charts env: CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" diff --git a/README.md b/README.md index 46f3a80..11e76b6 100644 --- a/README.md +++ b/README.md @@ -42,3 +42,13 @@ We'd love to have you contribute! Please refer to our [contribution guidelines]( ## Helm charts build status ![Release Charts](https://github.com/unleash/helm-charts/workflows/release-chart/badge.svg?branch=main) + +## Releasing the charts + +To release new versions of the charts, you must update the chart version in the Chart.yaml file and then merge these modifications into the main branch. Following this, the workflow will detect these changes and automatically release a new version of the modified Helm chart. + +## Helm repo + +This repository employs a process that converts it into a Helm repository, specifically using the Helm Chart Releaser Action version 1.5.0. It leverages GitHub Pages for hosting the artifacts. Furthermore, the Unleash documentation on Helm charts (found at https://docs.getunleash.io/helm-charts) utilizes a CNAME to direct to the GitHub Pages. + +The specific workflow is outlined in the file located at .github/workflows/release.yml. This workflow activates whenever there's an update to the chart version, which consequently prompts an update to the repository with the new chart version. \ No newline at end of file