From 3b001d2f52048e9593380c2293e426fd84597436 Mon Sep 17 00:00:00 2001 From: Jonathan Yoder Date: Thu, 5 Aug 2021 11:27:25 -0400 Subject: [PATCH] Add README for GHA Workflow --- .github/workflows/chart-rebuild.yaml | 2 -- scripts/README.md | 21 +++++++++++++++++++++ 2 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 scripts/README.md diff --git a/.github/workflows/chart-rebuild.yaml b/.github/workflows/chart-rebuild.yaml index ac00ec3a..589054e3 100644 --- a/.github/workflows/chart-rebuild.yaml +++ b/.github/workflows/chart-rebuild.yaml @@ -43,8 +43,6 @@ jobs: echo "Rebuilding index.yaml" scripts/rebuild.sh - echo "currently in $(pwd)" - cat index.yaml - name: Create Pull Request id: cpr diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 00000000..bae5af92 --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,21 @@ +# Rebuilding Index + +The Helm `index.yaml` is hosted on the `gh-pages` branch of this repo. If this +index becomes out-of-sync with the releases, you can rebuild it by using a +GitHub Actions Workflow. + +## Prerequisites + +- To use the `rebuild.sh` script with our workflow, the `rebuild.sh` + script must be checked in to the `gh-pages` branch. If you make any changes + to the script in this directory, make sure you also commit the same changes + to the `gh-pages` branch. +- You must have permission to run GitHub Actions Workflows for this repo. + +## Running the Action + +- Navigate to + https://github.com/rstudio/helm/actions/workflows/chart-rebuild.yaml. +- Use the `Run Workflow` button to run the workflow. +- Review the Pull Request created by the workflow. +- When approved, merge the Pull Request into the `gh-pages` branch.