Skip to content

CLAUDE.md

Latest commit

 

History

History
100 lines (76 loc) · 4.99 KB

CLAUDE.md

File metadata and controls

100 lines (76 loc) · 4.99 KB
Raw

Helmizer

What This Is

A Go CLI tool that generates kustomization.yaml files. It reads a helmizer.yaml config, optionally runs pre/post commands (e.g. helm template), walks directories to discover resource files, and renders a complete kustomization with all file paths resolved. Solves kustomize's lack of glob support.

Project Structure

src/                    # All Go source code
  main.go               # Entry point - parses args, resolves config paths, runs helmizer per config
  cli.go                # CLIArgs struct, logging setup
  helmizer.go           # Core logic: Config/Kustomization structs, command execution,
                        #   config reconciliation, file walking, kustomization writing
  utilities.go          # Helpers: YAML reading, path construction, glob/doublestar matching,
                        #   config path resolution, and the source-default version string
  charts.go             # `helmizer charts check` subcommand: reports available chart updates
                        #   for Helmfile releases with a version policy and risk score
  helmfile.go           # Helmfile state loading (`helmfile build`) and release/repo parsing
  chart_repo.go         # Helm HTTP(S) repository index fetching and chart version listing
  semver.go             # SemVer parsing, comparison, and version policy/constraint matching
  utilities_test.go     # Basic tests for version output and config-glob resolution
  go.mod                # Module: daemondude23/helmizer, Go 1.26.1 for Nix compatibility
Dockerfile              # Minimal scratch image with just helmizer
Dockerfile.helm         # Alpine image with helmizer + helm binary (from alpine/helm)
action.yml              # GitHub Action definition (docker-based, uses Dockerfile.helm)
.goreleaser.yaml        # Cross-platform release builds (linux/darwin/windows, amd64/arm64/386)
.github/
  workflows/release.yaml  # CI: test -> goreleaser + docker build on tag push
  renovate.json           # Renovate config for Dockerfile, gomod, helm, kustomize, GH Actions
examples/               # One subdirectory per kustomize feature, each with helmizer.yaml + expected output

Building and Testing

# Build locally
cd src && go build -o helmizer .

# Run tests
cd src && go test -v ./...

# Build the flake package
mkdir -p ./build/nix && nix build .#default --out-link ./build/nix/helmizer

# Docker build (minimal)
docker build --build-arg VERSION=0.20.0 -t helmizer .

# Docker build (with helm)
docker build --build-arg VERSION=0.20.0 -f Dockerfile.helm -t helmizer-helm .

Key Dependencies

  • github.com/alexflint/go-arg - CLI argument parsing
  • github.com/sirupsen/logrus - Structured logging
  • gopkg.in/yaml.v3 - YAML marshal/unmarshal

How It Works

  1. Parse CLI args (CLIArgs struct in cli.go)
  2. Resolve config file paths - supports positional arg or --config-glob with ** doublestar patterns
  3. For each config file: a. Read and unmarshal helmizer.yaml into Config (has Helmizer + Kustomize sections) b. Reconcile CLI args with config (CLI overrides config) c. Run pre-commands (e.g. helm template) with working dir set to config file's directory d. Build Kustomization struct - for resources/crds/patchesStrategicMerge, walks directories recursively e. Write kustomization.yaml only if content changed (MD5 comparison) f. Run post-commands

Config File Format

Two top-level keys in helmizer.yaml:

  • helmizer: - tool settings (commands, paths, flags)
  • kustomize: - pass-through kustomization fields (namespace, resources, patches, images, etc.)

GitHub Action

The action.yml defines a Docker-based action using Dockerfile.helm. Inputs:

  • config: path to a single helmizer config file (default: helmizer.yaml)
  • config_glob: glob pattern(s) for multiple configs (supports ** and commas)

Version

Current source version: 0.20.0 in src/utilities.go. Release builds stamp main.version via the flake, Dockerfiles, and GoReleaser so packaged artifacts stay aligned.

Local Claude Skills

  • /update-dependencies loads .claude/skills/update-dependencies/SKILL.md for local dependency and tooling refreshes.
  • /prepare-local-release loads .claude/skills/prepare-local-release/SKILL.md for local version/release-file alignment.
  • These skills are local-only workflows. Do not create commits, tags, pushes, pull requests, or releases when using them.

Conventions

  • Keep the var version = "..." in src/utilities.go aligned with the next local release; packaged builds override it with ldflags
  • There are a few basic _test.go files now, but test coverage is still intentionally light
  • Pre-commit hooks configured via .pre-commit-config.yaml
  • YAML indentation is normalized to 2 spaces via FixYAMLIndentation
  • Commands execute with working directory set to the helmizer config file's parent directory
  • Release flow is two-step by design: run ./scripts/release.sh prepare <version> on a release branch, merge it, then run ./scripts/release.sh tag <version> from main