https://github.com/mamezou-tech/setup-helmfile
Setup helmfile action
https://github.com/mamezou-tech/setup-helmfile
github-actions helm helmfile
Last synced: about 1 year ago
JSON representation
Setup helmfile action
- Host: GitHub
- URL: https://github.com/mamezou-tech/setup-helmfile
- Owner: mamezou-tech
- License: mit
- Created: 2020-02-02T08:39:47.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-02-19T22:07:30.000Z (over 1 year ago)
- Last Synced: 2025-03-30T07:09:42.188Z (about 1 year ago)
- Topics: github-actions, helm, helmfile
- Language: JavaScript
- Homepage:
- Size: 1.27 MB
- Stars: 41
- Watchers: 3
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
@mamezou-tech/setup-helmfile
============================
Setup [helmfile](https://github.com/helmfile/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
```yaml
name: CI
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup helmfile
uses: mamezou-tech/setup-helmfile@v2.1.0
- 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.170.1"`.
- `helm-version` : Helm version. Default `"v3.17.0"`
- `kubectl-version` : kubectl version. Default `1.32.0`
- `kubectl-release-date` : kubectl release date. Default `2025-01-10`
- `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 `v3.9.14`
- `helm-s3-plugin-version` : Plugin version to install. Default `v0.16.2`
- `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](https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html)" for information how to specify the kubectl version.
Example with optional inputs
```yaml
name: CI
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Setup helmfile
uses: mamezou-tech/setup-helmfile@v2.1.0
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.
```yaml
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Setup helmfile
uses: mamezou-tech/setup-helmfile@v2.1.0
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`.
```yaml
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Setup helmfile
uses: mamezou-tech/setup-helmfile@v2.1.0
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`.
```yaml
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Setup helmfile
uses: mamezou-tech/setup-helmfile@v2.1.0
with:
install-helm-plugins: no
```
### Build action (for maintainer)
```
npm install
npm run package
```
> `dist/index.js` shoud be included in commit.