Skip to content

Commit

Permalink
docs: document release process (#117)
Browse files Browse the repository at this point in the history
  • Loading branch information
FredrikOseberg authored Dec 5, 2023
1 parent 9282e9e commit 9bab1d4
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,5 @@ jobs:

- name: Run chart-releaser
uses: helm/[email protected]
with:
charts_repo_url: https://docs.getunleash.io/helm-charts
env:
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 9bab1d4

Please sign in to comment.