add timestamps for verified instructions#10
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a structured way to track when reference docs were last exercised (date/version/env) via YAML frontmatter, plus a stdlib-only checker that reports coverage in CI.
Changes:
- Introduces
skills/crowdsec/scripts/check-verification.pyto scan docs forverified:frontmatter and report coverage/staleness. - Adds
verified:frontmatter entries to several reference docs. - Updates
CLAUDE.mdto document the verification schema and runs the checker in.github/workflows/validate.yml.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/crowdsec/scripts/check-verification.py | New verification-coverage/staleness report script with schema validation. |
| skills/crowdsec/references/install/bare-metal.md | Adds verified: frontmatter entry for systemd install path. |
| skills/crowdsec/references/configure/bouncers/web-servers.md | Adds verified: frontmatter entry for nginx bouncer path. |
| skills/crowdsec/references/configure/allowlists.md | Adds verified: frontmatter entry for allowlist operations. |
| skills/crowdsec/references/appsec/deploy.md | Adds verified: frontmatter entry for AppSec deploy flow. |
| CLAUDE.md | Documents verification tracking rules and schema. |
| .github/workflows/validate.yml | Runs the verification coverage report in CI. |
Comments suppressed due to low confidence (1)
skills/crowdsec/scripts/check-verification.py:186
- The “Malformed verified: block(s)” count uses
len(errors), buterrorsmay contain multiple items for the same doc (one per invalid entry). That makes the “block(s)” number misleading even if the detailed messages are fine. Consider counting distinct docs with errors separately (e.g.error_docsset) and using that for the headline count.
if errors:
print(f"\nMalformed verified: block(s): {len(errors)}", file=sys.stderr)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+175
to
+176
| print(f"\nVerified: {len(rows)} record(s) across {len(docs) - len(gaps) - len(errors)} doc(s)") | ||
| print(f"Coverage gaps (no verified: block): {len(gaps)}") |
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.
No description provided.