kployconfig

Schema, validation, and rendering for kploy.yaml — the per-project config file at a project repo's root that opts the project into kploy preview environments.

Imported by kploy (server) and kploy-cli (CLI).

Install

go get github.com/bitcomplete/kployconfig

import "github.com/bitcomplete/kployconfig"

cfg, err := kployconfig.Load(yamlBytes)

Module surface

func Load(data []byte) (*Config, error)
func Validate(cfg *Config) error
func RenderHostname(cfg *Config, env string, prNumber int) (string, error)
func RenderPreviewIngress(cfg *Config, prNumber int) ([]IngressHostname, error)

User-facing reference for the file format itself: kploy/docs/kploy-yaml.md.

Releasing

git tag vX.Y.Z
git push origin vX.Y.Z