From 427ddc9db31ad99959c826f80346ab801dfcc53f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Brunner?= Date: Sat, 9 Nov 2024 09:42:25 +0100 Subject: [PATCH] Add gh-pages branch creation in the readme --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b31c70..8da6ff9 100644 --- a/README.md +++ b/README.md @@ -232,12 +232,21 @@ helm: - . ``` -This will publish the `helm` charts in the current folder using [chert releaser](https://github.com/helm/chart-releaser). +This will publish the `helm` charts in the current folder using [chart releaser](https://github.com/helm/chart-releaser). The artifacts will be attached to a GitHub release, and the `index.yaml` file will be updated in the `gh-pages` branch. The required permission is `contents: write`. +Create the required `gh-pages` branch: + +```bash +git checkout --orphan gh-pages +git reset --hard +git commit --allow-empty -m "Initialize gh-pages branch" +git push origin gh-pages +``` + ## Contributing Install the pre-commit hooks: