Coverage hygiene: gitignore coverage output + codecov.yml standard - #273
Merged
Conversation
.gitignore now excludes coverage artifacts (coverage/, *.cobertura.xml, coverage.xml, .coverage, htmlcov/) so a blanket git add -A never commits them. Add a reference codecov.yml snippet (project+patch informational so a coverage delta never gates a PR - distinct from fail_ci_if_error - plus a commented ignore for untested example/benchmark apps), list it in spec/files.json for csharp/python, and extend WORKFLOW.md D1.6. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR tightens coverage hygiene in the template/spec by (1) ensuring common coverage outputs are ignored by default and (2) standardizing a baseline codecov.yml so Codecov statuses are explicitly non-gating across C# and Python repos.
Changes:
- Extend
.gitignoreto exclude common C# and Python coverage outputs (including directory-based outputs likecoverage/andhtmlcov/). - Add a baseline
codecov.ymlreference snippet that sets Codecov project/patch statuses toinformational: true. - Update
spec/files.jsonandWORKFLOW.md(D1.6) to codify thecodecov.ymland coverage-artifact expectations.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| WORKFLOW.md | Expands D1.6 to document Codecov non-gating behavior and coverage-artifact hygiene expectations. |
| spec/files.json | Adds codecov.yml to the baseline for ["csharp","python"], referencing the catalog snippet. |
| catalog/snippets/configs/codecov.yml | Introduces the standard Codecov config snippet (non-gating statuses; optional ignore guidance). |
| .gitignore | Ignores common coverage outputs to prevent accidental commits from git add -A. |
The contract doc points at .gitignore as the source of truth rather than duplicating the full pattern set (avoids two places to maintain). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ed coverage output) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…t HA-specific Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes two coverage gaps surfaced while working on Utilities.
1.
.gitignoreswept in coverage output. CI writes coverage to./coverage/(C#) andcoverage.xml/.coverage(Python), but the template.gitignoreexcluded none of it — sogit add -Acommitted acoverage.cobertura.xmlbuild artifact. Added:coverage/,[Tt]est[Rr]esults/,*.cobertura.xml,*.coverage,coverage.xml,.coverage,.coverage.*,htmlcov/.2.
codecov.ymlwas not standardized. The upload path was covered (D1.6) but not the file that makes Codecov's own project/patch commit statuses non-gating — a different knob fromfail_ci_if_error. Added a referencecatalog/snippets/configs/codecov.yml(informational: true+ a commentedignore:for untested example/benchmark apps), listed it inspec/files.jsonfor["csharp","python"], and extended WORKFLOW.md D1.6.CRLF preserved; editorconfig-checker + markdownlint +
spec/validate.pyall clean.Follow-ups (authorized, next): local lint parity (husky + VS Code tasks mirror the CI lint set incl editorconfig-checker), then bundled backfill of codecov.yml + hygiene to the 5 C# repos.
🤖 Generated with Claude Code