docs: improve README with engine examples and add helm/kustomize examples#1
Conversation
…ples - Add "Why yamlspec?" section and usage guides for Helm, Kustomize, plain manifests - Add working helm-chart example with pre_run rendering (7 assertions) - Add working kustomize-overlay example with pre_run rendering (6 assertions) - Remove ci.yml (pr.yml already covers tests, keep workflows on PR only) - Total examples: 5 specs, 56 assertions across all three engines Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Core Changes
- Removed the standalone
ci.ymlGitHub Actions workflow, streamlining CI configuration. - Added a comprehensive Helm chart example, including
Chart.yaml, templates, defaultvalues.yaml, an overridevalues.yaml, a pre-rendered manifest, and ayamlspectest specification. - Added a comprehensive Kustomize overlay example, including base manifests,
kustomization.yaml, a pre-rendered manifest, and ayamlspectest specification.
Verdict
Approve: The changes introduce valuable examples for Helm and Kustomize integration, which significantly improve the project's documentation and usability. The removal of the redundant CI workflow is also a positive cleanup. No critical issues were found.
Code review performed by GEMINI - gemini-2.5-flash.
- Add `yamlspec ai-help`: 348-line reference for AI assistants with spec format, all operators, field paths, selectors, 5 examples, CLI usage - Add CUSTOM_RULES to reviewforge enforcing ai-help stays in sync - Fix all golangci-lint staticcheck/errcheck issues across formatters and tests Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Core Changes
This Pull Request introduces a new ai-help CLI command, providing a comprehensive reference guide for AI assistants on yamlspec's structure, spec.yaml format, selectors, field paths, and a complete list of assertion operators with examples. It also adds detailed Helm and Kustomize example test suites, demonstrating the use of pre_run commands for manifest rendering. The GitHub Actions PR workflow has been enhanced with specific custom rules and project context for the AI code review tool. Additionally, the redundant ci.yml workflow has been removed, as its functionality is now covered by pr.yml.
Concerns
There are no critical concerns regarding security, performance, or logic flaws. The changes are well-contained and improve the project's documentation and testing capabilities.
Verdict
Approve
Code review performed by GEMINI - gemini-2.5-flash.
| @@ -160,15 +160,15 @@ func TestE2E_PreRun_GeneratesManifests(t *testing.T) { | |||
| } | |||
There was a problem hiding this comment.
[SUGGESTION] Consider handling potential errors from os.RemoveAll explicitly, even if just logging them. While _ = is common for best-effort cleanup in tests, a failed cleanup could sometimes indicate an underlying issue (e.g., permissions) that might be useful to debug.
1 participant
Summary
pre_runrendering (7 assertions)pre_runrendering (6 assertions)ci.yml—pr.ymlalready covers tests; keep workflows on PR onlyTest plan
yamlspec validate --test-dir examples🤖 Generated with Claude Code