From a2cb342e3af55f5a5b247fe5dd1da3775e9010d3 Mon Sep 17 00:00:00 2001 From: Timothy Clarke Date: Sun, 26 Jul 2020 11:25:05 +0100 Subject: [PATCH] Updated README adding referance to gh-pages (#32) Signed-off-by: Timothy Clarke --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1e79eec..e8b47ae 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ A GitHub action to turn a GitHub project into a self-hosted Helm chart repo, usi ### Pre-requisites 1. A GitHub repo containing a directory with your Helm charts (eg: `/charts`) +1. A GitHub branch called `gh-pages` to store the published charts. See `charts_repo_url` for alternatives 1. A GitHub project [Secret](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets#creating-encrypted-secrets) named `CR_TOKEN` with the value of a GitHub [personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line#creating-a-token) * The token must have `repo` scope * The token's user must have write access to the project