Repository navigation
Expand file tree
/
Copy pathextension.yml
More file actions
161 lines (136 loc) · 5.97 KB
/
Copy pathextension.yml
File metadata and controls
161 lines (136 loc) · 5.97 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# @implements docguard.extension-manifest-hygiene#FR-001
# @implements docguard.extension-manifest-hygiene#FR-002
# @implements docguard.extension-manifest-hygiene#FR-003
schema_version: "1.0"
extension:
id: "docguard"
name: "DocGuard — CDD Enforcement"
version: "0.49.0" # docguard:volatile (rewritten by each release)
description: "Documentation integrity for AI-assisted repositories: lifecycle registry, drift validation, traceability, safe archival, SARIF/JUnit, MCP, GitHub Actions, and Spec Kit hooks."
author: "Ricardo Accioly"
repository: "https://github.com/raccioly/docguard"
license: "MIT"
homepage: "https://www.npmjs.com/package/docguard-cli"
category: "docs"
# read-write: fix --write, sync and init change project documents.
effect: "read-write"
requires:
# The floor is the newest Spec Kit feature this manifest uses: per-event hook
# lists with priority (0.10.0), category/effect (0.10.2), after_converge
# (0.11.2). tests/hooks-contract.test.mjs keeps it honest.
speckit_version: ">=0.11.2"
tools:
- name: "node"
required: true
version: ">=18.0.0"
- name: "npx"
required: true
- name: "specify"
required: false
description: "Spec Kit CLI — enables auto-initialization of SDD workflow during docguard init"
provides:
commands:
- name: "speckit.docguard.init"
file: "commands/init.md"
description: "Initialize Canonical-Driven Development in a project"
- name: "speckit.docguard.guard"
file: "commands/guard.md"
description: "Run configurable quality gate with severity triage and remediation plan"
- name: "speckit.docguard.fix"
file: "commands/fix.md"
description: "AI-driven documentation repair with codebase research and validation loops"
- name: "speckit.docguard.review"
file: "commands/review.md"
description: "Cross-document semantic consistency analysis (read-only)"
- name: "speckit.docguard.score"
file: "commands/score.md"
description: "CDD maturity score with ROI-based improvement roadmap"
- name: "speckit.docguard.diagnose"
file: "commands/diagnose.md"
description: "Diagnose all issues and generate a complete AI remediation plan"
- name: "speckit.docguard.generate"
file: "commands/generate.md"
description: "Reverse-engineer canonical docs from existing codebase"
- name: "speckit.docguard.sync"
file: "commands/sync.md"
description: "Refresh generated code-truth sections while preserving human prose"
- name: "speckit.docguard.trace"
file: "commands/trace.md"
description: "Generate the requirements traceability matrix"
- name: "speckit.docguard.anchors"
file: "commands/anchors.md"
description: "List what each requirement tag anchors to (read-only)"
- name: "speckit.docguard.brief"
file: "commands/brief.md"
description: "Brief prior spec intent and lifecycle before creating a new specification"
- name: "speckit.docguard.preflight"
file: "commands/preflight.md"
description: "Gate a generated specification against registry integrity and prior intent"
- name: "speckit.docguard.complete"
file: "commands/complete.md"
description: "Plan the reviewed implemented-to-verified lifecycle transaction"
# Helper scripts for CI/CD and automation
scripts:
- name: "docguard-check-docs"
file: "scripts/bash/docguard-check-docs.sh"
description: "Discover project docs, return JSON inventory with metadata"
- name: "docguard-suggest-fix"
file: "scripts/bash/docguard-suggest-fix.sh"
description: "Run guard, parse results, output prioritized fix suggestions"
- name: "docguard-init-doc"
file: "scripts/bash/docguard-init-doc.sh"
description: "Initialize a new canonical document with metadata header"
hooks:
# Priority: lower runs first. The briefing (5) runs before the git
# extension's branch creation (default 10), so a blocked briefing never
# leaves an empty feature branch behind.
before_specify:
- command: "speckit.docguard.brief"
optional: false
priority: 5
description: "Load current spec intent and block specification on stale lifecycle state"
after_implement:
- command: "speckit.docguard.guard"
optional: false
priority: 5
description: "Quality gate — ensures docs stay in sync with code"
- command: "speckit.docguard.complete"
optional: true
priority: 10
prompt: "Review evidence and plan this spec's completion transaction?"
description: "Plan lifecycle verification after implementation"
after_converge:
- command: "speckit.docguard.complete"
optional: true
priority: 10
prompt: "Review evidence and plan this converged spec's completion transaction?"
description: "Plan lifecycle verification after convergence"
before_tasks:
- command: "speckit.docguard.preflight"
optional: false
priority: 10
description: "Gate the generated spec before task generation"
after_tasks:
- command: "speckit.docguard.score"
optional: true
priority: 10
prompt: "Show CDD maturity score after task generation?"
description: "Show CDD maturity score after task generation"
# Spec Kit's publishing guide allows 2-5 tags; the catalog submission reads these.
tags:
- "documentation"
- "validation"
- "traceability"
- "ai-agents"
- "spec-kit"
# DocGuard-specific metadata Spec Kit does not read. GitHub Actions workflow
# starters live here, not under `provides`, so they cannot be mistaken for
# Spec Kit workflows (`specify workflow`, .specify/workflows/).
x-docguard:
github_workflows:
- name: "docguard-guard"
file: "templates/github-workflows/docguard-guard.yml"
description: "Mandatory CI gate — runs all validators on PR + main push"
- name: "docguard-autofix"
file: "templates/github-workflows/docguard-autofix.yml"
description: "PR-time auto-fix — applies mechanical doc fixes + comments summary"