You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-12Lines changed: 2 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,24 +25,14 @@ Example project to demo testing and hosting a chart repository with GitHub Pages
25
25
26
26
You can automatically test and host your own chart repository with GitHub Pages and Actions by following these steps.
27
27
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
-
38
28
### Steps
39
29
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.
41
31
42
32
1. Use the `master` branch for all of the below, if you wish to use the Actions workflow files as-is
43
33
1. Copy the `.github/workflows` files from this project to yours
44
34
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/)
0 commit comments