Skip to content

Commit d645a7b

Browse files
committed
chore: adapting readme to reflect the new helm actions
1 parent ae3aeb8 commit d645a7b

1 file changed

Lines changed: 82 additions & 0 deletions

File tree

README.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,3 +162,85 @@ deploy:
162162
file: dev/my-service/application.yaml
163163
package: ghcr.io/myorg/my-service
164164
```
165+
166+
---
167+
168+
### `helm-lint.yml` — Helm Lint
169+
170+
Runs `helm lint` against a chart directory.
171+
172+
#### Inputs
173+
174+
| Name | Required | Default | Description |
175+
|------|----------|---------|-------------|
176+
| `path` | yes | — | Path to the Helm chart directory |
177+
| `runner` | no | `'self-hosted'` | Runner label |
178+
179+
#### Example
180+
181+
```yaml
182+
lint:
183+
uses: mogenius/github-actions/.github/workflows/helm-lint.yml@<sha> # main
184+
with:
185+
path: ./charts/my-service
186+
```
187+
188+
---
189+
190+
### `helm-template.yml` — Helm Template
191+
192+
Renders a chart with `helm template` to validate manifests without a cluster. Supports inline values and `--set` overrides.
193+
194+
#### Inputs
195+
196+
| Name | Required | Default | Description |
197+
|------|----------|---------|-------------|
198+
| `path` | yes | — | Path to the Helm chart directory |
199+
| `values` | no | `''` | Inline values YAML passed via `-f` (written to a temp file) |
200+
| `set` | no | `''` | Additional `--set` overrides, one `key=value` per line |
201+
| `release_name` | no | `'release'` | Helm release name used during templating |
202+
| `namespace` | no | `'default'` | Kubernetes namespace used during templating |
203+
| `update_dependencies` | no | `false` | Run `helm dependency update` before templating |
204+
| `runner` | no | `'self-hosted'` | Runner label |
205+
206+
#### Example
207+
208+
```yaml
209+
template:
210+
uses: mogenius/github-actions/.github/workflows/helm-template.yml@<sha> # main
211+
with:
212+
path: ./charts/my-service
213+
values: |
214+
replicaCount: 2
215+
image:
216+
tag: latest
217+
set: |
218+
ingress.enabled=true
219+
```
220+
221+
---
222+
223+
### `helm-unittest.yml` — Helm Unit Tests
224+
225+
Runs [helm-unittest](https://github.com/helm-unittest/helm-unittest) against a chart directory.
226+
227+
#### Inputs
228+
229+
| Name | Required | Default | Description |
230+
|------|----------|---------|-------------|
231+
| `path` | yes | — | Path to the Helm chart directory |
232+
| `test_files` | no | `'unittests/**/*.yaml'` | Glob pattern for test files relative to the chart directory |
233+
| `strict` | no | `true` | Run helm-unittest with `--strict` flag |
234+
| `helm_unittest_version` | no | `'v1.1.0'` | Version of the helm-unittest plugin to install |
235+
| `update_dependencies` | no | `false` | Run `helm dependency update` before running tests |
236+
| `runner` | no | `'self-hosted'` | Runner label |
237+
238+
#### Example
239+
240+
```yaml
241+
unittest:
242+
uses: mogenius/github-actions/.github/workflows/helm-unittest.yml@<sha> # main
243+
with:
244+
path: ./charts/my-service
245+
test_files: 'tests/**/*.yaml'
246+
```

0 commit comments

Comments
 (0)