Skip to content

Commit

Permalink
Add README for GHA Workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
jonyoder committed Aug 5, 2021
1 parent c146fa3 commit 3b001d2
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/chart-rebuild.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 21 additions & 0 deletions scripts/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 3b001d2

Please sign in to comment.