Carlos Tadeu Panato JuniorandReinhard Nägele
b52ca56807
Signed-off-by: Carlos Panato <ctadeu@gmail.com>
62 lines
3.1 KiB
Markdown
62 lines
3.1 KiB
Markdown
# *chart-releaser* Action
|
||
|
||
A GitHub action to turn a GitHub project into a self-hosted Helm chart repo, using [helm/chart-releaser](https://github.com/helm/chart-releaser) CLI tool.
|
||
|
||
## Usage
|
||
|
||
### Pre-requisites
|
||
|
||
1. A GitHub repo containing a directory with your Helm charts (eg: `/charts`)
|
||
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://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
|
||
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)
|
||
|
||
### Inputs
|
||
|
||
For more information on inputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#input)
|
||
|
||
- `version`: The chart-releaser version to use (default: v0.2.3)
|
||
- `charts_dir`: The charts directory
|
||
- `charts_repo_url`: The GitHub Pages URL to the charts repo (default: `https://<owner>.github.io/<project>`)
|
||
|
||
### Example Workflow
|
||
|
||
Create a workflow (eg: `.github/workflows/release.yml`):
|
||
|
||
```yaml
|
||
name: Release Charts
|
||
|
||
on:
|
||
push:
|
||
branches:
|
||
- master
|
||
|
||
jobs:
|
||
release:
|
||
runs-on: ubuntu-latest
|
||
steps:
|
||
- name: Checkout
|
||
uses: actions/checkout@v1
|
||
|
||
- name: Configure Git
|
||
run: |
|
||
git config user.name "$GITHUB_ACTOR"
|
||
git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
|
||
|
||
- name: Run chart-releaser
|
||
uses: helm/chart-releaser-action@v1.0.0-alpha.2
|
||
env:
|
||
CR_TOKEN: "${{ secrets.CR_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.
|
||
It does this – during every push to `master` – by checking each chart in your project, and whenever there's a new chart version, creates a corresponding [GitHub release](https://help.github.com/en/github/administering-a-repository/about-releases) named for the chart version, adds Helm chart artifacts to the release, and creates or updates an `index.yaml` file with metadata about those releases, which is then hosted on GitHub Pages
|
||
|
||
## Code of conduct
|
||
|
||
Participation in the Helm community is governed by the [Code of Conduct](CODE_OF_CONDUCT.md).
|