Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chuhlomin/render-template
GitHub Action to render file based on template and passed variables
https://github.com/chuhlomin/render-template
Last synced: about 1 month ago
JSON representation
GitHub Action to render file based on template and passed variables
- Host: GitHub
- URL: https://github.com/chuhlomin/render-template
- Owner: chuhlomin
- License: apache-2.0
- Created: 2021-02-14T00:11:47.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-06T23:38:13.000Z (2 months ago)
- Last Synced: 2024-10-08T23:34:05.664Z (2 months ago)
- Language: Go
- Homepage:
- Size: 381 KB
- Stars: 27
- Watchers: 3
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - chuhlomin/render-template - GitHub Action to render file based on template and passed variables (Go)
README
# Render Template
[](https://github.com/chuhlomin/render-template/actions/workflows/main.yml)
[](https://github.com/chuhlomin/render-template/actions/workflows/release.yml)
[](https://hub.docker.com/repository/docker/chuhlomin/render-template)
GitHub Action to render file based on template and passed variables.
> [!NOTE]
> This is a Docker-based action and may not work on Windows and MacOS runners.
## Inputs
| Name | Description | Required |
|-------------|-----------------------------------------------|----------|
| template | Path to template | true |
| vars | Variables to use in template (in YAML format) | false |
| vars_path | Path to YAML file with variables | false |
| result_path | Desired path to result file | false |
| timezone | Timezone to use in `date` template function | false |
You must set at least `vars` or `vars_path`.
You may set both of them (`vars` values will precede over `vars_path`).
Variables names must be alphanumeric strings (must not contain any hyphens).
There are few template functions available:
- `date` – formats timestamp using Go's [time layout](https://golang.org/pkg/time/#pkg-constants).
Example: `{{ "2023-05-11T01:42:04Z" | date "2006-01-02" }}` will be rendered as `2023-05-11`.
You may use `timezone` input to set timezone for `date` function (e.g. `timezone: "America/New_York"`).
- `mdlink` – creates markdown link.
Example: `{{ "https://github.com" | mdlink "GitHub" }}` will be rendered as `[GitHub](https://github.com)`.
- `number` – formats number in English locale.
Example: `{{ 1234567890 | number }}` will be rendered as `1,234,567,890`.
- `base64` – encodes string to base64.
Example: `{{ "hello" | base64 }}` will be rendered as `aGVsbG8=`.
- `split` – splits string by delimiter.
- `toJSON` – converts string to JSON.
Example: `{{ "1,2,3" | split "," | toJSON }}` will be rendered as `["1","2","3"]`.
## Outputs
| Name | Description |
|--------|-----------------------|
| result | Rendered file content |
## Example
`kube.template.yml`
```yml
apiVersion: apps/v1
kind: Deployment
metadata:
name: {{ .deployment }}
labels:
app: {{ .app }}
spec:
replicas: 3
selector:
matchLabels:
app: {{ .app }}
template:
metadata:
labels:
app: {{ .app }}
spec:
containers:
- name: {{ .app }}
image: {{ .image }}
ports:
- containerPort: 80
```
`.github/workflows/main.yml`
```yml
name: main
on:
push:
branches:
- main
env:
DOCKER_IMAGE: username/image
DEPLOYMENT_NAME: nginx-deployment
jobs:
main:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
<...>
- name: Render template
id: render_template
uses: chuhlomin/render-template@v1
with:
template: kube.template.yml
vars: |
image: ${{ env.DOCKER_IMAGE }}:${{ github.sha }}
deployment: ${{ env.DEPLOYMENT_NAME }}
app: nginx
- name: Deploy
timeout-minutes: 4
run: |-
echo '${{ steps.render_template.outputs.result }}' | kubectl apply -f -
kubectl rollout status deployment/$DEPLOYMENT_NAME
```