feat: add helm docs and schema gen

Add Helm docs and Helm JSON Schema generation.

Signed-off-by: Mateusz Urbanek <mateusz.urbanek@siderolabs.com>

Author: shanduur

Makefile

@@ -1,6 +1,6 @@
 # THIS FILE WAS AUTOMATICALLY GENERATED, PLEASE DO NOT EDIT.
 #
-# Generated on 2026-01-16T08:46:36Z by kres 6f7b97a-dirty.
+# Generated on 2026-01-27T14:17:50Z by kres f189649-dirty.
 
 # common variables
 
@@ -171,6 +171,9 @@ local-%:  ## Builds the specified target defined in the Dockerfile using the loc
 	    fi; \
 	  done'
 
+check-dirty:
+	@if test -n "`git status --porcelain`"; then echo "Source tree is dirty"; git status; git diff; exit 1 ; fi
+
 generate:  ## Generate .proto definitions.
 	@$(MAKE) local-$@ DEST=./
 

internal/config/constants.go

@@ -78,6 +78,12 @@ const (
 	// HelmUnitTestVersion is the version of helm unit test plugin.
 	// renovate: datasource=github-tags depName=helm-unittest/helm-unittest
 	HelmUnitTestVersion = "v1.0.3"
+	// HelmValuesSchemaJSONVersion is the version of helm values-schema-json plugin.
+	// renovate: datasource=github-tags depName=losisin/helm-values-schema-json
+	HelmValuesSchemaJSONVersion = "v2.3.1"
+	// HelmDocsVersion is the version of helm-docs tool.
+	// renovate: datasource=github-tags depName=norwoodj/helm-docs
+	HelmDocsVersion = "v1.14.2"
 	// LoginActionVersion is the version of login github action.
 	// renovate: datasource=github-tags depName=docker/login-action
 	LoginActionVersion = "v3.6.0"

internal/project/auto/git.go

@@ -106,7 +106,11 @@ func (builder *builder) DetectGit() (bool, error) {
 
 // BuildGit builds steps for Git repository.
 func (builder *builder) BuildGit() error {
-	builder.commonInputs = append(builder.commonInputs, common.NewRepository(builder.meta))
+	builder.commonInputs = append(
+		builder.commonInputs,
+		common.NewRepository(builder.meta),
+		common.NewCheckDirty(builder.meta),
+	)
 
 	return nil
 }

internal/project/auto/golang.go

@@ -18,6 +18,7 @@ import (
 	"github.com/siderolabs/kres/internal/dag"
 	"github.com/siderolabs/kres/internal/project/common"
 	"github.com/siderolabs/kres/internal/project/golang"
+	"github.com/siderolabs/kres/internal/project/helm"
 	"github.com/siderolabs/kres/internal/project/meta"
 	"github.com/siderolabs/kres/internal/project/service"
 	"github.com/siderolabs/kres/internal/project/wrap"
@@ -235,7 +236,10 @@ func (builder *builder) BuildGolang() error {
 	// add common linter tools
 	linters := golang.NewLinters(builder.meta)
 
-	toolchain.AddInput(generate, deepcopy, linters)
+	// add helm-docs tool
+	helmDocs := helm.NewHelmDocs(builder.meta)
+
+	toolchain.AddInput(generate, deepcopy, linters, helmDocs)
 
 	builder.lintInputs = append(builder.lintInputs, toolchain, linters)
 

internal/project/common/check_dirty.go

@@ -0,0 +1,40 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package common
+
+import (
+	"github.com/siderolabs/kres/internal/config"
+	"github.com/siderolabs/kres/internal/dag"
+	"github.com/siderolabs/kres/internal/output/makefile"
+	"github.com/siderolabs/kres/internal/project/meta"
+)
+
+// CheckDirty builds Makefile `check-dirty` target.
+type CheckDirty struct { //nolint:govet
+	dag.BaseNode
+
+	meta *meta.Options
+}
+
+// NewCheckDirty initializes CheckDirty.
+func NewCheckDirty(meta *meta.Options) *CheckDirty {
+	return &CheckDirty{
+		BaseNode: dag.NewBaseNode("check-dirty"),
+
+		meta: meta,
+	}
+}
+
+// CompileMakefile implements makefile.Compiler.
+func (c *CheckDirty) CompileMakefile(output *makefile.Output) error {
+	if c.meta.ContainerImageFrontend != config.ContainerImageFrontendDockerfile {
+		return nil
+	}
+
+	output.Target("check-dirty").
+		Script("@if test -n \"`git status --porcelain`\"; then echo \"Source tree is dirty\"; git status; git diff; exit 1 ; fi")
+
+	return nil
+}

internal/project/helm/build.go

@@ -13,6 +13,9 @@ import (
 
 	"github.com/siderolabs/kres/internal/config"
 	"github.com/siderolabs/kres/internal/dag"
+	"github.com/siderolabs/kres/internal/output/dockerfile"
+	"github.com/siderolabs/kres/internal/output/dockerfile/step"
+	"github.com/siderolabs/kres/internal/output/dockerignore"
 	"github.com/siderolabs/kres/internal/output/ghworkflow"
 	"github.com/siderolabs/kres/internal/output/makefile"
 	"github.com/siderolabs/kres/internal/project/meta"
@@ -33,6 +36,32 @@ func NewBuild(meta *meta.Options) *Build {
 	}
 }
 
+// CompileDockerfile implements dockerfile.Compiler.
+func (helm *Build) CompileDockerfile(output *dockerfile.Output) error {
+	output.Stage("helm-docs-run").
+		Description("runs helm-docs").
+		From("base").
+		Step(step.Copy(helm.meta.HelmChartDir, filepath.Join("/src", helm.meta.HelmChartDir))).
+		Step(step.Run("helm-docs", "--badge-style=flat", "--template-files=README.md.gotpl").
+			MountCache(filepath.Join(helm.meta.CachePath, "go-build"), helm.meta.GitHubRepository).
+			MountCache(filepath.Join(helm.meta.CachePath, "helm-docs"), helm.meta.GitHubRepository, step.CacheLocked))
+
+	output.Stage("helm-docs").
+		Description("clean helm-docs output").
+		From("scratch").
+		Step(step.Copy(filepath.Join("/src", helm.meta.HelmChartDir), helm.meta.HelmChartDir).From("helm-docs-run"))
+
+	return nil
+}
+
+// CompileDockerignore implements dockerignore.Compiler.
+func (helm *Build) CompileDockerignore(output *dockerignore.Output) error {
+	output.
+		AllowLocalPath(helm.meta.HelmChartDir)
+
+	return nil
+}
+
 // CompileMakefile implements makefile.Compiler.
 func (helm *Build) CompileMakefile(output *makefile.Output) error {
 	helmReleaseScript := fmt.Sprintf(`@helm push $(ARTIFACTS)/%s-*.tgz oci://$(HELMREPO) 2>&1 | tee $(ARTIFACTS)/.digest
@@ -41,7 +70,8 @@ func (helm *Build) CompileMakefile(output *makefile.Output) error {
 
 	output.VariableGroup(makefile.VariableGroupCommon).
 		Variable(makefile.OverridableVariable("HELMREPO", "$(REGISTRY)/$(USERNAME)/charts")).
-		Variable(makefile.OverridableVariable("COSIGN_ARGS", ""))
+		Variable(makefile.OverridableVariable("COSIGN_ARGS", "")).
+		Variable(makefile.OverridableVariable("HELMDOCS_VERSION", config.HelmDocsVersion))
 
 	generateTarget := output.GetTarget("generate")
 	if generateTarget != nil {
@@ -67,7 +97,10 @@ func (helm *Build) CompileMakefile(output *makefile.Output) error {
 	output.Target("helm-plugin-install").
 		Description("Install helm plugins").
 		Phony().
-		Script(fmt.Sprintf("-helm plugin install https://github.com/helm-unittest/helm-unittest.git --verify=false --version=%s", config.HelmUnitTestVersion))
+		Script(
+			fmt.Sprintf("-helm plugin install https://github.com/helm-unittest/helm-unittest.git --verify=false --version=%s", config.HelmUnitTestVersion),
+			fmt.Sprintf("-helm plugin install https://github.com/losisin/helm-values-schema-json.git --verify=false --version=%s", config.HelmValuesSchemaJSONVersion),
+		)
 
 	output.Target("kuttl-plugin-install").
 		Description("Install kubectl kuttl plugin").
@@ -84,6 +117,14 @@ func (helm *Build) CompileMakefile(output *makefile.Output) error {
 		Phony().
 		Script(fmt.Sprintf("@helm unittest %s --output-type junit --output-file $(ARTIFACTS)/helm-unittest-report.xml", helm.meta.HelmChartDir))
 
+	output.Target("chart-gen-schema").
+		Description("Generate helm chart schema").
+		Phony().
+		Script(fmt.Sprintf("@helm schema --use-helm-docs --draft=7 --indent=2 --values=%s/values.yaml --output=%s/values.schema.json", helm.meta.HelmChartDir, helm.meta.HelmChartDir))
+
+	output.Target("helm-docs").Description("Runs helm-docs and generates chart documentation").
+		Script("@$(MAKE) local-$@ DEST=.")
+
 	return nil
 }
 
@@ -145,6 +186,27 @@ func (helm *Build) CompileGitHubWorkflow(output *ghworkflow.Output) error {
 		return err
 	}
 
+	schemaStep := ghworkflow.Step("Generate schema").
+		SetMakeStep("chart-gen-schema")
+
+	if err := schemaStep.SetConditions("on-pull-request"); err != nil {
+		return err
+	}
+
+	docsStep := ghworkflow.Step("Generate docs").
+		SetMakeStep("helm-docs")
+
+	if err := docsStep.SetConditions("on-pull-request"); err != nil {
+		return err
+	}
+
+	checkDirtyStep := ghworkflow.Step("Check dirty").
+		SetMakeStep("check-dirty")
+
+	if err := checkDirtyStep.SetConditions("on-pull-request"); err != nil {
+		return err
+	}
+
 	helmLoginStep := ghworkflow.Step("helm login").
 		SetEnv("HELM_CONFIG_HOME", "/var/tmp/.config/helm").
 		SetCommand(fmt.Sprintf("helm registry login -u %s -p ${{ secrets.GITHUB_TOKEN }} ghcr.io", "${{ github.repository_owner }}"))
@@ -202,6 +264,9 @@ func (helm *Build) CompileGitHubWorkflow(output *ghworkflow.Output) error {
 						templateStep,
 						unittestPluginInstallStep,
 						unittestStep,
+						schemaStep,
+						docsStep,
+						checkDirtyStep,
 						helmLoginStep,
 						helmReleaseStep,
 					},

internal/project/helm/helm_docs.go

@@ -0,0 +1,49 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package helm
+
+import (
+	"fmt"
+	"path/filepath"
+
+	"github.com/siderolabs/kres/internal/dag"
+	"github.com/siderolabs/kres/internal/output/dockerfile"
+	"github.com/siderolabs/kres/internal/output/dockerfile/step"
+	"github.com/siderolabs/kres/internal/project/meta"
+)
+
+// HelmDocs is a helm-docs node.
+type HelmDocs struct {
+	meta *meta.Options
+	dag.BaseNode
+}
+
+// NewHelmDocs initializes HelmDocs.
+func NewHelmDocs(meta *meta.Options) *HelmDocs {
+	meta.BuildArgs.Add(
+		"HELMDOCS_VERSION",
+	)
+
+	return &HelmDocs{
+		meta:     meta,
+		BaseNode: dag.NewBaseNode("helm-docs"),
+	}
+}
+
+// ToolchainBuild implements common.ToolchainBuilder hook.
+func (helm *HelmDocs) ToolchainBuild(stage *dockerfile.Stage) error {
+	stage.
+		Step(step.Arg("HELMDOCS_VERSION")).
+		Step(step.Script(
+			fmt.Sprintf(
+				"go install github.com/norwoodj/helm-docs/cmd/helm-docs@${HELMDOCS_VERSION} \\\n"+
+					"\t&& mv /go/bin/helm-docs %s/helm-docs", helm.meta.BinPath),
+		).
+			MountCache(filepath.Join(helm.meta.CachePath, "go-build"), helm.meta.GitHubRepository).
+			MountCache(filepath.Join(helm.meta.GoPath, "pkg"), helm.meta.GitHubRepository),
+		)
+
+	return nil
+}