miosp/helm-scribe

Generate a Helm values parameters table and values.schema.json, with an optional CI check mode.

Trust Signals

name	description	required	default
chart-directory	Directory of the Helm chart to process.	no	.
values-file	Path to the values file (maps to --values-file).	no	""
readme-file	Path to the README file (maps to --readme-file).	no	""
config	Path to the helm-scribe config file (maps to --config).	no	""
truncate-length	Max default value length before truncation (maps to --truncate-length).	no	""
heading-level	Heading level for section headers, 1-6 (maps to --heading-level).	no	""
schema-file	Path to the schema output file (maps to --schema-file).	no	""
dry-run	Print output to stdout instead of writing files (maps to --dry-run). Incompatible with check.	no	false
no-pretty	Disable table column alignment (maps to --no-pretty).	no	false
schema-only	Only generate the schema, skip README (maps to --schema-only).	no	false
readme-only	Only generate the README, skip schema (maps to --readme-only).	no	false
strict	Treat warnings as errors (maps to --strict).	no	false
type-column	Show the type column in the README table (maps to --type-column).	no	false
version	helm-scribe version constraint. "0" floats within major 0; "0.3" floats within 0.3; "0.3.1" pins exactly; "latest" takes the highest release.	no	0
check	Fail the step when generated files drift from what helm-scribe produces.	no	false
binary	Advanced. Path to a prebuilt helm-scribe binary. When set, version resolution and download are skipped and this binary is used directly.	no	""

name	description
version	The resolved release tag used, or "local" when the binary input was provided.
drift	true or false; whether check mode found stale files.
changed-files	Newline-separated list of files that drifted (check mode).