samuelmasuy / helm-playground

Interactive site to debug Helm templating (& syntax cheatsheet)

Helm Playground

This repository contains the source code for https://helm-playground.com

How it works

A piece of Go code is compiled to a Wasm module which can be ran in the browser. This code implements a simple function which takes two inputs:

• YAML template
• YAML values

Then it simply renders the given template with the given values using Sprig, which is also what Helm uses.

The Wasm module is compiled in a GitHub action. You can find the workflow in .github/workflows/compile.yaml. When a commit is pushed to master, the workflow is triggered, the code is compiled and committed back to master with the commit message [GitHub action] Wasm module. The master branch is hosted live via GitHub Pages at https://helm-playground.com.

Development

Pull the repository

git clone [e-mail]:shipmight/helm-playground.git

Run tests for the golang code

make test

Build Wasm from golang

make build

Test the built Wasm code in browser

yarn --cwd ./browser-test # Install puppeteer in the subfolder
make browser-test

Locally develop in browser

You need a HTTP server to run the site locally, because fetch doesn't work under file:// protocol.

npx http-server -c-1

License

Some files in this repository contain embedded license notes.

Other files in this repository are licensed under GNU AGPLv3 (see LICENSE).