codeguard-yaml

YAML Codeguard Gate

Goal: turn "looks fine" into repeatable tool evidence, and honestly distinguish between pass, fail, unable to verify, and planned.

Start in 30 Seconds

1. At the repository root, confirm 无专用标记文件 or that the target file exists.
2. Detect tools:yamllint --version。
3. First perform a read-only check:yamllint .。
4. Classify the results as: code violations, missing configuration, missing tools, tool internal errors.
5. Only performyamllint .。
6. Rerun lint, and execute the project's existing test/build gates.

You can directly ask:

• "Check this YAML project, don't modify anything first, and give me a classification of the lint failures."
• "Only fix YAML formatting issues; list semantic issues first."
• "Verify YAML lint, test, and build evidence before committing."

Capability Boundaries

✅ Good At

1. Identify YAML workspaces based on .yml, .yaml and project markers.
2. Execute yamllint . and retain exit codes, scope, and tool versions.
3. Distinguish between formatting, static rules, configuration, dependency, and environment-related failures.
4. Use yamllint . to handle reversible issues and rescan.
5. Report local results in layers alongside CI/build/test evidence.

⚠️ Conditional

1. The target tool must be installed and its version compatible with project constraints.
2. It must be executed from the correct repository or module root.
3. If the project has custom configuration, the committed configuration takes precedence.
4. Whether generated code, vendor, and cache directories are scanned must follow repository rules.

❌ Out of Scope

1. Do not treat a formatter pass as a compilation, test, or security audit pass.
2. Do not silently install tools, upgrade dependencies, or modify team rules.
3. Do not use suppress/ignore/raising thresholds to conceal real problems.
4. Do not claim "check passed" when tools or configuration are missing.

When to Use

• The user requests checking or fixing YAML code standards.
• AI modified .yml, .yaml, and pre-commit verification is needed.
• CI shows failures related to yamllint . .
• It is necessary to determine whether a problem can be automatically fixed or must be handled manually.

When Not to Use

• The main task is learning language syntax, framework design, or business modeling; corresponding language professional skills should be used instead.
• The main task is dependency vulnerabilities, security auditing, or license governance; specialized security skills should be used.
• When the user only asks to explain one error and there is no project context, first provide a local explanation and do not claim the repository is fully green.

Data and Security

This skill does not collect, upload, send, or store user code and credentials. By default, it only reads local repository configuration and runs local tools; it does not install dependencies over the network, and does not record tokens, passwords, or private source code. Before any automatic fix, check the diff first; destructive or large-scale changes must be explicitly confirmed by the user.

Execution Contract

Project	Current facts
Status	stable(since Codeguard V0.2)
File extensions	.yml, .yaml
Project marker	No dedicated marker file
Integration configuration	Based on the repository's existing configuration
Tool preparation	pip install yamllint
Probe command	使用命令查找与项目配置检查
lint	yamllint .
format/fix	yamllint .
Project-level gate	yamllint .

Standard Workflow

Step 1: Determine the real scope

Confirm the repository root, module roots, generated directories, vendor directories, and user-specified files. For multi-module projects, first list the modules that will be scanned; do not guess based on the current directory.

Step 2: Read the project contract

Read the actual commands in 以仓库现有配置为准 and CI. The repository configuration takes precedence over this skill's examples; if the two conflict, report the differences first.

Step 3: Probe tools and versions

Run 对应工具 --version. Missing tools, incompatible versions, or configurations that fail to load are all recorded as "unable to verify", not as a pass.

Step 4: Run read-only checks

Run yamllint ., and record the command, working directory, exit code, tool version, and first actionable error.

Step 5: Failure classification

Type	Typical signal	Handling
Format	Indentation, whitespace, import order	Allow formatter, then check the diff
Static rules	unused, complexity, naming, dangerous APIs	Minimal semantic fixes, no bulk guessing
Configuration	parser/config/schema not found	Fix the integration or report the prerequisites
Environment	command not found, version conflict	Report installation/version requirements; do not install silently
Tool internal error	crash, timeout, parser exception	Preserve the raw evidence and narrow the reproduction scope

Step 6: Controlled fixes

Prefer to run yamllint .. Only handle clearly reversible issues; dependency upgrades, rule exemptions, generated files, and business-semantic changes must be explained separately.

Step 7: Verification loop

Re-run the same lint command, then run the project's existing tests and build. Only write "pass" when the command, scope, and exit code are all clear; otherwise write "not run" or "unable to verify".

Rules

1. Same-command re-verification: after a fix, the original command that triggered the failure must be re-run.
2. Layered evidence: report lint, format, compile, test, and security separately.
3. Minimal changes: do not refactor along the way, and do not expand a style fix into a business rewrite.
4. Configuration first: do not override the project's existing ignore, dialect, target, or version constraints.
5. No fabrication: tools that were not run, configurations that were not seen, and platforms that were not verified must be clearly marked.

Output template

YAML Codeguard 结果
- 范围：<仓库/模块/文件>
- 工具：<名称与版本>
- 命令：<实际命令>
- 状态：PASS / FAIL / UNVERIFIED / PLANNED
- 发现：<按格式/规则/配置/环境分类>
- 修改：<文件与原因；无修改写 none>
- 复验：<命令、退出码>
- 未验证：<测试/构建/平台差异>

Gotchas

1. A missing tool is not a pass — must output UNVERIFIED and a clear preparation method.
2. A formatter is not a linter — all-green formatting cannot cover up static rule or compilation errors.
3. Root directory determines the result — Running in the wrong module may miss detection or load the wrong configuration.
4. Placeholders are not literal parameters — {file} must be replaced with real, authorized paths.
5. Auto-fixes may enlarge the diff — After fixing, review the diff first, then run the regression gate.
6. Generated and vendor directories require an explicit policy — Do not scan or modify third-party content across the whole repository at will.

Domain pitfalls and fixes

1. Domain pitfalls — Correct YAML syntax does not mean the Kubernetes, Compose, or CI schema is correct; corresponding schema validation is required.

When information is insufficient

Do not just say "please provide more information". First give a safe read-only inspection plan, and list the specific items that still need confirmation:

1. Repository/module root directory;
2. Target tool and version;
3. Project configuration file;
4. Authoritative command in CI;
5. Whether auto-fix is allowed.

FAQ

Q1: If the tool is not installed, can we conclude the code is fine? No. The status must be UNVERIFIED。

Q2: Can ignore or suppression be added automatically? No. Exemptions are allowed only when the user explicitly accepts them and the reason is recorded.

Q3: Why does it still fail after formatting? The formatter only covers formatting; static rules, configuration, compilation, and tests still need to be handled separately.

Q4: Should generated code be scanned? Follow the repository configuration by default; if there are no rules, exclude generated/vendor first, then explain to the user.

Q5: How can too many changes at once be avoided? First fix in batches by failure category and file, and rerun the original command and review the diff for each batch.

Q6: If it passes locally, can we say CI will pass? No. CI's versions, environment variables, operating system, and command scope also need to be aligned.

Load resources as needed

• When encountering exit codes, failure classification, or exemption decisions, read references/rules/gate-rules.md。
• When you need to check this language's registry, toolchain, and project configuration, read references/tooling/toolchain.md。
• When you need copyable task examples, read by scenario examples/, and there is no need to load all of them at once.