GitHub Action
Helm Publish
GitHub Action to package and deploy your Helm charts to GitHub Pages
Based upon gatsby-gh-pages-action
This GitHub Action will run helm package
for every chart folder in the charts
directory of your repository and
deploy it to GitHub Pages for you! Here's a basic workflow example:
name: Helm Publish
on:
push:
branches:
- dev
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: J12934/helm-gh-pages-action@master
with:
access-token: ${{ secrets.ACCESS_TOKEN }}
This Action is fairly simple but it does provide you with a couple of configuration options:
-
access-token: A GitHub Personal Access Token with the
repo
scope. This is required to push the site to your repo after Helm finished building it. You should store this as a secret in your repository. Provided as an input. -
deploy-branch: The branch expected by GitHub to have the static files needed for your site. For org and user pages it should always be
master
. This is where the packaged charts and index.yaml will be pushed to. Provided as an input. Defaults tomaster
. -
charts-folder: Charts folder of your repository. Defaults to
charts
Create a repository with the format <YOUR/ORG USERNAME>.github.io
, push your
helm sources to a branch other than master
and add this GitHub Action to
your workflow! 🚀😃
You have a custom domain you would like to use? Fancy! 😎 This Action's got you
covered! Assuming you have already set up your DNS provider as defined in the
GitHub Pages docs, all we need next is a CNAME
file at the root of your project with the domain you would like to use. For
example:
imenrique.com
Notice that it's all capitals CNAME 😊.
TODO
Have fun building! ✨