An open API service indexing awesome lists of open source software.

https://github.com/helmless/template-action

A Github Action to render a serverless manifest from a Helmless chart.
https://github.com/helmless/template-action

github-action

Last synced: about 1 year ago
JSON representation

A Github Action to render a serverless manifest from a Helmless chart.

Awesome Lists containing this project

README

          

# helmless/template-action

![Version](https://img.shields.io/github/v/release/helmless/template-action)
![License](https://img.shields.io/github/license/helmless/template-action)

The [helmless/template-action](https://github.com/helmless/template-action) is a GitHub Action to template a Helmless chart into a serverless manifest.

You most likely want to use this together with the `*-deploy-action` matching your cloud provider.
Right now only the [helmless/google-cloudrun-deploy-action](https://github.com/helmless/google-cloudrun-deploy-action) exists, but more will follow soon.
By default the action will use the [helmless/google-cloudrun-chart](https://github.com/helmless/google-cloudrun-chart) chart, but you can override this by setting the `chart` input.

### Usage

```yaml
- uses: helmless/template-action@v0.1.0
with:
chart:
# Helm chart to use for templating. Defaults to the Google Cloud Run chart.
#
# Required: false
# Default: oci://ghcr.io/helmless/google-cloudrun-service

chart_version:
# Version of the Helm chart to use.
#
# Required: false
# Default: latest

files:
# Glob patterns of value files to include when templating the chart.
#
# Required: false
# Default: ""

values:
# Additional values to pass to the Helm chart when templating. Use one line per key-value pair.
#
# Required: false
# Default: ""

override_values:
# Override values to pass to the Helm chart when templating. These values are set last and will override any other values. Use one line per key-value pair.
#
# Required: false
# Default: ""

print_manifest:
# If true, print the rendered manifest to the console.
#
# Required: false
# Default: true

output_path:
# The path to output the combined manifest to.
#
# Required: false
# Default: helmless_manifest.yaml

output_dir:
# Directory to output individual template files to. If not specified, a temporary directory will be used.
#
# Required: false
# Default: ""
```

### Inputs

| name | description | required | default |
| --- | --- | --- | --- |
| `chart` |

Helm chart to use for templating. Defaults to the Google Cloud Run chart.

| `false` | `oci://ghcr.io/helmless/google-cloudrun-service` |
| `chart_version` |

Version of the Helm chart to use.

| `false` | `latest` |
| `files` |

Glob patterns of value files to include when templating the chart.

| `false` | `""` |
| `values` |

Additional values to pass to the Helm chart when templating. Use one line per key-value pair.

| `false` | `""` |
| `override_values` |

Override values to pass to the Helm chart when templating. These values are set last and will override any other values. Use one line per key-value pair.

| `false` | `""` |
| `print_manifest` |

If true, print the rendered manifest to the console.

| `false` | `true` |
| `output_path` |

The path to output the combined manifest to.

| `false` | `helmless_manifest.yaml` |
| `output_dir` |

Directory to output individual template files to. If not specified, a temporary directory will be used.

| `false` | `""` |

### Outputs

| name | description |
| --- | --- |
| `manifest` |

The rendered manifest from the Helm chart as YAML.

|
| `manifest_path` |

The path to the rendered manifest.

|
| `template_count` |

The number of templates rendered.

|
| `output_dir` |

The directory containing the individual template files.

|