From ea539da6503650e18e28f048c811677316d8a505 Mon Sep 17 00:00:00 2001 From: Kevin Park Date: Tue, 11 Apr 2023 19:07:45 +0900 Subject: [PATCH] Remove deprecated charts_repo_url input in documentation --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index e689410..50c1261 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ A GitHub action to turn a GitHub project into a self-hosted Helm chart repo, usi 1. A GitHub repo containing a directory with your Helm charts (default is a folder named `/charts`, if you want to maintain your charts in a different directory, you must include a `charts_dir` input in the workflow). -1. A GitHub branch called `gh-pages` to store the published charts. See `charts_repo_url` for alternatives. +1. A GitHub branch called `gh-pages` to store the published charts. 1. In your repo, go to Settings/Pages. Change the `Source` `Branch` to `gh-pages`. 1. Create a workflow `.yml` file in your `.github/workflows` directory. An [example workflow](#example-workflow) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file) @@ -18,7 +18,6 @@ A GitHub action to turn a GitHub project into a self-hosted Helm chart repo, usi - `version`: The chart-releaser version to use (default: v1.4.1) - `config`: Optional config file for chart-releaser. For more information on the config file, see the [documentation](https://github.com/helm/chart-releaser#config-file) - `charts_dir`: The charts directory -- `charts_repo_url`: The GitHub Pages URL to the charts repo (default: `https://.github.io/`) - `skip_packaging`: This option, when populated, will skip the packaging step. This allows you to do more advanced packaging of your charts (for example, with the `helm package` command) before this action runs. This action will only handle the indexing and publishing steps. - `mark_as_latest`: When you set this to `false`, it will mark the created GitHub release not as 'latest'. @@ -80,7 +79,6 @@ It does this – during every push to `main` – by checking each chart in your with: charts_dir: charts config: cr.yaml - charts_repo_url: xxxxxx env: CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" ```