@hegemonart/get-design-done 1.35.2 → 1.35.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +2 -2
- package/.claude-plugin/plugin.json +1 -1
- package/CHANGELOG.md +43 -0
- package/README.md +8 -0
- package/SKILL.md +1 -0
- package/agents/ticket-sync-agent.md +117 -0
- package/connections/connections.md +54 -25
- package/connections/jira.md +62 -0
- package/connections/linear.md +62 -0
- package/connections/notion.md +57 -0
- package/package.json +1 -1
- package/reference/export-formats.md +31 -0
- package/reference/registry.json +14 -0
- package/reference/ticket-sync.md +59 -0
- package/scripts/lib/export/build-html.cjs +112 -0
- package/skills/connections/SKILL.md +4 -4
- package/skills/connections/connections-onboarding.md +31 -4
- package/skills/export/SKILL.md +30 -0
|
@@ -5,14 +5,14 @@
|
|
|
5
5
|
},
|
|
6
6
|
"metadata": {
|
|
7
7
|
"description": "Get Design Done — 5-stage agent-orchestrated design pipeline with 9 connections, handoff-first workflow, bidirectional Figma write-back, 22+ specialized agents, queryable knowledge layer (intel store, dependency analysis, learnings extraction), and a self-improvement loop (reflector, frontmatter + budget feedback, global-skills layer). v1.20.0 ships the SDK foundation: gdd-state MCP server (11 typed tools), lockfile-safe STATE.md mutations, event stream, and resilience primitives (jittered-backoff, rate-guard, error-classifier, iteration-budget) for rate-limit + 429 + context-overflow recovery. Full CI/CD pipeline (Node 22/24 × Linux/macOS/Windows) and release automation (auto-tag + GitHub Release + release-time smoke test).",
|
|
8
|
-
"version": "1.35.
|
|
8
|
+
"version": "1.35.5"
|
|
9
9
|
},
|
|
10
10
|
"plugins": [
|
|
11
11
|
{
|
|
12
12
|
"name": "get-design-done",
|
|
13
13
|
"source": "./",
|
|
14
14
|
"description": "Agent-orchestrated 5-stage design pipeline: Brief → Explore → Plan → Design → Verify. 22+ specialized agents, 9 connections (Figma, Refero, Preview, Storybook, Chromatic, Figma Writer, Graphify, Pinterest, Claude Design), Claude Design handoff, bidirectional Figma write-back, and a queryable intel store (.design/intel/) for dependency and learnings queries. Standalone commands: style, darkmode, compare, figma-write, graphify, handoff, analyze-dependencies, skill-manifest, extract-learnings. Embeds NNG heuristics, WCAG thresholds, typographic systems, motion framework, and anti-pattern catalog. Ships with a full CI/CD pipeline (Node 22/24 × Linux/macOS/Windows) and release automation. Optimization layer (v1.0.4.1, retroactive): gdd-router + gdd-cache-manager skills, PreToolUse budget-enforcer hook, tier-aware agent frontmatter, lazy checker gates, streaming synthesizer, /gdd:warm-cache + /gdd:optimize commands, and cost telemetry at .design/telemetry/costs.jsonl — targeting 50-70% per-task token-cost reduction with no quality-floor regression. v1.20.0 SDK foundation: gdd-state MCP server (11 typed tools), lockfile-safe STATE.md mutations, event stream at .design/telemetry/events.jsonl, resilience primitives (jittered-backoff, rate-guard, error-classifier, iteration-budget) with rate-limit + 429 + context-overflow recovery, and TypeScript toolchain.",
|
|
15
|
-
"version": "1.35.
|
|
15
|
+
"version": "1.35.5",
|
|
16
16
|
"author": {
|
|
17
17
|
"name": "hegemonart"
|
|
18
18
|
},
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "get-design-done",
|
|
3
3
|
"short_name": "gdd",
|
|
4
|
-
"version": "1.35.
|
|
4
|
+
"version": "1.35.5",
|
|
5
5
|
"description": "Agent-orchestrated 5-stage design pipeline: Brief → Explore → Plan → Design → Verify. 22+ specialized agents, 9 connections (Figma, Refero, Preview, Storybook, Chromatic, Figma Writer, Graphify, Pinterest, Claude Design), handoff-first workflow via Claude Design bundles, bidirectional Figma write-back (annotations, Code Connect), queryable intel store (`.design/intel/`) for O(1) design surface lookups, and self-improvement loop (reflector agent, frontmatter + budget feedback, global-skills layer at `~/.claude/gdd/global-skills/`). Standalone commands: style, darkmode, compare, figma-write, graphify, handoff, analyze-dependencies, skill-manifest, extract-learnings, reflect, apply-reflections. Embeds NNG heuristics, WCAG thresholds, typographic systems, motion framework, and anti-pattern catalog. Ships with a full CI/CD pipeline (Node 22/24 × Linux/macOS/Windows, lint + schema + frontmatter + stale-ref + shellcheck + gitleaks + injection-scan + blocking size-budget) and release automation (auto-tag + GitHub Release + release-time smoke test). Optimization layer (v1.0.4.1, retroactive): gdd-router + gdd-cache-manager skills, PreToolUse budget-enforcer hook, tier-aware agent frontmatter, lazy checker gates, streaming synthesizer, /gdd:warm-cache + /gdd:optimize commands, and cost telemetry at .design/telemetry/costs.jsonl — targeting 50-70% per-task token-cost reduction with no quality-floor regression. v1.20.0 SDK foundation: gdd-state MCP server (11 typed tools), lockfile-safe STATE.md mutations, event stream at .design/telemetry/events.jsonl, resilience primitives (jittered-backoff, rate-guard, error-classifier, iteration-budget) with rate-limit + 429 + context-overflow recovery, and TypeScript toolchain. v1.27.7 ships gdd-mcp (Phase 27.7): 12 read-only MCP tools for sub-3s priming. v1.28.0 (Phase 28): Foundational References Tier 2 — 5 new reference files (color-theory, composition, proportion-systems, i18n, contrast-advanced), 2 verifier i18n probes + 1 explore i18n-readiness probe, 12 additive cross-link insertions across 10 existing references, 2 orthogonal audit-scoring lens-tags (composition_alignment + i18n_readiness).",
|
|
6
6
|
"author": {
|
|
7
7
|
"name": "hegemonart",
|
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,49 @@ All notable changes to get-design-done are documented here. Versions follow [sem
|
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
+
## [1.35.5] - 2026-06-01
|
|
8
|
+
|
|
9
|
+
### Phase 35.5 — Design-Artifact Export (`/gdd:export`)
|
|
10
|
+
|
|
11
|
+
Closes the gap that a completed cycle's design output (`EXPERIENCE.md`, `DESIGN.md`, `DESIGN-VERIFICATION.md`, the decision log, screenshots) lives only in the repo — stakeholders not in code can't consume it. `/gdd:export <cycle> --format html|pdf|notion` packages it into a shareable artifact. **No new runtime dependency** (D-02): `build-html.cjs` is a pure, dep-free assembler; the PDF format is the same HTML plus Paged.js-compatible `@page` print CSS that the user renders (GDD ships **no** PDF runtime); Notion is written via the Notion MCP. Every artifact is **redacted** (mandatory `scripts/lib/redact.cjs`); `--pseudonymize` masks git identity / paths / hostname for external sharing; `--pr` posts the HTML preview as a PR comment via `pr-commenter`.
|
|
12
|
+
|
|
13
|
+
### Added
|
|
14
|
+
|
|
15
|
+
- **`scripts/lib/export/build-html.cjs`** — a pure, dependency-free self-contained HTML assembler: inline `<style>`, base64-embedded screenshots, **zero external resource references**, a minimal deterministic markdown→HTML subset. `print: true` adds the Paged.js `@page` print CSS for the PDF format. Same input → byte-identical output.
|
|
16
|
+
- **`skills/export/SKILL.md`** (`/gdd:export`) — resolves the cycle, reads the design source set, redacts always (+ pseudonymizes on `--pseudonymize`), renders html/pdf via `build-html` or a Notion page via the MCP, and hands the HTML to `pr-commenter` on `--pr`.
|
|
17
|
+
- **`connections/notion.md`** — Notion MCP write-path (`mcp__notion__*`, ToolSearch probe, redact, `GDD_DISABLE_NOTION` kill-switch, degrade-to-HTML). Onboarded 18 → 19 — **export-only** (not a pipeline stage; no capability-matrix column).
|
|
18
|
+
- **`reference/export-formats.md`** — the `/gdd:export` contract (source set, the three formats, redact + `--pseudonymize`, the `--pr` hand-off, the self-contained guarantee); registered in `reference/registry.json`.
|
|
19
|
+
|
|
20
|
+
### Notes
|
|
21
|
+
|
|
22
|
+
- **No new runtime dependency** (D-02) and **no new egress** (`scan:outbound` unchanged — Notion is written via MCP tools, not raw HTTP).
|
|
23
|
+
- 6-manifest lockstep at **v1.35.5** + `OFF_CADENCE_VERSIONS.add('1.35.5')` + the 22 live-pinned `manifests-version.txt` baselines forward-propagated 1.35.3 → 1.35.5 (1.35.4 not used).
|
|
24
|
+
- The 31.5 tarball golden was regenerated as a reviewed delta: **+4** (`scripts/lib/export/build-html.cjs`, `skills/export/SKILL.md`, `connections/notion.md`, `reference/export-formats.md`), zero removals (657 → 661).
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## [1.35.3] - 2026-06-01
|
|
29
|
+
|
|
30
|
+
### Phase 35.3 — Team Surfaces: Ticket Sync (Linear + Jira) — completes Phase 35
|
|
31
|
+
|
|
32
|
+
Third and **FINAL** sub-phase of the split **Phase 35 (Team Surfaces Layer)** — completing it marks the **parent Phase 35 COMPLETE** (PR-inline 35.1 + Notification 35.2 + Ticket-sync 35.3 all shipped). Wires GDD ↔ Linear/Jira bidirectionally: it reads a linked ticket's comments as cycle context (via the decision-injector) and, on cycle completion, transitions the ticket + posts a redacted summary. **MCP-based** (`mcp__linear__*` / `mcp__atlassian__*`) — no bundled SDK, no new outbound egress. Every outbound body is redacted; per-system kill-switches + degrade-to-noop guarantee ticket-sync never gates the cycle.
|
|
33
|
+
|
|
34
|
+
### Added
|
|
35
|
+
|
|
36
|
+
- **`connections/linear.md` + `connections/jira.md`** — MCP-based bidirectional ticket-sync connections (Linear MCP / Atlassian MCP; ToolSearch probe, redact + kill-switch + degrade-to-noop). Onboarded 16 → 18.
|
|
37
|
+
- **`agents/ticket-sync-agent.md`** — reads linked-ticket comments on `.design/**.md` open (decision-injector), maintains the STATE `<ticket_links>` block, and on cycle completion transitions the ticket + posts a **redacted** summary via the MCP tools. `size_budget: M`, `## Record`; tracker-wins conflict resolution.
|
|
38
|
+
- **`reference/ticket-sync.md`** — the `<ticket_links>` schema + read/write flow + the default status-transition map + redact + kill-switch contract; registered in `reference/registry.json`.
|
|
39
|
+
- **`connections/connections.md`** — a **ticket-sync** capability-matrix column + Linear/Jira rows + ToolSearch probes.
|
|
40
|
+
|
|
41
|
+
### Notes
|
|
42
|
+
|
|
43
|
+
- **No new runtime dependency** (MCP tools, no Linear/Jira SDK) and **no new egress** (`scan:outbound` unchanged — GDD calls MCP tools, not raw HTTP). Per-system kill-switch `GDD_DISABLE_LINEAR` / `GDD_DISABLE_JIRA`.
|
|
44
|
+
- 6-manifest lockstep at **v1.35.3** + `OFF_CADENCE_VERSIONS.add('1.35.3')` + the 21 live-pinned `manifests-version.txt` baselines forward-propagated 1.35.2 → 1.35.3.
|
|
45
|
+
- The 31.5 tarball golden was regenerated as a reviewed delta: **+4** (`connections/linear.md`, `connections/jira.md`, `agents/ticket-sync-agent.md`, `reference/ticket-sync.md`), zero removals.
|
|
46
|
+
- **This completes the parent Phase 35 (Team Surfaces Layer) — PR inline + notifications + ticket sync.**
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
7
50
|
## [1.35.2] - 2026-06-01
|
|
8
51
|
|
|
9
52
|
### Phase 35.2 — Team Surfaces: Notification Backplane (Slack + Discord)
|
package/README.md
CHANGED
|
@@ -142,6 +142,14 @@ After `/gdd:ship` opens the PR, the [`pr-commenter`](agents/pr-commenter.md) age
|
|
|
142
142
|
|
|
143
143
|
Routes pipeline events (verify-fail / audit-pass / ship) to **Slack** + **Discord** via incoming webhooks ([`connections/slack.md`](connections/slack.md) / [`connections/discord.md`](connections/discord.md)). The dispatcher ([`scripts/lib/notify/dispatch.cjs`](scripts/lib/notify/dispatch.cjs)) redacts every body at a single chokepoint, honors per-channel kill-switches (`GDD_DISABLE_SLACK` / `GDD_DISABLE_DISCORD`), and degrades to a noop when a webhook URL is unset — notification never blocks the pipeline. **No new runtime dependency** (injectable `fetch`, no Slack/Discord SDK). Routing: [`reference/notification-routing.md`](reference/notification-routing.md).
|
|
144
144
|
|
|
145
|
+
### Team surfaces — Ticket sync (v1.35.3)
|
|
146
|
+
|
|
147
|
+
Links a design cycle to a **Linear** or **Jira** ticket and keeps them in sync ([`connections/linear.md`](connections/linear.md) / [`connections/jira.md`](connections/jira.md), MCP-based). [`agents/ticket-sync-agent.md`](agents/ticket-sync-agent.md) surfaces the linked ticket's comments as context when a design file opens (via the decision-injector) and, on `/gdd:complete-cycle`, transitions the ticket + posts a **redacted** summary. Per-system kill-switches (`GDD_DISABLE_LINEAR` / `GDD_DISABLE_JIRA`); degrade-to-noop (never gates the cycle). **No new runtime dependency, no new egress** (MCP tools only). Contract: [`reference/ticket-sync.md`](reference/ticket-sync.md). **Completes the Team Surfaces layer** (PR inline + notifications + ticket sync).
|
|
148
|
+
|
|
149
|
+
### Design-artifact export (v1.35.5)
|
|
150
|
+
|
|
151
|
+
`/gdd:export <cycle> --format html|pdf|notion` packages a finished cycle's design output (`EXPERIENCE.md`, `DESIGN.md`, `DESIGN-VERIFICATION.md`, the decision log, screenshots) into a stakeholder-shareable artifact — for PMs/execs/brand who aren't in the repo. The [`build-html`](scripts/lib/export/build-html.cjs) assembler emits a **self-contained** HTML (inline CSS, base64-embedded screenshots, **zero external references**); `pdf` is the same HTML plus Paged.js-compatible `@page` print CSS you render yourself; `notion` writes a page via the Notion MCP ([`connections/notion.md`](connections/notion.md), degrade-to-HTML). Every artifact is **redacted**; `--pseudonymize` masks identity/paths/hostname for external sharing; `--pr` posts the HTML preview as a PR comment via `pr-commenter`. **No new runtime dependency** (D-02: pure assembler, no PDF/markdown library). Contract: [`reference/export-formats.md`](reference/export-formats.md).
|
|
152
|
+
|
|
145
153
|
### Previous releases
|
|
146
154
|
|
|
147
155
|
- **v1.26.0** — Headless Model Resolver (per-runtime tier→model map, `resolved_models` router field, per-runtime price tables, `reasoning-class` runtime-neutral alias).
|
package/SKILL.md
CHANGED
|
@@ -99,6 +99,7 @@ Each stage produces artifacts in `.design/` inside the current project.
|
|
|
99
99
|
| `watch-authorities [--refresh] [--since <date>] [--feed <name>] [--schedule <cadence>]` | `get-design-done:gdd-watch-authorities` | Run design-authority-watcher — fetch curated feeds, diff snapshot, classify new entries → `.design/authority-report.md` (consumed by `/gdd:reflect`) |
|
|
100
100
|
| `benchmark <component\|--wave N\|--list\|--refresh component>` | `get-design-done:gdd-benchmark` | Harvest + synthesize per-component design specs from 18 design systems → `reference/components/<name>.md` |
|
|
101
101
|
| `benchmark <component\|--wave N\|--list\|--refresh component>` | `get-design-done:gdd-benchmark` | Harvest + synthesize per-component design specs from 18 design systems → `reference/components/<name>.md` |
|
|
102
|
+
| `export <cycle> --format html\|pdf\|notion [--pseudonymize] [--pr]` | `get-design-done:gdd-export` | Phase 35.5 — package a finished cycle's design output into a stakeholder-shareable artifact (self-contained HTML / Paged.js-print PDF / Notion page); redacts always, `--pseudonymize` masks identity for external sharing, `--pr` posts the HTML preview via pr-commenter |
|
|
102
103
|
|
|
103
104
|
## Handoff Routing
|
|
104
105
|
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ticket-sync-agent
|
|
3
|
+
description: Bidirectional Linear/Jira ticket sync (Team Surfaces). Reads a linked ticket's comments as cycle context when a .design/**.md opens (via the decision-injector), and on cycle completion transitions the linked ticket + posts a redacted summary. MCP-based (mcp__linear__* / mcp__atlassian__*); outbound bodies redacted; degrades to a noop when the MCP is absent or disabled.
|
|
4
|
+
tools: Read, Bash, Grep, Glob, ToolSearch
|
|
5
|
+
color: green
|
|
6
|
+
default-tier: sonnet
|
|
7
|
+
tier-rationale: "Mechanical sync of an already-linked ticket via MCP tools; no design judgment — sonnet-tier, not an Opus plan."
|
|
8
|
+
size_budget: M
|
|
9
|
+
size_budget_rationale: "Honest tier sized to the ~150-line body (M cap 300). The agent states the read/write/STATE contract — surface ticket comments, maintain <ticket_links>, transition + summarize on completion, redact, kill-switch, degrade-to-noop — and DELEGATES the <ticket_links> schema + per-system MCP-tool detail to reference/ticket-sync.md + connections/{linear,jira}.md (the email-executor→email-design.md precedent)."
|
|
10
|
+
parallel-safe: false
|
|
11
|
+
typical-duration-seconds: 45
|
|
12
|
+
reads-only: false
|
|
13
|
+
writes:
|
|
14
|
+
- ".design/STATE.md"
|
|
15
|
+
- ".design/intel/insights.jsonl"
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
@reference/shared-preamble.md
|
|
19
|
+
|
|
20
|
+
# ticket-sync-agent
|
|
21
|
+
|
|
22
|
+
## Role
|
|
23
|
+
|
|
24
|
+
You keep a GDD design cycle and its linked **Linear/Jira ticket** in sync — the team's tracker reflects design progress without anyone re-typing it. You run on two triggers: (1) **read** — when a `.design/**.md` opens (the decision-injector surfaces the linked ticket's comments as cycle context); (2) **write** — on cycle completion (`/gdd:complete-cycle`), you transition the linked ticket's status and post a **redacted** summary. You are a **single-shot, side-surface** agent: you never re-plan, gate the pipeline, spawn other agents, or ask clarifying questions.
|
|
25
|
+
|
|
26
|
+
You are an **agent-prompt**, not a service: you reach Linear via `mcp__linear__*` and Jira via the Atlassian MCP (`mcp__atlassian__*`) — **ToolSearch-resolved**, no `@linear/sdk`/jira SDK, no raw HTTP from GDD scripts (D-02). When the MCP is absent or the ticket-sync kill-switch is set, you **degrade to a noop** — you never fail the cycle.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## Required Reading
|
|
31
|
+
|
|
32
|
+
- `.design/STATE.md` — the `<connections>` block (`linear`/`jira` status) + the `<ticket_links>` block (cycle → ticket map).
|
|
33
|
+
- `.design/DESIGN-VERIFICATION.md` + `.design/DESIGN-AUDIT.md` (write path) — the summary source.
|
|
34
|
+
- **`reference/ticket-sync.md`** — the authoritative `<ticket_links>` STATE schema + the read/write flow + the redact + kill-switch contract. You sync against this; you do not re-derive it.
|
|
35
|
+
- `connections/linear.md` / `connections/jira.md` — the per-system probe + MCP-tool detail.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Kill-switch + degrade (check FIRST)
|
|
40
|
+
|
|
41
|
+
1. **Kill-switch.** `GDD_DISABLE_LINEAR=1` / `GDD_DISABLE_JIRA=1` (env) OR `.design/config.json` `ticket_sync.<service>.enabled === false` → that system is a noop.
|
|
42
|
+
2. **Availability.** `ToolSearch({ query: "linear" })` / `ToolSearch({ query: "atlassian jira" })` — empty → `not_configured` → noop for that system. Resolve the exact tool names from the result before any call.
|
|
43
|
+
3. **Link present.** No `<ticket_links>` entry for this cycle → nothing to sync (read path: nothing to surface; write path: noop). Never error.
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Read path (decision-injector — `.design/**.md` open)
|
|
48
|
+
|
|
49
|
+
If the cycle has a `<ticket_links>` entry and the system is `available`: fetch the linked ticket's recent comments (via the resolved MCP tool), and surface them as cycle context (a short, **redacted** digest the decision-injector injects). Do not write anything on the read path.
|
|
50
|
+
|
|
51
|
+
## Write path (cycle completion)
|
|
52
|
+
|
|
53
|
+
On `/gdd:complete-cycle`, for each linked + available system: transition the ticket status per `reference/ticket-sync.md` (e.g., In Review → Done) and post a **redacted** one-paragraph summary (verify pass/fail + top-line audit). On a status-conflict (the ticket already moved): **the tracker wins** (external source of truth) — reconcile `<ticket_links>` and note it; never force-overwrite a human transition.
|
|
54
|
+
|
|
55
|
+
## Redaction (mandatory, D-04)
|
|
56
|
+
|
|
57
|
+
Every body written to a ticket (status comment, summary) passes through `scripts/lib/redact.cjs`. No raw artifact excerpt reaches Linear/Jira un-redacted.
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Execution Principles
|
|
62
|
+
|
|
63
|
+
1. **Side surface, not a gate.** Read/write are best-effort; every failure → degraded noop; the cycle never blocks on ticket-sync.
|
|
64
|
+
2. **Redact everything outbound (D-04).** Single chokepoint.
|
|
65
|
+
3. **Observable outcomes only.** Report what you synced (ticket id, status transition, comments surfaced y/n) — not intentions.
|
|
66
|
+
4. **`reference/ticket-sync.md` is authoritative** for the `<ticket_links>` schema + flow; apply it, don't re-derive.
|
|
67
|
+
5. **Decision authority:** in-context → proceed; out-of-context (architectural, contradicts a locked D-XX, a new external API) → Rule 4: STOP, note it, emit the marker.
|
|
68
|
+
6. **Single scope.** Touch only `.design/STATE.md` `<ticket_links>` + the record line; no repo files.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## Deviation Rules
|
|
73
|
+
|
|
74
|
+
- **Rule 1 — Bug:** a wrong ticket id, an un-redacted body, a malformed `<ticket_links>` write → fix inline.
|
|
75
|
+
- **Rule 2 — Missing Critical:** a linked ticket not transitioned on completion, redact not applied, the comment-surface skipped → add it.
|
|
76
|
+
- **Rule 3 — Blocking:** MCP absent / unauth, no link, kill-switch on → **degrade to noop** (not an error); note it.
|
|
77
|
+
- **Rule 4 — Architectural:** switching off MCP to a bundled SDK, adding a network dependency, auto-creating tickets → STOP, note it, emit the marker.
|
|
78
|
+
|
|
79
|
+
**Fix attempt limit:** 3 attempts per MCP call; then degrade + continue.
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
## Output
|
|
84
|
+
|
|
85
|
+
State: the system(s) synced, the ticket id(s), the status transition (write) or comments surfaced (read), and any degraded-noop reason. Do not modify repo files. Terminate with exactly:
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
## EXECUTION COMPLETE
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## Constraints
|
|
94
|
+
|
|
95
|
+
This agent MUST NOT:
|
|
96
|
+
|
|
97
|
+
- Run `git clean` (any flags).
|
|
98
|
+
- Fail the cycle — every failure degrades to a noop.
|
|
99
|
+
- Add a Linear/Jira SDK or any network dependency — MCP tools only (D-02).
|
|
100
|
+
- Post any body to a ticket without `scripts/lib/redact.cjs` (D-04).
|
|
101
|
+
- Create or triage tickets (sync an already-linked ticket only — issue creation is Phase 30).
|
|
102
|
+
- Force-overwrite a human status transition (the tracker wins on conflict).
|
|
103
|
+
- Modify the plan/context/connection index or any repo file; re-plan; spawn other agents; ask clarifying questions; or `git add .`/`-A`.
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
## Record
|
|
108
|
+
|
|
109
|
+
At run-end, append one JSONL line to `.design/intel/insights.jsonl`:
|
|
110
|
+
|
|
111
|
+
```json
|
|
112
|
+
{"ts":"<ISO-8601>","agent":"ticket-sync-agent","cycle":"<cycle from STATE.md>","stage":"<stage from STATE.md>","one_line_insight":"<system(s) synced + ticket id(s) + transition/comments-surfaced + any degraded reason>","artifacts_written":[".design/STATE.md"]}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Schema: `reference/schemas/insight-line.schema.json`.
|
|
116
|
+
|
|
117
|
+
## EXECUTION COMPLETE
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
This directory contains connection specifications for external tools and MCPs that the get-design-done pipeline integrates with. Each connection has its own spec file. This file is the index.
|
|
4
4
|
|
|
5
|
-
**Getting started:** run `/gdd:connections` for the interactive onboarding wizard — it probes all
|
|
5
|
+
**Getting started:** run `/gdd:connections` for the interactive onboarding wizard — it probes all 19 connections, recommends setup based on your project type, and walks you through installing each one (auto-run for reversible MCP adds, copy-command for everything else). You can also run `/gdd:connections list` for a read-only status check or `/gdd:connections <name>` to jump to a single connection's setup.
|
|
6
6
|
|
|
7
7
|
---
|
|
8
8
|
|
|
@@ -32,6 +32,9 @@ This directory contains connection specifications for external tools and MCPs th
|
|
|
32
32
|
| Mobbin | Active | [`connections/mobbin.md`](connections/mobbin.md) | **Paid** HTTP MCP `claude mcp add mobbin --transport http https://api.mobbin.com/mcp` (ToolSearch-only probe; auto-run-safe, OAuth); discover **Tier 2** — mobile/flow-level (D-01) |
|
|
33
33
|
| Slack | Active | [`connections/slack.md`](connections/slack.md) | **Notify** (Team Surfaces) — `SLACK_WEBHOOK_URL` incoming webhook; routed+redacted pipeline events; `GDD_DISABLE_SLACK` kill-switch; degrade-to-noop |
|
|
34
34
|
| Discord | Active | [`connections/discord.md`](connections/discord.md) | **Notify** (Team Surfaces) — `DISCORD_WEBHOOK_URL` channel webhook; parity with Slack; `GDD_DISABLE_DISCORD` kill-switch; degrade-to-noop |
|
|
35
|
+
| Linear | Active | [`connections/linear.md`](connections/linear.md) | **Ticket-sync** (Team Surfaces) — `mcp__linear__*` (ToolSearch probe); bidirectional cycle↔issue; redact + `GDD_DISABLE_LINEAR` kill-switch; degrade-to-noop |
|
|
36
|
+
| Jira | Active | [`connections/jira.md`](connections/jira.md) | **Ticket-sync** (Team Surfaces) — Atlassian MCP `mcp__atlassian__*` (ToolSearch probe); parity with Linear; `GDD_DISABLE_JIRA` kill-switch; degrade-to-noop |
|
|
37
|
+
| Notion | Active | [`connections/notion.md`](connections/notion.md) | **Export** write-path (not a pipeline stage) — `mcp__notion__*` (ToolSearch probe); `/gdd:export --format notion`; redact + `GDD_DISABLE_NOTION` kill-switch; degrade-to-HTML |
|
|
35
38
|
|
|
36
39
|
---
|
|
37
40
|
|
|
@@ -39,30 +42,32 @@ This directory contains connection specifications for external tools and MCPs th
|
|
|
39
42
|
|
|
40
43
|
Each cell describes what the connection contributes at that pipeline stage, or `—` if it is not used.
|
|
41
44
|
|
|
42
|
-
| Connection | scan | discover | plan | design | verify | canvas | generator | notify |
|
|
43
|
-
|
|
44
|
-
| gdd-state | STATE mutation (init position, probe_connections, add_decision) | STATE mutation (add_decision, add_must_have, transition gate) | STATE mutation (locked decisions, must_haves, transition gate) | STATE mutation (update_progress, resolve_blocker, transition gate) | STATE mutation (must_have pass/fail, add_blocker, set_status) | — | — | — |
|
|
45
|
-
| Figma | token augmentation via `get_variable_defs` (CONN-03) | decisions pre-populate via `get_variable_defs` (CONN-04) | — | write tokens/annotations/Code Connect via `use_figma` (FWR-01..04) | — | — | — | — |
|
|
46
|
-
| Refero | — | reference search via `mcp__refero__search`; fallback → awesome-design-md (CONN-05) | — | — | — | — | — | — |
|
|
47
|
-
| Preview | — | — | — | — | screenshots for `? VISUAL` checks (VIS-02) | — | — | — |
|
|
48
|
-
| Storybook | — | component inventory (STB-01) | change-risk via story count (STB-02) | `.stories.tsx` stub (STB-03) | a11y per story (STB-02) | — | — | — |
|
|
49
|
-
| Chromatic | — | — | change-risk scoping (CHR-02) | — | visual delta narration (CHR-01) | — | — | — |
|
|
50
|
-
| Graphify | — | — | dependency scoping (GRF-03) | — | orphan detection (GRF-04) | — | — | — |
|
|
51
|
-
| Pinterest | probe only | visual reference search via `pinterest_search`; fallback → Refero → awesome-design-md | — | — | — | — | — | — |
|
|
52
|
-
| Claude Design | bundle probe → `claude_design: available` | synthesizer handoff mode — parses bundle → D-XX decisions; discussant `--from-handoff` confirms | — (skipped in handoff) | — (skipped in handoff) | Handoff Faithfulness section; bidirectional write-back via figma-writer `implementation-status` mode | — | — | — |
|
|
53
|
-
| paper.design | — | canvas read: `get_selection`, `get_jsx`, `get_computed_styles` | — | paper-writer: annotate/tokenize/roundtrip | `get_screenshot` for `? VISUAL` | ✓ | — | — |
|
|
54
|
-
| pencil.dev | `.pen` discovery | `.pen` as canonical design source | — | pencil-writer: annotate/roundtrip | spec-vs-impl diff | ✓ | — | — |
|
|
55
|
-
| 21st.dev | — | prior-art gate: marketplace search before greenfield build | — | component-generator (21st impl) | — | — | ✓ | — |
|
|
56
|
-
| Magic Patterns | — | — | — | component-generator (magic-patterns impl) | preview_url → `? VISUAL` check | — | ✓ | — |
|
|
57
|
-
| OpenRouter | — | — | — | — | — | — | ✓ (model-router: tier→model resolution, all stages) | — |
|
|
58
|
-
| Xcode Simulator | — | — | — | native iOS code-gen target (swift-executor / emitSwift) | rendered SwiftUI snapshot when simulator available, else degrade to code-only structural audit (D-03) | — | — | — |
|
|
59
|
-
| Android Emulator | — | — | — | native Android code-gen target (compose-executor / emitCompose) | rendered Compose screenshot when emulator available, else degrade to code-only structural audit (D-03) | — | — | — |
|
|
60
|
-
| Litmus | — | — | — | email render-test target (email-executor) | cross-client rendered evidence when Litmus available, else degrade to the static email-HTML validator / code-only (D-03) | — | — | — |
|
|
61
|
-
| Print-Renderer | — | — | — | print render-test target (pdf-executor) | rendered PDF/page evidence when the print-render is available, else degrade to the static print-CSS validator / code-only (D-03) | — | — | — |
|
|
62
|
-
| Lazyweb | — | reference search via `lazyweb_search` (**Tier 1 — free, tried first**; D-01); complements refero/pinterest | — | — | — | — | — | — |
|
|
63
|
-
| Mobbin | — | reference search via mobbin tools (**Tier 2 — paid, mobile/flow-level**; D-01); complements refero/lazyweb | — | — | — | — | — | — |
|
|
64
|
-
| Slack | — | — | — | — | — | — | — | verify-fail/audit-pass/ship → Slack webhook (routed, redacted, degrade-to-noop; D-04/D-05) |
|
|
65
|
-
| Discord | — | — | — | — | — | — | — | parity with Slack — events → Discord webhook (routed, redacted, degrade-to-noop) |
|
|
45
|
+
| Connection | scan | discover | plan | design | verify | canvas | generator | notify | ticket-sync |
|
|
46
|
+
|-----------|------|----------|------|--------|--------|--------|-----------|--------|------------|
|
|
47
|
+
| gdd-state | STATE mutation (init position, probe_connections, add_decision) | STATE mutation (add_decision, add_must_have, transition gate) | STATE mutation (locked decisions, must_haves, transition gate) | STATE mutation (update_progress, resolve_blocker, transition gate) | STATE mutation (must_have pass/fail, add_blocker, set_status) | — | — | — | — |
|
|
48
|
+
| Figma | token augmentation via `get_variable_defs` (CONN-03) | decisions pre-populate via `get_variable_defs` (CONN-04) | — | write tokens/annotations/Code Connect via `use_figma` (FWR-01..04) | — | — | — | — | — |
|
|
49
|
+
| Refero | — | reference search via `mcp__refero__search`; fallback → awesome-design-md (CONN-05) | — | — | — | — | — | — | — |
|
|
50
|
+
| Preview | — | — | — | — | screenshots for `? VISUAL` checks (VIS-02) | — | — | — | — |
|
|
51
|
+
| Storybook | — | component inventory (STB-01) | change-risk via story count (STB-02) | `.stories.tsx` stub (STB-03) | a11y per story (STB-02) | — | — | — | — |
|
|
52
|
+
| Chromatic | — | — | change-risk scoping (CHR-02) | — | visual delta narration (CHR-01) | — | — | — | — |
|
|
53
|
+
| Graphify | — | — | dependency scoping (GRF-03) | — | orphan detection (GRF-04) | — | — | — | — |
|
|
54
|
+
| Pinterest | probe only | visual reference search via `pinterest_search`; fallback → Refero → awesome-design-md | — | — | — | — | — | — | — |
|
|
55
|
+
| Claude Design | bundle probe → `claude_design: available` | synthesizer handoff mode — parses bundle → D-XX decisions; discussant `--from-handoff` confirms | — (skipped in handoff) | — (skipped in handoff) | Handoff Faithfulness section; bidirectional write-back via figma-writer `implementation-status` mode | — | — | — | — |
|
|
56
|
+
| paper.design | — | canvas read: `get_selection`, `get_jsx`, `get_computed_styles` | — | paper-writer: annotate/tokenize/roundtrip | `get_screenshot` for `? VISUAL` | ✓ | — | — | — |
|
|
57
|
+
| pencil.dev | `.pen` discovery | `.pen` as canonical design source | — | pencil-writer: annotate/roundtrip | spec-vs-impl diff | ✓ | — | — | — |
|
|
58
|
+
| 21st.dev | — | prior-art gate: marketplace search before greenfield build | — | component-generator (21st impl) | — | — | ✓ | — | — |
|
|
59
|
+
| Magic Patterns | — | — | — | component-generator (magic-patterns impl) | preview_url → `? VISUAL` check | — | ✓ | — | — |
|
|
60
|
+
| OpenRouter | — | — | — | — | — | — | ✓ (model-router: tier→model resolution, all stages) | — | — |
|
|
61
|
+
| Xcode Simulator | — | — | — | native iOS code-gen target (swift-executor / emitSwift) | rendered SwiftUI snapshot when simulator available, else degrade to code-only structural audit (D-03) | — | — | — | — |
|
|
62
|
+
| Android Emulator | — | — | — | native Android code-gen target (compose-executor / emitCompose) | rendered Compose screenshot when emulator available, else degrade to code-only structural audit (D-03) | — | — | — | — |
|
|
63
|
+
| Litmus | — | — | — | email render-test target (email-executor) | cross-client rendered evidence when Litmus available, else degrade to the static email-HTML validator / code-only (D-03) | — | — | — | — |
|
|
64
|
+
| Print-Renderer | — | — | — | print render-test target (pdf-executor) | rendered PDF/page evidence when the print-render is available, else degrade to the static print-CSS validator / code-only (D-03) | — | — | — | — |
|
|
65
|
+
| Lazyweb | — | reference search via `lazyweb_search` (**Tier 1 — free, tried first**; D-01); complements refero/pinterest | — | — | — | — | — | — | — |
|
|
66
|
+
| Mobbin | — | reference search via mobbin tools (**Tier 2 — paid, mobile/flow-level**; D-01); complements refero/lazyweb | — | — | — | — | — | — | — |
|
|
67
|
+
| Slack | — | — | — | — | — | — | — | verify-fail/audit-pass/ship → Slack webhook (routed, redacted, degrade-to-noop; D-04/D-05) | — |
|
|
68
|
+
| Discord | — | — | — | — | — | — | — | parity with Slack — events → Discord webhook (routed, redacted, degrade-to-noop) | — |
|
|
69
|
+
| Linear | — | — | — | — | — | — | — | — | bidirectional cycle↔issue: read comments (decision-injector) + transition + redacted summary on completion (D-03) |
|
|
70
|
+
| Jira | — | — | — | — | — | — | — | — | parity with Linear — Atlassian MCP; transition + redacted summary on completion |
|
|
66
71
|
|
|
67
72
|
**Column definitions:**
|
|
68
73
|
|
|
@@ -168,6 +173,30 @@ Step E1 — ToolSearch check:
|
|
|
168
173
|
Write mobbin status to STATE.md <connections>.
|
|
169
174
|
```
|
|
170
175
|
|
|
176
|
+
**Notion probe (ToolSearch-only — export write-path, 35.5):**
|
|
177
|
+
|
|
178
|
+
```
|
|
179
|
+
Step J1 — ToolSearch({ query: "notion", max_results: 5 })
|
|
180
|
+
→ Empty / GDD_DISABLE_NOTION=1 → notion: not_configured (export degrades to the HTML format)
|
|
181
|
+
→ Non-empty → notion: available
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
**Linear probe (ToolSearch-only — ticket-sync):**
|
|
185
|
+
|
|
186
|
+
```
|
|
187
|
+
Step H1 — ToolSearch({ query: "linear", max_results: 5 })
|
|
188
|
+
→ Empty / GDD_DISABLE_LINEAR=1 → linear: not_configured
|
|
189
|
+
→ Non-empty → linear: available
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
**Jira probe (ToolSearch-only — ticket-sync, Atlassian MCP):**
|
|
193
|
+
|
|
194
|
+
```
|
|
195
|
+
Step I1 — ToolSearch({ query: "atlassian jira", max_results: 5 })
|
|
196
|
+
→ Empty / GDD_DISABLE_JIRA=1 → jira: not_configured
|
|
197
|
+
→ Non-empty → jira: available
|
|
198
|
+
```
|
|
199
|
+
|
|
171
200
|
**Slack probe (env-based, no MCP):**
|
|
172
201
|
|
|
173
202
|
```
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Jira — Connection Specification
|
|
2
|
+
|
|
3
|
+
This file is the connection specification for Jira within the get-design-done pipeline — the parity of `connections/linear.md`. See `connections/connections.md` for the index + capability matrix (the jira row is added at the 35.3 closeout).
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Jira is a **bidirectional ticket-sync surface** (Team Surfaces layer) — identical contract to Linear, only the MCP server differs. GDD links a design cycle to a Jira issue, **reads** the issue's comments as context when a `.design/**.md` opens, and **writes** a redacted status transition + summary on cycle completion. MCP-based (the **Atlassian MCP**, `mcp__atlassian__*`) — GDD calls MCP tools, not raw HTTP; no new outbound egress.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Setup
|
|
12
|
+
|
|
13
|
+
**Prerequisites:** the Atlassian MCP server connected to your Jira site (OAuth on first use). No GDD-held token.
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
# register the Atlassian MCP per Atlassian's MCP docs, then restart the session
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
(Alternative for non-MCP runtimes: `JIRA_BASE_URL` + `JIRA_API_TOKEN` env — documented for parity; GDD ships MCP-based.)
|
|
20
|
+
|
|
21
|
+
**Verification:**
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
ToolSearch({ query: "atlassian jira", max_results: 10 })
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Expect Atlassian/Jira issue/comment tools (`mcp__atlassian__*`). If empty → `jira: not_configured`. Verify exact tool names via ToolSearch; do not hardcode.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## What GDD does (bidirectional, via `agents/ticket-sync-agent.md`)
|
|
32
|
+
|
|
33
|
+
- **READ (decision-injector):** on `.design/**.md` open, the linked Jira issue's recent comments are surfaced as cycle context.
|
|
34
|
+
- **WRITE (cycle completion):** on `/gdd:complete-cycle`, the agent transitions the linked issue (e.g., In Review → Done) and posts a **redacted** summary. The link map lives in STATE `<ticket_links>` (`jira:PROJ-45`).
|
|
35
|
+
|
|
36
|
+
See `reference/ticket-sync.md` for the `<ticket_links>` schema + the read/write contract.
|
|
37
|
+
|
|
38
|
+
## Redaction + kill-switch + degrade
|
|
39
|
+
|
|
40
|
+
- Every body written to Jira passes through `scripts/lib/redact.cjs`.
|
|
41
|
+
- Kill-switch: `GDD_DISABLE_JIRA=1` (env) or `.design/config.json` `"ticket_sync": { "jira": { "enabled": false } }`. `gsd-health` surfaces it.
|
|
42
|
+
- **Degrade-to-noop:** `jira: not_configured` / disabled / an MCP error → skip (no error); the pipeline never blocks (D-04).
|
|
43
|
+
|
|
44
|
+
## STATE.md integration + probe
|
|
45
|
+
|
|
46
|
+
```xml
|
|
47
|
+
<connections>
|
|
48
|
+
jira: not_configured
|
|
49
|
+
</connections>
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
| Value | Meaning |
|
|
53
|
+
|---|---|
|
|
54
|
+
| `available` | ToolSearch returned `mcp__atlassian__*` tools AND not disabled |
|
|
55
|
+
| `unavailable` | tools present but a call errored |
|
|
56
|
+
| `not_configured` | ToolSearch empty — Atlassian MCP not registered |
|
|
57
|
+
|
|
58
|
+
**Probe (ToolSearch-only):** `ToolSearch({ query: "atlassian jira", max_results: 5 })` → empty → `not_configured`, non-empty → `available`.
|
|
59
|
+
|
|
60
|
+
## Anti-pattern
|
|
61
|
+
|
|
62
|
+
Don't auto-transition to an undefined workflow state; don't post un-redacted excerpts; don't create/triage issues (Phase 30). Conflict resolution: when the Jira status and the GDD `<ticket_links>` state diverge, **Jira wins** (external source of truth) and GDD reconciles on next sync with an explicit notice (ROADMAP open-Q default). Linear is the sibling surface (`connections/linear.md`).
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Linear — Connection Specification
|
|
2
|
+
|
|
3
|
+
This file is the connection specification for Linear within the get-design-done pipeline. See `connections/connections.md` for the full index + capability matrix (the linear row is added at the 35.3 closeout).
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Linear is a **bidirectional ticket-sync surface** (Team Surfaces layer). GDD links a design cycle to a Linear issue, **reads** the issue's comments as context when a `.design/**.md` file opens, and **writes** a redacted status update + summary on cycle completion. MCP-based (`mcp__linear__*`) — GDD calls MCP tools, not raw HTTP, so there is no new outbound egress.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Setup
|
|
12
|
+
|
|
13
|
+
**Prerequisites:** the Linear MCP server connected to your workspace (OAuth on first use). No GDD-held token.
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
# register the Linear MCP per Linear's MCP docs, then restart the session
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
(Alternative for non-MCP runtimes: a `LINEAR_API_KEY` env — documented for parity, but GDD ships MCP-based.)
|
|
20
|
+
|
|
21
|
+
**Verification:**
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
ToolSearch({ query: "linear", max_results: 10 })
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Expect Linear issue/comment tools (`mcp__linear__*`). If empty → `linear: not_configured`. Verify exact tool names via ToolSearch before calling; do not hardcode.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## What GDD does (bidirectional, via `agents/ticket-sync-agent.md`)
|
|
32
|
+
|
|
33
|
+
- **READ (decision-injector):** when a `.design/**.md` opens, the linked Linear issue's recent comments are surfaced as cycle context (so a decision made in the ticket reaches the pipeline).
|
|
34
|
+
- **WRITE (cycle completion):** on `/gdd:complete-cycle`, the agent updates the linked issue's status (e.g., In Review → Done) and posts a **redacted** one-paragraph summary (verify result + top-line audit). The link map lives in STATE `<ticket_links>`.
|
|
35
|
+
|
|
36
|
+
See `reference/ticket-sync.md` for the `<ticket_links>` schema + the read/write contract.
|
|
37
|
+
|
|
38
|
+
## Redaction + kill-switch + degrade
|
|
39
|
+
|
|
40
|
+
- Every body written to Linear passes through `scripts/lib/redact.cjs` (the single chokepoint).
|
|
41
|
+
- Kill-switch: `GDD_DISABLE_LINEAR=1` (env) or `.design/config.json` `"ticket_sync": { "linear": { "enabled": false } }`. `gsd-health` surfaces it.
|
|
42
|
+
- **Degrade-to-noop:** `linear: not_configured` / disabled / an MCP error → skip ticket-sync (no error); the pipeline never blocks on it (D-04).
|
|
43
|
+
|
|
44
|
+
## STATE.md integration + probe
|
|
45
|
+
|
|
46
|
+
```xml
|
|
47
|
+
<connections>
|
|
48
|
+
linear: not_configured
|
|
49
|
+
</connections>
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
| Value | Meaning |
|
|
53
|
+
|---|---|
|
|
54
|
+
| `available` | ToolSearch returned `mcp__linear__*` tools AND not disabled |
|
|
55
|
+
| `unavailable` | tools present but a call errored (auth/rate) |
|
|
56
|
+
| `not_configured` | ToolSearch empty — Linear MCP not registered |
|
|
57
|
+
|
|
58
|
+
**Probe (ToolSearch-only — no token cost):** `ToolSearch({ query: "linear", max_results: 5 })` → empty → `not_configured`, non-empty → `available`. Which stages probe: cycle entry (decision-injector read) + complete-cycle (status write).
|
|
59
|
+
|
|
60
|
+
## Anti-pattern
|
|
61
|
+
|
|
62
|
+
Don't auto-transition a ticket to a state the team didn't define; don't post raw artifact excerpts (always redacted); don't create/triage issues (Phase 30 territory — this is sync of an already-linked ticket). Jira is the parity surface (`connections/jira.md`); the contract is identical.
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# Notion — Connection Specification
|
|
2
|
+
|
|
3
|
+
This file is the connection specification for Notion within the get-design-done pipeline. See `connections/connections.md` for the index + capability matrix (the notion row is added at the 35.5 closeout).
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Notion is the **export write-path** for `/gdd:export --format notion` (Phase 35.5). GDD generates a Notion page from a completed cycle's design artifacts — a stakeholder-shareable design-review packet. MCP-based (`mcp__notion__*`) — GDD calls MCP tools, not raw HTTP; no bundled Notion SDK, no new outbound egress. Outbound content is redacted; degrades to the self-contained HTML format when Notion is absent or disabled.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Setup
|
|
12
|
+
|
|
13
|
+
**Prerequisites:** the Notion MCP server connected to your workspace (OAuth on first use). No GDD-held token.
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
# register the Notion MCP per Notion's MCP docs, then restart the session
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
**Verification:**
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
ToolSearch({ query: "notion", max_results: 10 })
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Expect Notion page/block tools (`mcp__notion__*`). If empty → `notion: not_configured`. Verify exact tool names via ToolSearch; do not hardcode.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## What GDD does
|
|
30
|
+
|
|
31
|
+
On `/gdd:export --format notion`, GDD creates a page from the export source set (EXPERIENCE.md + DESIGN.md + DESIGN-VERIFICATION.md + decisions + screenshots): headings → toggle/section blocks, screenshots → image-upload blocks. Every text block is **redacted** (`scripts/lib/redact.cjs`); `--pseudonymize` additionally masks identity. Write-only (export); GDD does not read/sync Notion content.
|
|
32
|
+
|
|
33
|
+
## Redaction + kill-switch + degrade
|
|
34
|
+
|
|
35
|
+
- Every block body passes through `scripts/lib/redact.cjs` (the single chokepoint).
|
|
36
|
+
- Kill-switch: `GDD_DISABLE_NOTION=1` (env) or `.design/config.json` `"export": { "notion": { "enabled": false } }`. `gsd-health` surfaces it.
|
|
37
|
+
- **Degrade:** `notion: not_configured` / disabled / an MCP error → `/gdd:export` falls back to the self-contained `html` format + a note (the export never fails on Notion absence — D-03/D-07).
|
|
38
|
+
|
|
39
|
+
## STATE.md integration + probe
|
|
40
|
+
|
|
41
|
+
```xml
|
|
42
|
+
<connections>
|
|
43
|
+
notion: not_configured
|
|
44
|
+
</connections>
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
| Value | Meaning |
|
|
48
|
+
|---|---|
|
|
49
|
+
| `available` | ToolSearch returned `mcp__notion__*` tools AND not disabled |
|
|
50
|
+
| `unavailable` | tools present but a call errored (auth/rate) |
|
|
51
|
+
| `not_configured` | ToolSearch empty — Notion MCP not registered |
|
|
52
|
+
|
|
53
|
+
**Probe (ToolSearch-only):** `ToolSearch({ query: "notion", max_results: 5 })` → empty → `not_configured`, non-empty → `available`. Which stages probe: the export skill only (Notion is an export target, not a pipeline-stage connection).
|
|
54
|
+
|
|
55
|
+
## Anti-pattern
|
|
56
|
+
|
|
57
|
+
Don't post un-redacted artifacts; don't treat Notion as a read/sync source (export write-path only — bidirectional sync is out of scope); don't hard-require Notion (always degrade to the HTML file). Confluence is explicitly out of scope this phase (Notion-only).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hegemonart/get-design-done",
|
|
3
|
-
"version": "1.35.
|
|
3
|
+
"version": "1.35.5",
|
|
4
4
|
"description": "A design-quality pipeline for AI coding agents: brief, plan, implement, and verify UI work against your design system.",
|
|
5
5
|
"author": "Hegemon",
|
|
6
6
|
"homepage": "https://github.com/hegemonart/get-design-done",
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Export Formats — the `/gdd:export` contract
|
|
2
|
+
|
|
3
|
+
How `/gdd:export <cycle> --format html|pdf|notion [--pseudonymize] [--pr]` turns a completed cycle's in-repo design output into a stakeholder-shareable artifact. Dep-free: the HTML/PDF assembler is pure (`scripts/lib/export/build-html.cjs`); Notion is MCP-based; no `paged`/`puppeteer`/`pdfkit`/markdown-lib runtime.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Source set (what gets packaged)
|
|
8
|
+
|
|
9
|
+
In cycle order: `EXPERIENCE.md` (Phase 19.5 cross-cycle memory) · `.design/DESIGN.md` · `.design/DESIGN-VERIFICATION.md` · `.design/DESIGN-AUDIT.md` (if present) · the decision log (`D-XX`) · Preview/Chromatic screenshots (base64-embedded for html/pdf).
|
|
10
|
+
|
|
11
|
+
## Formats
|
|
12
|
+
|
|
13
|
+
- **`html`** (default) — `buildHtml({ title, subtitle, sections, images })` → a **single self-contained HTML** file: inline `<style>`, base64-embedded images, **zero external references** (safe to email / drop in Drive). Written to `.design/export/<cycle>.html`.
|
|
14
|
+
- **`pdf`** — the same `buildHtml({ ..., print: true })` (adds a Paged.js-compatible `@page` print stylesheet). Written to `.design/export/<cycle>.print.html`; **the user renders it** via Paged.js / headless-Chrome. GDD ships **no** PDF runtime (the print-executor precedent, D-02).
|
|
15
|
+
- **`notion`** — a Notion page via the Notion MCP (`connections/notion.md`): headings → section/toggle blocks, screenshots → image-upload blocks. Degrades to the `html` file when the Notion MCP is `not_configured`/disabled.
|
|
16
|
+
|
|
17
|
+
## Privacy (redact always; pseudonymize opt-in)
|
|
18
|
+
|
|
19
|
+
Every section is passed through `scripts/lib/redact.cjs` (secrets — the floor). `--pseudonymize` additionally applies `scripts/lib/pseudonymize.cjs` (git identity / paths / hostname / repo origin) — use it when sharing externally. Default (no flag) = redact only.
|
|
20
|
+
|
|
21
|
+
## PR integration (`--pr`)
|
|
22
|
+
|
|
23
|
+
`--pr` hands the generated self-contained HTML preview to `agents/pr-commenter.md` (Phase 35.1) to post as a PR comment — degrade-to-noop when there's no PR or pr-commenter is unavailable (never blocks the export).
|
|
24
|
+
|
|
25
|
+
## Self-contained guarantee (html/pdf)
|
|
26
|
+
|
|
27
|
+
`build-html.cjs` emits no external `src=`/`<link>`/`<script>` — CSS is inline, images are base64 `data:` URIs. Content links (`<a href="https://…">`) are preserved (they're references, not load-bearing resources). Deterministic: same input → byte-identical output (the regression baseline freezes a fixture render).
|
|
28
|
+
|
|
29
|
+
## Out of scope
|
|
30
|
+
|
|
31
|
+
Confluence (Notion-only this phase); Figma export (Phase 31); video walkthroughs; collaborative editing (read-only handoff); bidirectional Notion sync (export write-path only); a bundled PDF/markdown runtime (D-02).
|
package/reference/registry.json
CHANGED
|
@@ -923,6 +923,20 @@
|
|
|
923
923
|
"type": "heuristic",
|
|
924
924
|
"phase": 35.2,
|
|
925
925
|
"description": "Phase 35.2 notification-backplane routing contract — event→channel routing (verify_fail/audit_pass/ship → slack/discord, overridable via .design/config.json#notifications.routing), the mandatory scripts/lib/redact.cjs chokepoint on every outbound body, per-channel kill-switches (GDD_DISABLE_SLACK/GDD_DISABLE_DISCORD), and the injectable-fetchImpl + degrade-to-noop transport consumed by scripts/lib/notify/dispatch.cjs (allowlisted under the 33.5 outbound gate)."
|
|
926
|
+
},
|
|
927
|
+
{
|
|
928
|
+
"name": "ticket-sync",
|
|
929
|
+
"path": "reference/ticket-sync.md",
|
|
930
|
+
"type": "heuristic",
|
|
931
|
+
"phase": 35.3,
|
|
932
|
+
"description": "Phase 35.3 ticket-sync contract — the STATE <ticket_links> cycle→ticket map, the bidirectional read (decision-injector surfaces linked-ticket comments on .design open) + write (transition + redacted summary on cycle completion) flow via MCP tools (mcp__linear__* / mcp__atlassian__*; no SDK, no raw HTTP), the default status-transition map, tracker-wins conflict resolution, the mandatory scripts/lib/redact.cjs chokepoint, and the GDD_DISABLE_LINEAR/GDD_DISABLE_JIRA kill-switches. Consumed by agents/ticket-sync-agent.md."
|
|
933
|
+
},
|
|
934
|
+
{
|
|
935
|
+
"name": "export-formats",
|
|
936
|
+
"path": "reference/export-formats.md",
|
|
937
|
+
"type": "heuristic",
|
|
938
|
+
"phase": 35.5,
|
|
939
|
+
"description": "Phase 35.5 /gdd:export contract — the source set (EXPERIENCE.md + DESIGN.md + DESIGN-VERIFICATION.md + decisions + screenshots), the three formats (self-contained HTML via scripts/lib/export/build-html.cjs, Paged.js-compatible print PDF rendered by the user, Notion page via the Notion MCP), mandatory scripts/lib/redact.cjs + the --pseudonymize opt-in (scripts/lib/pseudonymize.cjs), and the --pr hand-off to pr-commenter. No bundled PDF/markdown runtime (D-02)."
|
|
926
940
|
}
|
|
927
941
|
]
|
|
928
942
|
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# Ticket Sync — the `<ticket_links>` contract for `agents/ticket-sync-agent.md`
|
|
2
|
+
|
|
3
|
+
How GDD links a design cycle to a Linear/Jira ticket, reads its comments as context, and writes a redacted status update on completion — all via MCP tools (no raw HTTP, no bundled SDK). The per-system probe + tool detail live in `connections/linear.md` + `connections/jira.md`.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## The `<ticket_links>` STATE block
|
|
8
|
+
|
|
9
|
+
GDD records the cycle→ticket map in `.design/STATE.md`:
|
|
10
|
+
|
|
11
|
+
```xml
|
|
12
|
+
<ticket_links>
|
|
13
|
+
cycle: <cycle-id>
|
|
14
|
+
linear: ABC-123
|
|
15
|
+
jira: PROJ-45
|
|
16
|
+
</ticket_links>
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
- A cycle may link a Linear issue, a Jira issue, both, or neither.
|
|
20
|
+
- The link is set by the user (or a future `/gdd:link-ticket`); the agent **reads** it, never invents a link.
|
|
21
|
+
- No link for the current cycle → the agent is a noop on both paths.
|
|
22
|
+
|
|
23
|
+
## Read path (decision-injector — `.design/**.md` open)
|
|
24
|
+
|
|
25
|
+
When a design artifact opens and the cycle has a link to an `available` system, the agent fetches the linked ticket's recent comments (via the resolved `mcp__linear__*` / `mcp__atlassian__*` tool) and surfaces a short **redacted** digest as cycle context — so a decision made in the ticket reaches the pipeline. Read-only; nothing is written on this path.
|
|
26
|
+
|
|
27
|
+
## Write path (`/gdd:complete-cycle`)
|
|
28
|
+
|
|
29
|
+
On cycle completion, for each linked + available system:
|
|
30
|
+
|
|
31
|
+
1. **Transition** the ticket status — the default map (overridable in `.design/config.json#ticket_sync.transitions`):
|
|
32
|
+
|
|
33
|
+
| Cycle outcome | Ticket transition |
|
|
34
|
+
|---|---|
|
|
35
|
+
| verify passed | → Done / Closed |
|
|
36
|
+
| verify failed | → In Progress (reopened) |
|
|
37
|
+
| shipped (PR open) | → In Review |
|
|
38
|
+
|
|
39
|
+
2. **Post** a **redacted** one-paragraph summary (verify pass/fail + top-line audit + PR URL if present) via the ticket's comment tool.
|
|
40
|
+
|
|
41
|
+
## Conflict resolution (tracker wins)
|
|
42
|
+
|
|
43
|
+
If the ticket's current status diverges from what `<ticket_links>` last recorded (a human moved it), **the tracker is the source of truth** — the agent reconciles `<ticket_links>` to the tracker's state and posts an explicit "GDD observed an external status change; reconciling" note, rather than force-overwriting the human transition. (ROADMAP Phase-35 open-Q default.)
|
|
44
|
+
|
|
45
|
+
## Redaction (mandatory)
|
|
46
|
+
|
|
47
|
+
Every body written to a ticket — the status comment, the summary — passes through `scripts/lib/redact.cjs` (11 secret/token patterns) before the MCP call. The agent is the single egress chokepoint; no raw artifact excerpt reaches Linear/Jira.
|
|
48
|
+
|
|
49
|
+
## Kill-switches (per system)
|
|
50
|
+
|
|
51
|
+
A system is a noop when **either** `GDD_DISABLE_LINEAR=1` / `GDD_DISABLE_JIRA=1` (env) **or** `.design/config.json` `ticket_sync.<service>.enabled === false`. `gsd-health` surfaces each system's state (mirrors Phase 30 / 35.1 / 35.2).
|
|
52
|
+
|
|
53
|
+
## Degrade-to-noop (never blocks the cycle)
|
|
54
|
+
|
|
55
|
+
`not_configured` (MCP absent) / disabled / no link / an MCP error → the agent skips that system and **never throws** into the pipeline — ticket-sync is a best-effort side surface, never a cycle gate (D-04).
|
|
56
|
+
|
|
57
|
+
## Out of scope (per Phase 35 split)
|
|
58
|
+
|
|
59
|
+
PR-inline (35.1); Slack/Discord notifications (35.2); issue **creation**/triage (Phase 30 territory — this is sync of an already-linked ticket); a bundled Linear/Jira SDK (MCP-based, D-02); `pseudonymize.cjs` (Phase 30 — redact for secrets is the must here); Microsoft Teams / Asana.
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
/**
|
|
3
|
+
* scripts/lib/export/build-html.cjs — Phase 35.5 self-contained HTML assembler.
|
|
4
|
+
*
|
|
5
|
+
* Pure + dep-free (D-02): no markdown library, no `paged`/`puppeteer`/`pdfkit`. Produces a
|
|
6
|
+
* SINGLE self-contained HTML string — inline <style>, base64-embedded images, ZERO external
|
|
7
|
+
* references — for the /gdd:export html + pdf formats (pdf = the same HTML + Paged.js-compatible
|
|
8
|
+
* @page print CSS the user renders, never a bundled PDF runtime). Deterministic: same input →
|
|
9
|
+
* byte-identical output (hermetic tests, D-07).
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
// Escapes the 5 HTML-significant characters so the result is safe in BOTH element
|
|
13
|
+
// content AND double/single-quoted attribute values (e.g. <img alt="...">). Escaping
|
|
14
|
+
// the quotes is what makes attribute interpolation injection-safe (js/incomplete-html-
|
|
15
|
+
// attribute-sanitization). Order matters: & first so the entity ampersands aren't re-escaped.
|
|
16
|
+
function esc(s) {
|
|
17
|
+
return String(s)
|
|
18
|
+
.replace(/&/g, '&')
|
|
19
|
+
.replace(/</g, '<')
|
|
20
|
+
.replace(/>/g, '>')
|
|
21
|
+
.replace(/"/g, '"')
|
|
22
|
+
.replace(/'/g, ''');
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
// Minimal, deterministic inline-markdown → HTML (escapes first, then re-introduces tags for
|
|
26
|
+
// the constructs GDD's .design markdown uses): `code`, **bold**, *italic*, [text](url).
|
|
27
|
+
function inline(text) {
|
|
28
|
+
let s = esc(text);
|
|
29
|
+
s = s.replace(/`([^`]+)`/g, (_, c) => `<code>${c}</code>`);
|
|
30
|
+
s = s.replace(/\*\*([^*]+)\*\*/g, (_, b) => `<strong>${b}</strong>`);
|
|
31
|
+
s = s.replace(/(^|[^*])\*([^*\n]+)\*/g, (_, p, i) => `${p}<em>${i}</em>`);
|
|
32
|
+
s = s.replace(/\[([^\]]+)\]\((https?:\/\/[^)\s]+|#[^)\s]*)\)/g, (_, t, u) => `<a href="${u}">${t}</a>`);
|
|
33
|
+
return s;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
// Block-level markdown → HTML. Handles headings, fenced code, ul/ol, blockquote, hr, images
|
|
37
|
+
// (resolved to base64 data URIs from the images map), and paragraphs.
|
|
38
|
+
function mdToHtml(md, images) {
|
|
39
|
+
const lines = String(md).replace(/\r\n/g, '\n').split('\n');
|
|
40
|
+
const out = [];
|
|
41
|
+
let i = 0;
|
|
42
|
+
const imgByName = new Map((images || []).map((im) => [im.name, im.dataUri]));
|
|
43
|
+
while (i < lines.length) {
|
|
44
|
+
const line = lines[i];
|
|
45
|
+
if (/^```/.test(line)) { // fenced code
|
|
46
|
+
const buf = []; i++;
|
|
47
|
+
while (i < lines.length && !/^```/.test(lines[i])) { buf.push(esc(lines[i])); i++; }
|
|
48
|
+
i++; out.push(`<pre><code>${buf.join('\n')}</code></pre>`); continue;
|
|
49
|
+
}
|
|
50
|
+
const h = line.match(/^(#{1,4})\s+(.*)$/);
|
|
51
|
+
if (h) { const n = h[1].length; out.push(`<h${n}>${inline(h[2])}</h${n}>`); i++; continue; }
|
|
52
|
+
if (/^\s*([-*])\s+/.test(line)) { // unordered list
|
|
53
|
+
const items = [];
|
|
54
|
+
while (i < lines.length && /^\s*([-*])\s+/.test(lines[i])) { items.push(`<li>${inline(lines[i].replace(/^\s*[-*]\s+/, ''))}</li>`); i++; }
|
|
55
|
+
out.push(`<ul>${items.join('')}</ul>`); continue;
|
|
56
|
+
}
|
|
57
|
+
if (/^\s*\d+\.\s+/.test(line)) { // ordered list
|
|
58
|
+
const items = [];
|
|
59
|
+
while (i < lines.length && /^\s*\d+\.\s+/.test(lines[i])) { items.push(`<li>${inline(lines[i].replace(/^\s*\d+\.\s+/, ''))}</li>`); i++; }
|
|
60
|
+
out.push(`<ol>${items.join('')}</ol>`); continue;
|
|
61
|
+
}
|
|
62
|
+
if (/^>\s?/.test(line)) { out.push(`<blockquote>${inline(line.replace(/^>\s?/, ''))}</blockquote>`); i++; continue; }
|
|
63
|
+
if (/^(---+|\*\*\*+)\s*$/.test(line)) { out.push('<hr>'); i++; continue; }
|
|
64
|
+
const img = line.match(/^!\[([^\]]*)\]\(([^)\s]+)\)\s*$/); // image — resolve to base64
|
|
65
|
+
if (img) {
|
|
66
|
+
const src = imgByName.get(img[2]) || (img[2].startsWith('data:') ? img[2] : '');
|
|
67
|
+
if (src) out.push(`<figure><img alt="${esc(img[1])}" src="${src}"><figcaption>${esc(img[1])}</figcaption></figure>`);
|
|
68
|
+
i++; continue;
|
|
69
|
+
}
|
|
70
|
+
if (line.trim() === '') { i++; continue; }
|
|
71
|
+
// paragraph — gather consecutive non-blank, non-block lines
|
|
72
|
+
const para = [line]; i++;
|
|
73
|
+
while (i < lines.length && lines[i].trim() !== '' && !/^(#{1,4}\s|```|>\s?|\s*[-*]\s|\s*\d+\.\s|!\[)/.test(lines[i])) { para.push(lines[i]); i++; }
|
|
74
|
+
out.push(`<p>${inline(para.join(' '))}</p>`);
|
|
75
|
+
}
|
|
76
|
+
return out.join('\n');
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
const SCREEN_CSS = `:root{--ink:#1a1a1a;--muted:#6b7280;--rule:#e5e7eb;--accent:#2563eb}*{box-sizing:border-box}body{margin:0;font:16px/1.6 -apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,sans-serif;color:var(--ink);background:#fff}main{max-width:820px;margin:0 auto;padding:48px 24px}h1{font-size:2rem;line-height:1.2;margin:0 0 .5rem}h2{font-size:1.4rem;margin:2rem 0 .5rem;padding-top:1rem;border-top:1px solid var(--rule)}h3{font-size:1.1rem;margin:1.5rem 0 .4rem}p{margin:.6rem 0}code{background:#f3f4f6;padding:.1em .35em;border-radius:4px;font-size:.9em}pre{background:#f8f9fb;border:1px solid var(--rule);border-radius:8px;padding:14px;overflow:auto}pre code{background:none;padding:0}a{color:var(--accent)}blockquote{margin:.8rem 0;padding:.4rem 1rem;border-left:3px solid var(--accent);color:var(--muted)}figure{margin:1rem 0}img{max-width:100%;height:auto;border:1px solid var(--rule);border-radius:8px}figcaption{font-size:.85rem;color:var(--muted);margin-top:.3rem}hr{border:none;border-top:1px solid var(--rule);margin:2rem 0}.gdd-meta{color:var(--muted);font-size:.9rem;margin-bottom:2rem}`;
|
|
80
|
+
const PRINT_CSS = `@page{size:A4;margin:18mm 16mm}@media print{h2{break-before:auto}figure,pre,blockquote{break-inside:avoid}main{max-width:none;padding:0}a{color:var(--ink);text-decoration:underline}}`;
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* buildHtml({ title, subtitle?, sections:[{heading, markdown}], images?:[{name, dataUri}], print? })
|
|
84
|
+
* → a single self-contained HTML document string (inline CSS, base64 images, no external refs).
|
|
85
|
+
*/
|
|
86
|
+
function buildHtml(opts = {}) {
|
|
87
|
+
const title = esc(opts.title || 'GDD Design Export');
|
|
88
|
+
const css = SCREEN_CSS + (opts.print ? PRINT_CSS : '');
|
|
89
|
+
const body = (opts.sections || [])
|
|
90
|
+
.map((sec) => `<section>\n<h2>${esc(sec.heading)}</h2>\n${mdToHtml(sec.markdown || '', opts.images)}\n</section>`)
|
|
91
|
+
.join('\n');
|
|
92
|
+
const subtitle = opts.subtitle ? `<p class="gdd-meta">${esc(opts.subtitle)}</p>` : '';
|
|
93
|
+
return `<!DOCTYPE html>
|
|
94
|
+
<html lang="en">
|
|
95
|
+
<head>
|
|
96
|
+
<meta charset="utf-8">
|
|
97
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
98
|
+
<title>${title}</title>
|
|
99
|
+
<style>${css}</style>
|
|
100
|
+
</head>
|
|
101
|
+
<body>
|
|
102
|
+
<main>
|
|
103
|
+
<h1>${title}</h1>
|
|
104
|
+
${subtitle}
|
|
105
|
+
${body}
|
|
106
|
+
</main>
|
|
107
|
+
</body>
|
|
108
|
+
</html>
|
|
109
|
+
`;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
module.exports = { buildHtml, mdToHtml, inline, esc };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: gdd-connections
|
|
3
|
-
description: "Interactive onboarding wizard for the
|
|
3
|
+
description: "Interactive onboarding wizard for the 19 external integrations the pipeline supports — probes all (`figma`, `refero`, `preview`, `storybook`, `chromatic`, `graphify`, `pinterest`, `claude-design`, `paper-design`, `pencil-dev`, `21st-dev`, `magic-patterns`, `lazyweb`, `mobbin`, `slack`, `discord`, `linear`, `jira`, `notion`), recommends based on project type, walks the user through setup (auto-run MCP install or copy-command fallback), writes results to `STATE.md <connections>`. Use after `/gdd:new-project` or whenever the user wants to add, inspect, or skip a connection. Re-runnable anytime."
|
|
4
4
|
argument-hint: "[list | <connection-name> | --auto]"
|
|
5
5
|
user-invocable: true
|
|
6
6
|
tools: Read, Write, Bash, Glob, Grep, AskUserQuestion, ToolSearch
|
|
@@ -8,11 +8,11 @@ tools: Read, Write, Bash, Glob, Grep, AskUserQuestion, ToolSearch
|
|
|
8
8
|
|
|
9
9
|
# /gdd:connections
|
|
10
10
|
|
|
11
|
-
Interactive onboarding for the
|
|
11
|
+
Interactive onboarding for the 19 external integrations the pipeline supports. Replaces "probe silently at scan entry and hope the user noticed" with an explicit "here is what can plug in, here is how."
|
|
12
12
|
|
|
13
13
|
Canonical per-connection specs live in `../../connections/<name>.md` (one file per integration). The capability matrix + probe-pattern spec live in `../../connections/connections.md`. This skill is the **user-facing front end** for those specs.
|
|
14
14
|
|
|
15
|
-
For the
|
|
15
|
+
For the 19 probe scripts (MCP + HTTP + CLI + file probes), bucket categorization, per-connection setup screen, auto-run eligibility matrix, value-prop one-liners, and STATE.md / config.json write contracts, see `./connections-onboarding.md`. For the cross-skill probe pattern + connection-handshake summary, see `../../reference/shared-preamble.md#connection-handshake-summary`. For the cross-skill output discipline, see `../../reference/shared-preamble.md#output-contract-reminders`.
|
|
16
16
|
|
|
17
17
|
---
|
|
18
18
|
|
|
@@ -38,7 +38,7 @@ For the 16 probe scripts (MCP + HTTP + CLI + file probes), bucket categorization
|
|
|
38
38
|
|
|
39
39
|
## Workflow
|
|
40
40
|
|
|
41
|
-
1. **Probe all
|
|
41
|
+
1. **Probe all 19 connections** — run every probe script per `./connections-onboarding.md#step-1--probe-all-19-connections`. MCP probes use `ToolSearch` first; HTTP / CLI / file probes follow non-MCP patterns. Merge results into `STATE.md <connections>` with the three-value schema (`available | unavailable | not_configured`) — never add new values.
|
|
42
42
|
2. **Categorize + build summary** — bucket each probe result (available / recommended / optional / skipped / unavailable) using project-hint detection. Detail + recommendation mapping: `./connections-onboarding.md#step-2--bucket-categorization`.
|
|
43
43
|
3. **Print summary table** — show buckets + value-prop one-liners (verbatim from `./connections-onboarding.md#step-3--summary-table`).
|
|
44
44
|
4. **Route by mode** — `list` / `--auto` exits after summary; `<name>` jumps straight to Step 5; default mode opens an AskUserQuestion (configure recommended / pick one by one / configure all optional / re-check specific / exit). Routing detail: `./connections-onboarding.md#step-4--route-by-mode`.
|
|
@@ -9,7 +9,7 @@ last_updated: 2026-05-18
|
|
|
9
9
|
|
|
10
10
|
Source: extracted from `skills/connections/SKILL.md` (Phase 28.5 rework — D-10 extract-then-link).
|
|
11
11
|
The skill's load-bearing routing + invocation-mode dispatch stays in `../skills/connections/SKILL.md`;
|
|
12
|
-
this file holds the
|
|
12
|
+
this file holds the 19 probe scripts, bucket categorization, per-connection setup screen,
|
|
13
13
|
auto-run eligibility matrix, value-prop one-liners, and STATE.md / config.json write contracts.
|
|
14
14
|
|
|
15
15
|
# Connections Onboarding Procedure
|
|
@@ -27,7 +27,7 @@ this file does NOT duplicate them; it points at them by name.
|
|
|
27
27
|
|
|
28
28
|
---
|
|
29
29
|
|
|
30
|
-
## Step 1 — Probe all
|
|
30
|
+
## Step 1 — Probe all 19 connections
|
|
31
31
|
|
|
32
32
|
Run every probe below in order. MCP probes call `ToolSearch` first (deferred tools fail silently without it). Write every result to `STATE.md <connections>` when done.
|
|
33
33
|
|
|
@@ -114,6 +114,27 @@ Bash: test -n "$DISCORD_WEBHOOK_URL" (and GDD_DISABLE_DISCORD != 1)
|
|
|
114
114
|
→ non-empty → discord: available
|
|
115
115
|
```
|
|
116
116
|
|
|
117
|
+
**linear:** (ticket-sync — MCP)
|
|
118
|
+
```
|
|
119
|
+
ToolSearch({ query: "linear", max_results: 5 })
|
|
120
|
+
→ Empty / GDD_DISABLE_LINEAR=1 → linear: not_configured
|
|
121
|
+
→ Non-empty → linear: available
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
**jira:** (ticket-sync — Atlassian MCP)
|
|
125
|
+
```
|
|
126
|
+
ToolSearch({ query: "atlassian jira", max_results: 5 })
|
|
127
|
+
→ Empty / GDD_DISABLE_JIRA=1 → jira: not_configured
|
|
128
|
+
→ Non-empty → jira: available
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
**notion:** (export write-path — MCP)
|
|
132
|
+
```
|
|
133
|
+
ToolSearch({ query: "notion", max_results: 5 })
|
|
134
|
+
→ Empty / GDD_DISABLE_NOTION=1 → notion: not_configured
|
|
135
|
+
→ Non-empty → notion: available
|
|
136
|
+
```
|
|
137
|
+
|
|
117
138
|
### Non-MCP probes
|
|
118
139
|
|
|
119
140
|
**storybook** (HTTP):
|
|
@@ -159,7 +180,7 @@ Bash: ls .design/handoff/ 2>/dev/null || find . -maxdepth 3 \
|
|
|
159
180
|
→ Non-empty → claude_design: available
|
|
160
181
|
```
|
|
161
182
|
|
|
162
|
-
After all
|
|
183
|
+
After all 19 probes complete, merge results into `STATE.md <connections>`. Preserve the three-value schema verbatim (`available | unavailable | not_configured`). Do not add new values.
|
|
163
184
|
|
|
164
185
|
---
|
|
165
186
|
|
|
@@ -244,6 +265,9 @@ One-line value props (use verbatim):
|
|
|
244
265
|
| mobbin | curated mobile + flow-level references (paid) — discover Tier 2 |
|
|
245
266
|
| slack | notify — route verify-fail/audit-pass/ship to a Slack channel (redacted) |
|
|
246
267
|
| discord | notify — route pipeline events to a Discord channel (redacted) |
|
|
268
|
+
| linear | ticket-sync — link a cycle to a Linear issue; read comments + transition on completion |
|
|
269
|
+
| jira | ticket-sync — parity with Linear via the Atlassian MCP |
|
|
270
|
+
| notion | export — `/gdd:export --format notion` writes a stakeholder page (degrade-to-HTML) |
|
|
247
271
|
|
|
248
272
|
---
|
|
249
273
|
|
|
@@ -271,7 +295,7 @@ options:
|
|
|
271
295
|
- "Exit" → emit ## CONNECTIONS COMPLETE, exit
|
|
272
296
|
```
|
|
273
297
|
|
|
274
|
-
If recommended bucket is empty, swap that option for "Show all
|
|
298
|
+
If recommended bucket is empty, swap that option for "Show all 19 and pick."
|
|
275
299
|
|
|
276
300
|
---
|
|
277
301
|
|
|
@@ -332,6 +356,9 @@ options:
|
|
|
332
356
|
| lazyweb | `claude plugin install lazyweb@lazyweb` (after token write to `~/.lazyweb/`) | ✗ no | Writes a bearer token to disk — force manual (user-consent step) |
|
|
333
357
|
| slack | set `SLACK_WEBHOOK_URL` env (Slack Incoming Webhook URL) | ✗ no | Env credential — user sets it; no install command (degrade-to-noop when unset) |
|
|
334
358
|
| discord | set `DISCORD_WEBHOOK_URL` env (Discord channel Webhook URL) | ✗ no | Env credential — user sets it; no install command (degrade-to-noop when unset) |
|
|
359
|
+
| linear | `claude mcp add linear ...` (Linear MCP) | ✓ yes | Reversible MCP add; OAuth on first call, no credential filesystem-write |
|
|
360
|
+
| jira | `claude mcp add atlassian ...` (Atlassian MCP) | ✓ yes | Reversible MCP add; OAuth on first call |
|
|
361
|
+
| notion | `claude mcp add notion ...` (Notion MCP) | ✓ yes | Reversible MCP add; OAuth on first call |
|
|
335
362
|
|
|
336
363
|
For non-auto-run connections, hide the "Run install command now" option entirely in 5.3.
|
|
337
364
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: gdd-export
|
|
3
|
+
description: "Packages a completed design cycle (.design artifacts + decisions + screenshots) into a stakeholder-shareable artifact — self-contained HTML, print-styled PDF (Paged.js-compatible), or a Notion page. Redacts secrets; --pseudonymize masks identity for external sharing; --pr posts the HTML preview as a PR comment. Use to hand a design-review packet to PMs/execs/brand who aren't in the repo."
|
|
4
|
+
argument-hint: "<cycle-id> --format html|pdf|notion [--pseudonymize] [--pr]"
|
|
5
|
+
user-invocable: true
|
|
6
|
+
tools: Read, Write, Bash, Glob, Grep, ToolSearch, Task
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# /gdd:export
|
|
10
|
+
|
|
11
|
+
Turns a completed cycle's in-repo design output into a shareable artifact. Closes the gap that `.design/*.md` lives only in the repo — stakeholders not in code can't consume it. The format contract + source set live in `../../reference/export-formats.md`; the Notion write-path in `../../connections/notion.md`.
|
|
12
|
+
|
|
13
|
+
## Steps
|
|
14
|
+
|
|
15
|
+
1. **Resolve the cycle.** `<cycle-id>` (or the current cycle from `.design/STATE.md`). Read the **source set**: `EXPERIENCE.md` (Phase 19.5), `.design/DESIGN.md`, `.design/DESIGN-VERIFICATION.md`, `.design/DESIGN-AUDIT.md` (if present), the decision log, and any Preview/Chromatic screenshots.
|
|
16
|
+
2. **Redact (always) + pseudonymize (opt-in).** Pass every section through `scripts/lib/redact.cjs` (secrets). If `--pseudonymize`, additionally apply `scripts/lib/pseudonymize.cjs` (git identity / paths / hostname) for external sharing. Honor `GDD_DISABLE_NOTION` for the notion format.
|
|
17
|
+
3. **Assemble per `--format`:**
|
|
18
|
+
- **`html`** (default) — `node -e "require('scripts/lib/export/build-html.cjs').buildHtml({...})"` → a **self-contained** HTML (inline CSS, base64-embedded screenshots, no external refs). Write to `.design/export/<cycle>.html`.
|
|
19
|
+
- **`pdf`** — the same `buildHtml({ ..., print: true })` (Paged.js-compatible `@page` print CSS). Write `.design/export/<cycle>.print.html`; instruct the user to render it via Paged.js / headless-Chrome (GDD ships **no** PDF runtime — D-02).
|
|
20
|
+
- **`notion`** — probe the Notion MCP (`ToolSearch({query:"notion"})`); if `available`, create a page from the same source (nested toggles + image upload) per `connections/notion.md`; if `not_configured`/disabled → degrade to the `html` format + a note.
|
|
21
|
+
4. **`--pr`** — hand the generated HTML preview to `agents/pr-commenter.md` (via `Task`) to post as a PR comment (degrade-to-noop if no PR / pr-commenter unavailable).
|
|
22
|
+
5. **Print the artifact path** (and the Notion URL / PR comment status when applicable).
|
|
23
|
+
|
|
24
|
+
## Do Not
|
|
25
|
+
|
|
26
|
+
- Do not add a PDF/markdown runtime dependency (`paged`/`puppeteer`/`pdfkit`/a markdown lib) — `build-html.cjs` is pure and the PDF is render-it-yourself print HTML (D-02).
|
|
27
|
+
- Do not emit an un-redacted artifact — redact is mandatory; pseudonymize is the external-sharing opt-in.
|
|
28
|
+
- Do not block on Notion/PR — both degrade to a noop / the html file.
|
|
29
|
+
|
|
30
|
+
## EXPORT COMPLETE
|