check-contribution

Validates Helm operator chart contributions with template rendering, linting, and documentation checks.

2.1k|283|Updated Mar 12, 2025
One-click install
npx skills add https://github.com/stacklok/toolhive --skill check-contribution
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: check-contribution
Source: https://github.com/stacklok/toolhive/tree/main/.claude/skills/check-contribution
Command: npx skills add https://github.com/stacklok/toolhive --skill check-contribution

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Contributors to the ToolHive operator Helm chart risk committing changes that break template rendering, fail chart linting, or leave generated documentation out of sync with values.yaml. This Skill runs the required contribution checks before committing so issues are caught early.

Core Features & Use Cases

  • Helm Template Validation: Runs helm template against the operator chart to confirm it renders valid Kubernetes YAML without errors.
  • Chart Linting: Executes ct lint to surface linting errors and warnings on chart changes.
  • Documentation Verification: Runs helm-docs in dry-run mode to confirm values.yaml variables are documented and the generated README.md is up to date.
  • Use Case: Before committing a change to deploy/charts/operator, run this Skill to get a pass/fail report on template rendering, linting, and docs, with remediation commands for any failures.

Quick Start

Check whether my operator Helm chart changes pass all contribution requirements before I commit them.

Frequently Asked Questions about check-contribution

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate Helm chart changes before committing?

Run helm template against the chart directory to confirm it renders valid Kubernetes YAML, then run ct lint for linting errors and helm-docs --dry-run to verify documentation is current. This Skill automates all three checks and reports pass or fail for each.

How to check if Helm chart documentation is up to date?

Run helm-docs --dry-run in the chart directory. It compares the generated README.md against values.yaml variables and reports whether the committed documentation matches what would be generated.

What does ct lint check in a Helm chart?

ct lint (chart-testing) validates chart structure, YAML syntax, and linting rules for changed charts. This Skill runs it against the operator chart and reports any errors or warnings that would block a contribution.

Should I bump the Chart.yaml version in a feature PR?

No. Chart version bumps are automated by the release bot in this repository. Feature PRs should not modify Chart.yaml; the Skill's output notes this convention explicitly.

Why does helm template fail on my chart changes?

Failures typically come from invalid template syntax, missing required values, or referencing undefined variables. Run helm template test . in the chart directory to see the exact rendering error, then fix the offending template or values entry.