Skip to content

Commit 60436cb

Browse files
authored
Use GITHUB_TOKEN (helm#24)
* Use GITHUB_TOKEN. See helm/chart-releaser-action#26 Signed-off-by: Scott Rigby <[email protected]> * Bump chart versions to test GITHUB_TOKEN in demo repo on release after PR merge Signed-off-by: Scott Rigby <[email protected]>
1 parent d66e6fa commit 60436cb

File tree

6 files changed

+7
-17
lines changed

6 files changed

+7
-17
lines changed

.github/workflows/release.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ jobs:
3535
- name: Run chart-releaser
3636
uses: helm/[email protected]
3737
env:
38-
CR_TOKEN: "${{ secrets.CR_TOKEN }}"
38+
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

README.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,14 @@ Example project to demo testing and hosting a chart repository with GitHub Pages
2525

2626
You can automatically test and host your own chart repository with GitHub Pages and Actions by following these steps.
2727

28-
### Prerequisites
29-
30-
* A GitHub project to use for your Charts repo (a clean project is most straightforward, as there won't be release cluttering or possible `gh-pages` conflicts)
31-
* A branch to use for GitHub Pages (`gh-pages` is most straightforward, as it's the default and requires no configuration)
32-
* A 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)
33-
* The token must have `repo` scope
34-
* The token's user must have write access to the project
35-
* 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)
36-
* Please note the personal access token is required because of an [Actions bug](https://github.community/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
37-
3828
### Steps
3929

40-
The above [prerequisites](#prerequisites) _must_ be complete before the steps below, or your charts' initial versions won't be released.
30+
The prerequisites listed in the READMEs for [actions](#actions) above _must_ be complete before the steps below, or your charts' initial versions won't be released.
4131

4232
1. Use the `master` branch for all of the below, if you wish to use the Actions workflow files as-is
4333
1. Copy the `.github/workflows` files from this project to yours
4434
1. Add your charts to a parent directory in the project (`/charts` is most straightforward, as it's the default. To change this see [helm/chart-testing > configuration > chart-dirs](https://github.com/helm/chart-testing#configuration))
45-
1. Optional: To list your charts repo publicly on the [Helm Hub](https://hub.helm.sh), see [Helm Hub > How To Add Your Helm Charts](https://github.com/helm/hub#how-to-add-your-helm-charts)
35+
1. Optional: To list your charts repo publicly on the [Helm Hub](https://hub.helm.sh), see [Helm Hub > How To Add Your Helm Charts](https://github.com/helm/hub#how-to-add-your-helm-charts). Consider also pushing to [CNCF Artifact Hub](https://artifacthub.io/)
4636

4737
### Results
4838

charts/dependencies-v1/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ maintainers:
88
name: dependencies-v1
99
sources:
1010
- https://github.com/helm/charts-repo-actions-demo
11-
version: 0.1.4
11+
version: 0.1.5

charts/dependencies-v2/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ maintainers:
88
name: dependencies-v2
99
sources:
1010
- https://github.com/helm/charts-repo-actions-demo
11-
version: 0.1.4
11+
version: 0.1.5
1212
dependencies:
1313
- name: redis
1414
version: 10.5.13

charts/example-v1/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ maintainers:
88
name: example-v1
99
sources:
1010
- https://github.com/helm/helm
11-
version: 0.1.7
11+
version: 0.1.8

charts/example-v2/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ maintainers:
88
name: example-v2
99
sources:
1010
- https://github.com/helm/helm
11-
version: 0.2.4
11+
version: 0.2.5

0 commit comments

Comments
 (0)