Skip to content

Commit

Permalink
Use provided GITHUB_TOKEN instead of custom PAT (#26)
Browse files Browse the repository at this point in the history
Signed-off-by: Stuart P. Bentley <s@stuartpb.com>
  • Loading branch information
stuartpb authored Aug 9, 2020
1 parent a2cb342 commit cb4a7d9
Showing 1 changed file with 1 addition and 6 deletions.
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@ 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 (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
* To mitigate risk you may wish to limit the token to a single project by creating a [machine user](https://developer.github.com/v3/guides/managing-deploy-keys/#machine-users)
* Please note the personal access token is required because of an [Actions bug](https://gh.neting.ccmunity/t5/GitHub-Actions/Github-action-not-triggering-gh-pages-upon-push/m-p/31266/highlight/true#M743), and will hopefully be unnecessary in the future
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)

Expand Down Expand Up @@ -51,7 +46,7 @@ jobs:
- name: Run chart-releaser
uses: helm/chart-releaser-action@v1.0.0-rc.1
env:
CR_TOKEN: "${{ secrets.CR_TOKEN }}"
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
```
This uses [@helm/chart-releaser-action](https://www.github.com/helm/chart-releaser-action) to turn your GitHub project into a self-hosted Helm chart repo.
Expand Down

0 comments on commit cb4a7d9

Please sign in to comment.