Skip to content

Commit 6407b10

Browse files
authored
Merge pull request #15 from webmaxru/webmaxru-hackathon-submission
Add reusable Release Truth Canvas
2 parents 1ab427f + d741a9d commit 6407b10

11 files changed

Lines changed: 1293 additions & 1 deletion

File tree

‎.book-release-canvas.json‎

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
{
2+
"schemaVersion": 1,
3+
"repository": {
4+
"name": "GitHub Agentic Workflows book"
5+
},
6+
"publication": {
7+
"name": "GitHub Agentic Workflows: An Interactive Book",
8+
"promise": "Every published claim stays traceable to current product documentation and verified examples.",
9+
"contentVersionPath": "content/VERSION",
10+
"frameworkVersionPath": "content/FRAMEWORK_VERSION",
11+
"chapterPath": "content/chapters",
12+
"examplePath": "examples"
13+
},
14+
"sources": [
15+
{
16+
"id": "upstream-product",
17+
"label": "Official product docs and releases",
18+
"owner": "gh-aw-explorer",
19+
"url": "https://github.com/github/gh-aw",
20+
"paths": [
21+
"content/research/updates/{frameworkVersion}"
22+
],
23+
"evidence": "content/research/updates/{frameworkVersion}/framework-delta.md",
24+
"why": "Defines what changed in the product and which claims may now be stale."
25+
},
26+
{
27+
"id": "manuscript",
28+
"label": "Book manuscript",
29+
"owner": "chapter-author",
30+
"paths": [
31+
"content/chapters",
32+
"content/toc.yml"
33+
],
34+
"evidence": "content/release-review.json",
35+
"why": "Reader-facing explanations must match the fixed framework target."
36+
},
37+
{
38+
"id": "examples",
39+
"label": "Runnable examples",
40+
"owner": "code-verifier",
41+
"paths": [
42+
"examples",
43+
"scripts/verify_examples.py"
44+
],
45+
"evidence": "content/research/updates/{frameworkVersion}/final-verification-receipt.json",
46+
"why": "Copyable workflows must compile before the edition can ship."
47+
},
48+
{
49+
"id": "presentation",
50+
"label": "Interactive book experience",
51+
"owner": "frontend-builder",
52+
"paths": [
53+
"site",
54+
"assets"
55+
],
56+
"ignorePaths": [
57+
"site/release-canvas.html",
58+
"site/book.html",
59+
"site/llms-full.txt",
60+
"site/sitemap.xml"
61+
],
62+
"evidence": "site/index.html",
63+
"why": "Accepted content must reach the book, PDF, and discovery surfaces."
64+
}
65+
],
66+
"demos": [
67+
{
68+
"id": "source-drift",
69+
"label": "Source drift to chapter impact",
70+
"owner": "gh-aw-explorer",
71+
"paths": [
72+
"content/research/updates/{frameworkVersion}/framework-delta.md",
73+
"content/chapters"
74+
],
75+
"evidence": "content/research/updates/{frameworkVersion}/framework-delta.md",
76+
"cue": "Open one changed source and show the exact chapter decision it triggered."
77+
},
78+
{
79+
"id": "strict-compile",
80+
"label": "Strict example compilation",
81+
"owner": "code-verifier",
82+
"paths": [
83+
"examples",
84+
"scripts/verify_examples.py"
85+
],
86+
"evidence": "content/research/updates/{frameworkVersion}/final-verification-receipt.json",
87+
"cue": "Show the pinned compiler version and the complete workflow pass count."
88+
},
89+
{
90+
"id": "human-release-gate",
91+
"label": "Human release decision",
92+
"owner": "chapter-reviewer",
93+
"paths": [
94+
"content/chapters",
95+
"content/release-review.json"
96+
],
97+
"evidence": "content/release-review.json",
98+
"cue": "Show that automation prepares evidence, but ACCEPT remains an explicit review gate."
99+
}
100+
],
101+
"gates": [
102+
{
103+
"id": "framework-pin",
104+
"label": "Framework target is pinned",
105+
"kind": "text-equals",
106+
"path": "content/FRAMEWORK_VERSION",
107+
"equals": "v0.88.7"
108+
},
109+
{
110+
"id": "strict-verification",
111+
"label": "Whole example corpus passed",
112+
"kind": "json-field",
113+
"path": "content/research/updates/{frameworkVersion}/final-verification-receipt.json",
114+
"field": "status",
115+
"equals": "PASS"
116+
},
117+
{
118+
"id": "editorial-review",
119+
"label": "Editorial review accepted",
120+
"kind": "json-field",
121+
"path": "content/release-review.json",
122+
"field": "verdict",
123+
"equals": "ACCEPT"
124+
},
125+
{
126+
"id": "published-site",
127+
"label": "Generated book is present",
128+
"kind": "file-exists",
129+
"path": "site/index.html"
130+
}
131+
],
132+
"agents": [
133+
{
134+
"name": "Research",
135+
"role": "Find the exact upstream change and map its impact."
136+
},
137+
{
138+
"name": "Author",
139+
"role": "Update only the affected explanation and example."
140+
},
141+
{
142+
"name": "Verifier",
143+
"role": "Compile every example against the pinned product release."
144+
},
145+
{
146+
"name": "Reviewer",
147+
"role": "Hold the human-quality gate before publication."
148+
}
149+
],
150+
"rubric": [
151+
{
152+
"criterion": "GitHub-native enterprise context",
153+
"proof": "The canvas reads versions, git changes, workflows, examples, reviews, and release evidence from the repository."
154+
},
155+
{
156+
"criterion": "Multi-agent collaboration",
157+
"proof": "Research, authoring, verification, review, and integration have explicit owners and hand-offs."
158+
},
159+
{
160+
"criterion": "Governance and human review",
161+
"proof": "Pinned sources, strict compilation, source-bound review, and an explicit final release decision."
162+
},
163+
{
164+
"criterion": "Customer repeatability",
165+
"proof": "Fork the repo, edit one JSON configuration file, and reuse the same canvas for another documentation-led publication."
166+
}
167+
]
168+
}
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Book release canvas
2+
3+
This project-scoped Copilot extension turns repository evidence into a release-control Canvas for documentation-led publications.
4+
5+
## Open it
6+
7+
After the extension is loaded, ask Copilot to open the **Book release canvas**, or call the canvas with:
8+
9+
```text
10+
canvasId: book-release-canvas
11+
instanceId: book-release
12+
```
13+
14+
The default configuration is `.book-release-canvas.json`. An alternate repo-relative file can be passed as `configPath` when opening the Canvas.
15+
16+
## Reuse it
17+
18+
Copy the extension directory and `.book-release-canvas.json` into another repository. Configure:
19+
20+
- publication version and content paths;
21+
- documentation source areas and their evidence;
22+
- demo dependencies and proof artifacts;
23+
- release gates;
24+
- agent roles; and
25+
- the challenge/business proof displayed in the Canvas.
26+
27+
All configured paths are constrained to the repository. The extension binds its server to loopback only, requests no secret, and stores human demo decisions under the user's Copilot extension artifacts instead of editing committed evidence.
28+
29+
## Actions
30+
31+
- `refresh_release` — rescan git and configured evidence.
32+
- `get_release_snapshot` — return the complete structured state.
33+
- `set_demo_status` — persist a human `ready`, `needs-refresh`, or `blocked` decision.
34+
35+
## Test
36+
37+
```powershell
38+
npm run test:canvas
39+
```

0 commit comments

Comments
 (0)