Skip to content

Latest commit

 

History

History
110 lines (93 loc) · 3.28 KB

README.md

File metadata and controls

110 lines (93 loc) · 3.28 KB
Raw

@mamezou-tech/setup-helmfile

CI

Setup helmfile with Helm and kubectl in GitHub Actions workflow.

  • This action works on Linux runner.
  • The AWS version of kubectl will be installed.
  • Following Helm plugins will be installed
    • helm-diff
    • helm-s3
name: CI
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Setup helmfile
      uses: mamezou-tech/[email protected]
    - name: Test
      run: |
        helmfile --version
        helm version
        kubectl version --client

Important

This action requires Node 20 or later on the runner. If you are using GitHub-managed runners, no action is needed. If you are using self-hosted runners, make sure the system version of Node is version 20 or higher.

Optional Inputs

  • helmfile-version : helmfile version. Default "v0.161.0".
  • helm-version : Helm version. Default "v3.14.0"
  • kubectl-version : kubectl version. Default 1.29.0
  • kubectl-release-date : kubectl release date. Default 2024-01-04
  • install-kubectl : Install kubectl. Default yes
  • install-helm : Install Helm. Default yes
  • install-helm-plugins : Install Helm plugins. Default yes
  • helm-diff-plugin-version : Plugin version to install. Default master
  • helm-s3-plugin-version : Plugin version to install. Default master
  • additional-helm-plugins : A comma separated list of additional helm plugins to install. Should be a valid argument after helm plugin install.

See "Installing kubectl - Amazon EKS" for information how to specify the kubectl version.

Example with optional inputs

name: CI
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Setup helmfile
      uses: mamezou-tech/[email protected]
      with:
        helmfile-version: "v0.135.0"

If you are not particular about the version of kubectl / Helm and you can use the versions pre-installed on GitHub Actions runner, you can specify inputs not to install them.

Notice: Helm plugins will be installed in this case.

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Setup helmfile
      uses: mamezou-tech/[email protected]
      with:
        install-kubectl: no
        install-helm: no

If you want to install certain plugins other than the default plugins, use additional-helm-plugins, which accepts a comma separated list of additional plugins to install, accepting anything that can be passed to helm plugin install.

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Setup helmfile
      uses: mamezou-tech/[email protected]
      with:
        additional-helm-plugins: https://github.com/aslafy-z/helm-git --version 0.10.0

If you don't want helm plugins installed, specify no for install-helm-plugins.

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Setup helmfile
      uses: mamezou-tech/[email protected]
      with:
        install-helm-plugins: no

Build action (for maintainer)

npm install
npm run package

dist/index.js shoud be included in commit.