forge-workflow 0.0.4 → 0.0.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/commands/dev.md +340 -340
- package/.claude/commands/plan.md +521 -521
- package/.claude/commands/premerge.md +176 -176
- package/.claude/commands/research.md +42 -42
- package/.claude/commands/review.md +442 -442
- package/.claude/commands/rollback.md +721 -721
- package/.claude/commands/ship.md +164 -164
- package/.claude/commands/sonarcloud.md +152 -152
- package/.claude/commands/status.md +48 -48
- package/.claude/commands/validate.md +282 -282
- package/.claude/commands/verify.md +221 -221
- package/.claude/rules/greptile-review-process.md +285 -285
- package/.claude/rules/workflow.md +105 -105
- package/.claude/scripts/greptile-resolve.sh +526 -526
- package/.claude/scripts/load-env.sh +32 -32
- package/.cline/workflows/dev.md +337 -337
- package/.cline/workflows/plan.md +518 -518
- package/.cline/workflows/premerge.md +173 -173
- package/.cline/workflows/research.md +39 -39
- package/.cline/workflows/review.md +439 -439
- package/.cline/workflows/rollback.md +718 -718
- package/.cline/workflows/ship.md +161 -161
- package/.cline/workflows/sonarcloud.md +146 -146
- package/.cline/workflows/status.md +45 -45
- package/.cline/workflows/validate.md +279 -279
- package/.cline/workflows/verify.md +218 -218
- package/.codex/config.toml +11 -11
- package/.codex/skills/dev/SKILL.md +340 -340
- package/.codex/skills/plan/SKILL.md +521 -521
- package/.codex/skills/premerge/SKILL.md +176 -176
- package/.codex/skills/research/SKILL.md +42 -42
- package/.codex/skills/review/SKILL.md +442 -442
- package/.codex/skills/rollback/SKILL.md +721 -721
- package/.codex/skills/ship/SKILL.md +164 -164
- package/.codex/skills/sonarcloud/SKILL.md +149 -149
- package/.codex/skills/status/SKILL.md +48 -48
- package/.codex/skills/validate/SKILL.md +282 -282
- package/.codex/skills/verify/SKILL.md +221 -221
- package/.cursor/commands/dev.md +337 -337
- package/.cursor/commands/plan.md +518 -518
- package/.cursor/commands/premerge.md +173 -173
- package/.cursor/commands/research.md +39 -39
- package/.cursor/commands/review.md +439 -439
- package/.cursor/commands/rollback.md +718 -718
- package/.cursor/commands/ship.md +161 -161
- package/.cursor/commands/sonarcloud.md +146 -146
- package/.cursor/commands/status.md +45 -45
- package/.cursor/commands/validate.md +279 -279
- package/.cursor/commands/verify.md +218 -218
- package/.cursor/rules/permissions-guidance.mdc +37 -37
- package/.forge/hooks/check-tdd.js +240 -240
- package/.github/PLUGIN_TEMPLATE.json +32 -32
- package/.github/prompts/dev.prompt.md +342 -342
- package/.github/prompts/plan.prompt.md +523 -523
- package/.github/prompts/premerge.prompt.md +178 -178
- package/.github/prompts/research.prompt.md +44 -44
- package/.github/prompts/review.prompt.md +444 -444
- package/.github/prompts/rollback.prompt.md +723 -723
- package/.github/prompts/ship.prompt.md +166 -166
- package/.github/prompts/sonarcloud.prompt.md +151 -151
- package/.github/prompts/status.prompt.md +50 -50
- package/.github/prompts/validate.prompt.md +284 -284
- package/.github/prompts/verify.prompt.md +223 -223
- package/.github/workflows/beads-to-github.yml +56 -0
- package/.github/workflows/github-to-beads.yml +97 -0
- package/.kilocode/workflows/dev.md +341 -341
- package/.kilocode/workflows/plan.md +522 -522
- package/.kilocode/workflows/premerge.md +177 -177
- package/.kilocode/workflows/research.md +43 -43
- package/.kilocode/workflows/review.md +443 -443
- package/.kilocode/workflows/rollback.md +722 -722
- package/.kilocode/workflows/ship.md +165 -165
- package/.kilocode/workflows/sonarcloud.md +150 -150
- package/.kilocode/workflows/status.md +49 -49
- package/.kilocode/workflows/validate.md +283 -283
- package/.kilocode/workflows/verify.md +222 -222
- package/.mcp.json.example +12 -12
- package/.opencode/commands/dev.md +340 -340
- package/.opencode/commands/plan.md +521 -521
- package/.opencode/commands/premerge.md +176 -176
- package/.opencode/commands/research.md +42 -42
- package/.opencode/commands/review.md +442 -442
- package/.opencode/commands/rollback.md +721 -721
- package/.opencode/commands/ship.md +164 -164
- package/.opencode/commands/sonarcloud.md +149 -149
- package/.opencode/commands/status.md +48 -48
- package/.opencode/commands/validate.md +282 -282
- package/.opencode/commands/verify.md +221 -221
- package/.roo/commands/dev.md +341 -341
- package/.roo/commands/plan.md +522 -522
- package/.roo/commands/premerge.md +177 -177
- package/.roo/commands/research.md +43 -43
- package/.roo/commands/review.md +443 -443
- package/.roo/commands/rollback.md +722 -722
- package/.roo/commands/ship.md +165 -165
- package/.roo/commands/sonarcloud.md +150 -150
- package/.roo/commands/status.md +49 -49
- package/.roo/commands/validate.md +283 -283
- package/.roo/commands/verify.md +222 -222
- package/AGENTS.md +175 -175
- package/CLAUDE.md +100 -100
- package/README.md +429 -416
- package/bin/forge-cmd.js +313 -313
- package/bin/forge-preflight.js +309 -309
- package/bin/forge.js +4596 -4303
- package/docs/AGENT_INSTALL_PROMPT.md +342 -342
- package/docs/BEADS_GITHUB_SYNC.md +251 -251
- package/docs/ENHANCED_ONBOARDING.md +602 -602
- package/docs/EXAMPLES.md +482 -482
- package/docs/GREPTILE_SETUP.md +400 -400
- package/docs/MANUAL_REVIEW_GUIDE.md +106 -106
- package/docs/ROADMAP.md +359 -359
- package/docs/SETUP.md +663 -631
- package/docs/TOOLCHAIN.md +630 -630
- package/docs/VALIDATION.md +363 -363
- package/install.sh +40 -1056
- package/lefthook.yml +39 -39
- package/lib/agents/README.md +198 -198
- package/lib/agents/claude.plugin.json +28 -28
- package/lib/agents/cline.plugin.json +22 -22
- package/lib/agents/codex.plugin.json +19 -19
- package/lib/agents/copilot.plugin.json +24 -24
- package/lib/agents/cursor.plugin.json +25 -25
- package/lib/agents/kilocode.plugin.json +22 -22
- package/lib/agents/opencode.plugin.json +20 -20
- package/lib/agents/roo.plugin.json +23 -23
- package/lib/agents-config.js +2112 -2112
- package/lib/beads-health-check.js +143 -0
- package/lib/beads-setup.js +341 -0
- package/lib/beads-sync-scaffold.js +260 -0
- package/lib/commands/dev.js +513 -513
- package/lib/commands/plan.js +692 -692
- package/lib/commands/recommend.js +119 -119
- package/lib/commands/ship.js +377 -377
- package/lib/commands/status.js +378 -378
- package/lib/commands/validate.js +602 -602
- package/lib/context-merge.js +359 -359
- package/lib/dep-guard/analyzer.js +294 -294
- package/lib/dep-guard/behavior-detector.js +98 -98
- package/lib/dep-guard/contract-detector.js +162 -162
- package/lib/dep-guard/import-detector.js +498 -498
- package/lib/dep-guard/path-utils.js +13 -13
- package/lib/dep-guard/rubric.js +120 -120
- package/lib/dep-guard/task-parser.js +318 -318
- package/lib/detect-agent.js +191 -191
- package/lib/detect-worktree.js +47 -47
- package/lib/file-hash.js +26 -26
- package/lib/husky-migration.js +450 -0
- package/lib/lefthook-check.js +65 -0
- package/lib/pat-setup.js +207 -0
- package/lib/plugin-catalog.js +350 -350
- package/lib/plugin-manager.js +166 -166
- package/lib/plugin-recommender.js +141 -141
- package/lib/project-discovery.js +491 -491
- package/lib/setup-action-log.js +139 -139
- package/lib/setup-summary-renderer.js +106 -106
- package/lib/setup-utils.js +96 -0
- package/lib/setup.js +192 -192
- package/lib/smart-merge.js +64 -0
- package/lib/symlink-utils.js +81 -0
- package/lib/workflow-profiles.js +197 -197
- package/package.json +131 -128
- package/scripts/beads-context.sh +291 -0
- package/scripts/beads-context.test.js +563 -0
- package/scripts/behavioral-judge.sh +378 -0
- package/scripts/benchmark.js +85 -0
- package/scripts/branch-protection.js +183 -0
- package/scripts/check-agents.js +172 -0
- package/scripts/commitlint.js +42 -0
- package/scripts/conflict-detect.sh +323 -0
- package/scripts/dep-guard-analyze.js +71 -0
- package/scripts/dep-guard.sh +811 -0
- package/scripts/eval_win.py +249 -0
- package/scripts/file-index.sh +399 -0
- package/scripts/github-beads-sync/comment.mjs +64 -0
- package/scripts/github-beads-sync/config.mjs +148 -0
- package/scripts/github-beads-sync/github-api.mjs +131 -0
- package/scripts/github-beads-sync/index.mjs +332 -0
- package/scripts/github-beads-sync/label-mapper.mjs +54 -0
- package/scripts/github-beads-sync/mapping.mjs +78 -0
- package/scripts/github-beads-sync/reverse-sync-cli.mjs +31 -0
- package/scripts/github-beads-sync/reverse-sync.mjs +138 -0
- package/scripts/github-beads-sync/run-bd.mjs +159 -0
- package/scripts/github-beads-sync/sanitize.mjs +121 -0
- package/scripts/github-beads-sync.config.json +26 -0
- package/scripts/improve-command.js +375 -0
- package/scripts/lib/eval-runner.js +229 -0
- package/scripts/lib/eval-schema.js +135 -0
- package/scripts/lib/eval-storage.js +78 -0
- package/scripts/lib/grading.js +203 -0
- package/scripts/lib/transcript-parser.js +63 -0
- package/scripts/lint.js +47 -0
- package/scripts/migrate-to-bun-test.js +412 -0
- package/scripts/run-command-eval.js +236 -0
- package/scripts/smart-status.sh +782 -0
- package/scripts/sync-commands.js +571 -0
- package/scripts/sync-utils.sh +460 -0
- package/scripts/test-dashboard.js +123 -0
- package/scripts/test.js +44 -0
- package/scripts/validate.sh +94 -0
- package/skills/parallel-deep-research/SKILL.md +108 -108
- package/skills/parallel-deep-research/evals/README.md +27 -27
- package/skills/parallel-deep-research/evals/evals.json +62 -62
- package/skills/sonarcloud-analysis/SKILL.md +171 -171
- package/skills/sonarcloud-analysis/evals/README.md +27 -27
- package/skills/sonarcloud-analysis/evals/evals.json +50 -50
- package/skills/sonarcloud-analysis/references/api-reference.md +466 -466
- package/.cursor/hooks/state/continual-learning-index.json +0 -19
- package/.cursor/hooks/state/continual-learning.json +0 -8
package/.cline/workflows/ship.md
CHANGED
|
@@ -1,161 +1,161 @@
|
|
|
1
|
-
|
|
2
|
-
Push code and create a pull request with full context and documentation links.
|
|
3
|
-
|
|
4
|
-
# Ship
|
|
5
|
-
|
|
6
|
-
This command creates a PR after validation passes.
|
|
7
|
-
|
|
8
|
-
## Usage
|
|
9
|
-
|
|
10
|
-
```bash
|
|
11
|
-
/ship
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
```
|
|
15
|
-
<HARD-GATE: /ship entry>
|
|
16
|
-
Do NOT create PR until:
|
|
17
|
-
1. /validate was run in this session with all four outputs shown (type, lint, tests, security)
|
|
18
|
-
2. All checks confirmed passing — not assumed, not "was passing earlier"
|
|
19
|
-
3. Beads issue is in_progress
|
|
20
|
-
4. git branch --show-current output is NOT main or master
|
|
21
|
-
</HARD-GATE>
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
## What This Command Does
|
|
25
|
-
|
|
26
|
-
### Step 1: Verify /validate Passed
|
|
27
|
-
Ensure all four validation checks completed successfully with fresh output in this session.
|
|
28
|
-
|
|
29
|
-
### Step 2: Freshness Check — Is Branch Still Current?
|
|
30
|
-
|
|
31
|
-
Even though /validate rebased onto the base branch, time may have passed since then (user reviewed design doc, took a break, etc.). This lightweight check catches staleness before pushing.
|
|
32
|
-
|
|
33
|
-
```bash
|
|
34
|
-
BASE=$(git remote show origin 2>/dev/null | grep 'HEAD branch' | awk '{print $NF}')
|
|
35
|
-
if [ -z "$BASE" ] || [ "$BASE" = "(unknown)" ]; then BASE="master"; fi
|
|
36
|
-
git fetch origin "$BASE" || { echo "✗ Fetch failed — cannot verify freshness"; exit 1; }
|
|
37
|
-
BEHIND=$(git rev-list --count HEAD..origin/"$BASE")
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
- If `BEHIND > 0`: **STOP**. Print: "$BASE has advanced since /validate ($BEHIND new commits). Run /validate again to rebase and re-check."
|
|
41
|
-
- If `BEHIND = 0`: Continue to push.
|
|
42
|
-
- If fetch fails: the `|| { ...; exit 1; }` guard catches this — **STOP**. Do NOT push without confirming freshness.
|
|
43
|
-
|
|
44
|
-
This is NOT a full rebase — just a check. The rebase happens in /validate where the full test suite runs afterward.
|
|
45
|
-
|
|
46
|
-
### Step 3: Update Beads
|
|
47
|
-
```bash
|
|
48
|
-
bd update <id> --status done
|
|
49
|
-
bd sync
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
### Step 4: Push Branch
|
|
53
|
-
|
|
54
|
-
Use `--force-with-lease` because `/validate` may have rebased the branch, rewriting history. This is safe: it only forces the push if the remote branch hasn't been updated by someone else since the last fetch.
|
|
55
|
-
|
|
56
|
-
```bash
|
|
57
|
-
git push --force-with-lease -u origin <branch-name>
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
### Step 5: Create PR
|
|
61
|
-
|
|
62
|
-
Use the narrative PR template below. Lead with WHY (Problem/Root Cause/Fix/Value) — this is what reviewers need to understand first. Keep implementation details (test coverage, security review, design doc) in a collapsible section so they're available but don't clutter the summary.
|
|
63
|
-
|
|
64
|
-
If no Beads issue exists (hotfix, external contribution), skip the "Closes" line.
|
|
65
|
-
|
|
66
|
-
```bash
|
|
67
|
-
gh pr create --title "<type>: <concise description>" --body "$(cat <<'EOF'
|
|
68
|
-
## Problem
|
|
69
|
-
[What was broken, what need existed, or what user pain this addresses]
|
|
70
|
-
|
|
71
|
-
## Root Cause
|
|
72
|
-
[Why it happened, why it was missing, or what gap existed]
|
|
73
|
-
|
|
74
|
-
## Fix
|
|
75
|
-
[What this PR does to solve it — approach, not implementation details]
|
|
76
|
-
|
|
77
|
-
## Value
|
|
78
|
-
[Who benefits, what improves, what risk is removed]
|
|
79
|
-
|
|
80
|
-
## Beads
|
|
81
|
-
Closes: <issue-id>
|
|
82
|
-
|
|
83
|
-
<details>
|
|
84
|
-
<summary>Implementation Details</summary>
|
|
85
|
-
|
|
86
|
-
### Test Coverage
|
|
87
|
-
- Tests: [count] passing
|
|
88
|
-
- Scenarios covered: [list key scenarios]
|
|
89
|
-
|
|
90
|
-
### Security Review
|
|
91
|
-
- OWASP Top 10: [summary — applicable risks and mitigations]
|
|
92
|
-
- Automated scan: [result]
|
|
93
|
-
|
|
94
|
-
### Design Doc
|
|
95
|
-
See: docs/plans/YYYY-MM-DD-<slug>-design.md
|
|
96
|
-
|
|
97
|
-
### Decisions Log
|
|
98
|
-
See: docs/plans/YYYY-MM-DD-<slug>-decisions.md (if any undocumented decisions arose during /dev)
|
|
99
|
-
|
|
100
|
-
### Key Decisions
|
|
101
|
-
[From design doc — 3-5 key decisions with reasoning]
|
|
102
|
-
|
|
103
|
-
### Documentation Updated
|
|
104
|
-
[List docs updated in this PR, or "None — no doc-facing changes"]
|
|
105
|
-
|
|
106
|
-
### Validation
|
|
107
|
-
- [x] Type check passing
|
|
108
|
-
- [x] Lint passing (0 errors, 0 warnings)
|
|
109
|
-
- [x] All tests passing
|
|
110
|
-
- [x] Security review completed
|
|
111
|
-
|
|
112
|
-
</details>
|
|
113
|
-
|
|
114
|
-
🤖 Generated with [Claude Code](https://claude.com/claude-code)
|
|
115
|
-
EOF
|
|
116
|
-
)"
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
### Step 6: Record Stage Transition
|
|
120
|
-
```bash
|
|
121
|
-
bash scripts/beads-context.sh stage-transition <id> ship review
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
## Example Output
|
|
125
|
-
|
|
126
|
-
```
|
|
127
|
-
✓ Validation: /validate passed (all 4 checks — fresh output confirmed)
|
|
128
|
-
✓ Freshness: Branch is up-to-date with master
|
|
129
|
-
✓ Beads: Marked done & synced (forge-xyz)
|
|
130
|
-
✓ Pushed: feat/stripe-billing
|
|
131
|
-
✓ PR created: https://github.com/.../pull/123
|
|
132
|
-
- PR body: Problem → Root Cause → Fix → Value (narrative format)
|
|
133
|
-
- Beads linked: forge-xyz
|
|
134
|
-
- Implementation details in collapsible section
|
|
135
|
-
|
|
136
|
-
⏸️ PR created, awaiting automated checks (Greptile, SonarCloud, GitHub Actions)
|
|
137
|
-
|
|
138
|
-
Next: /review <pr-number> (after automated checks complete)
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
## Integration with Workflow
|
|
142
|
-
|
|
143
|
-
```
|
|
144
|
-
Utility: /status → Understand current context before starting
|
|
145
|
-
Stage 1: /plan → Design intent → research → branch + worktree + task list
|
|
146
|
-
Stage 2: /dev → Implement each task with subagent-driven TDD
|
|
147
|
-
Stage 3: /validate → Type check, lint, tests, security — all fresh output
|
|
148
|
-
Stage 4: /ship → Push + create PR (you are here)
|
|
149
|
-
Stage 5: /review → Address GitHub Actions, Greptile, SonarCloud
|
|
150
|
-
Stage 6: /premerge → Update docs, hand off PR to user
|
|
151
|
-
Stage 7: /verify → Post-merge CI check on main
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
## Tips
|
|
155
|
-
|
|
156
|
-
- **Lead with why**: Problem → Root Cause → Fix → Value is what reviewers need first
|
|
157
|
-
- **Collapsible details**: Design doc, decisions log, test coverage go in `<details>` — available but not in the way
|
|
158
|
-
- **Document security**: OWASP Top 10 review in collapsible section
|
|
159
|
-
- **Test coverage**: Show all test scenarios passing
|
|
160
|
-
- **Wait for checks**: Let GitHub Actions, Greptile, SonarCloud run
|
|
161
|
-
- **NO auto-merge**: Always wait for /review phase
|
|
1
|
+
|
|
2
|
+
Push code and create a pull request with full context and documentation links.
|
|
3
|
+
|
|
4
|
+
# Ship
|
|
5
|
+
|
|
6
|
+
This command creates a PR after validation passes.
|
|
7
|
+
|
|
8
|
+
## Usage
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
/ship
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
<HARD-GATE: /ship entry>
|
|
16
|
+
Do NOT create PR until:
|
|
17
|
+
1. /validate was run in this session with all four outputs shown (type, lint, tests, security)
|
|
18
|
+
2. All checks confirmed passing — not assumed, not "was passing earlier"
|
|
19
|
+
3. Beads issue is in_progress
|
|
20
|
+
4. git branch --show-current output is NOT main or master
|
|
21
|
+
</HARD-GATE>
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## What This Command Does
|
|
25
|
+
|
|
26
|
+
### Step 1: Verify /validate Passed
|
|
27
|
+
Ensure all four validation checks completed successfully with fresh output in this session.
|
|
28
|
+
|
|
29
|
+
### Step 2: Freshness Check — Is Branch Still Current?
|
|
30
|
+
|
|
31
|
+
Even though /validate rebased onto the base branch, time may have passed since then (user reviewed design doc, took a break, etc.). This lightweight check catches staleness before pushing.
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
BASE=$(git remote show origin 2>/dev/null | grep 'HEAD branch' | awk '{print $NF}')
|
|
35
|
+
if [ -z "$BASE" ] || [ "$BASE" = "(unknown)" ]; then BASE="master"; fi
|
|
36
|
+
git fetch origin "$BASE" || { echo "✗ Fetch failed — cannot verify freshness"; exit 1; }
|
|
37
|
+
BEHIND=$(git rev-list --count HEAD..origin/"$BASE")
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
- If `BEHIND > 0`: **STOP**. Print: "$BASE has advanced since /validate ($BEHIND new commits). Run /validate again to rebase and re-check."
|
|
41
|
+
- If `BEHIND = 0`: Continue to push.
|
|
42
|
+
- If fetch fails: the `|| { ...; exit 1; }` guard catches this — **STOP**. Do NOT push without confirming freshness.
|
|
43
|
+
|
|
44
|
+
This is NOT a full rebase — just a check. The rebase happens in /validate where the full test suite runs afterward.
|
|
45
|
+
|
|
46
|
+
### Step 3: Update Beads
|
|
47
|
+
```bash
|
|
48
|
+
bd update <id> --status done
|
|
49
|
+
bd sync
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Step 4: Push Branch
|
|
53
|
+
|
|
54
|
+
Use `--force-with-lease` because `/validate` may have rebased the branch, rewriting history. This is safe: it only forces the push if the remote branch hasn't been updated by someone else since the last fetch.
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
git push --force-with-lease -u origin <branch-name>
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Step 5: Create PR
|
|
61
|
+
|
|
62
|
+
Use the narrative PR template below. Lead with WHY (Problem/Root Cause/Fix/Value) — this is what reviewers need to understand first. Keep implementation details (test coverage, security review, design doc) in a collapsible section so they're available but don't clutter the summary.
|
|
63
|
+
|
|
64
|
+
If no Beads issue exists (hotfix, external contribution), skip the "Closes" line.
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
gh pr create --title "<type>: <concise description>" --body "$(cat <<'EOF'
|
|
68
|
+
## Problem
|
|
69
|
+
[What was broken, what need existed, or what user pain this addresses]
|
|
70
|
+
|
|
71
|
+
## Root Cause
|
|
72
|
+
[Why it happened, why it was missing, or what gap existed]
|
|
73
|
+
|
|
74
|
+
## Fix
|
|
75
|
+
[What this PR does to solve it — approach, not implementation details]
|
|
76
|
+
|
|
77
|
+
## Value
|
|
78
|
+
[Who benefits, what improves, what risk is removed]
|
|
79
|
+
|
|
80
|
+
## Beads
|
|
81
|
+
Closes: <issue-id>
|
|
82
|
+
|
|
83
|
+
<details>
|
|
84
|
+
<summary>Implementation Details</summary>
|
|
85
|
+
|
|
86
|
+
### Test Coverage
|
|
87
|
+
- Tests: [count] passing
|
|
88
|
+
- Scenarios covered: [list key scenarios]
|
|
89
|
+
|
|
90
|
+
### Security Review
|
|
91
|
+
- OWASP Top 10: [summary — applicable risks and mitigations]
|
|
92
|
+
- Automated scan: [result]
|
|
93
|
+
|
|
94
|
+
### Design Doc
|
|
95
|
+
See: docs/plans/YYYY-MM-DD-<slug>-design.md
|
|
96
|
+
|
|
97
|
+
### Decisions Log
|
|
98
|
+
See: docs/plans/YYYY-MM-DD-<slug>-decisions.md (if any undocumented decisions arose during /dev)
|
|
99
|
+
|
|
100
|
+
### Key Decisions
|
|
101
|
+
[From design doc — 3-5 key decisions with reasoning]
|
|
102
|
+
|
|
103
|
+
### Documentation Updated
|
|
104
|
+
[List docs updated in this PR, or "None — no doc-facing changes"]
|
|
105
|
+
|
|
106
|
+
### Validation
|
|
107
|
+
- [x] Type check passing
|
|
108
|
+
- [x] Lint passing (0 errors, 0 warnings)
|
|
109
|
+
- [x] All tests passing
|
|
110
|
+
- [x] Security review completed
|
|
111
|
+
|
|
112
|
+
</details>
|
|
113
|
+
|
|
114
|
+
🤖 Generated with [Claude Code](https://claude.com/claude-code)
|
|
115
|
+
EOF
|
|
116
|
+
)"
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Step 6: Record Stage Transition
|
|
120
|
+
```bash
|
|
121
|
+
bash scripts/beads-context.sh stage-transition <id> ship review
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## Example Output
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
✓ Validation: /validate passed (all 4 checks — fresh output confirmed)
|
|
128
|
+
✓ Freshness: Branch is up-to-date with master
|
|
129
|
+
✓ Beads: Marked done & synced (forge-xyz)
|
|
130
|
+
✓ Pushed: feat/stripe-billing
|
|
131
|
+
✓ PR created: https://github.com/.../pull/123
|
|
132
|
+
- PR body: Problem → Root Cause → Fix → Value (narrative format)
|
|
133
|
+
- Beads linked: forge-xyz
|
|
134
|
+
- Implementation details in collapsible section
|
|
135
|
+
|
|
136
|
+
⏸️ PR created, awaiting automated checks (Greptile, SonarCloud, GitHub Actions)
|
|
137
|
+
|
|
138
|
+
Next: /review <pr-number> (after automated checks complete)
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Integration with Workflow
|
|
142
|
+
|
|
143
|
+
```
|
|
144
|
+
Utility: /status → Understand current context before starting
|
|
145
|
+
Stage 1: /plan → Design intent → research → branch + worktree + task list
|
|
146
|
+
Stage 2: /dev → Implement each task with subagent-driven TDD
|
|
147
|
+
Stage 3: /validate → Type check, lint, tests, security — all fresh output
|
|
148
|
+
Stage 4: /ship → Push + create PR (you are here)
|
|
149
|
+
Stage 5: /review → Address GitHub Actions, Greptile, SonarCloud
|
|
150
|
+
Stage 6: /premerge → Update docs, hand off PR to user
|
|
151
|
+
Stage 7: /verify → Post-merge CI check on main
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
## Tips
|
|
155
|
+
|
|
156
|
+
- **Lead with why**: Problem → Root Cause → Fix → Value is what reviewers need first
|
|
157
|
+
- **Collapsible details**: Design doc, decisions log, test coverage go in `<details>` — available but not in the way
|
|
158
|
+
- **Document security**: OWASP Top 10 review in collapsible section
|
|
159
|
+
- **Test coverage**: Show all test scenarios passing
|
|
160
|
+
- **Wait for checks**: Let GitHub Actions, Greptile, SonarCloud run
|
|
161
|
+
- **NO auto-merge**: Always wait for /review phase
|
|
@@ -1,146 +1,146 @@
|
|
|
1
|
-
|
|
2
|
-
# SonarCloud Query Command
|
|
3
|
-
|
|
4
|
-
Pull code quality data from SonarCloud. Requires `SONARCLOUD_TOKEN` environment variable.
|
|
5
|
-
|
|
6
|
-
## Arguments
|
|
7
|
-
|
|
8
|
-
- `$ARGUMENTS` - Query type and parameters
|
|
9
|
-
|
|
10
|
-
## Query Types
|
|
11
|
-
|
|
12
|
-
| Query | Description | Example |
|
|
13
|
-
|-------|-------------|---------|
|
|
14
|
-
| `issues <project>` | Get open issues | `/sonarcloud issues my-project` |
|
|
15
|
-
| `metrics <project>` | Get code metrics | `/sonarcloud metrics my-project` |
|
|
16
|
-
| `gate <project>` | Quality gate status | `/sonarcloud gate my-project` |
|
|
17
|
-
| `health <project>` | Full health report | `/sonarcloud health my-project` |
|
|
18
|
-
| `pr <project> <pr#>` | PR analysis | `/sonarcloud pr my-project 123` |
|
|
19
|
-
| `hotspots <project>` | Security hotspots | `/sonarcloud hotspots my-project` |
|
|
20
|
-
| `history <project>` | Analysis history | `/sonarcloud history my-project` |
|
|
21
|
-
|
|
22
|
-
## Filters (append to query)
|
|
23
|
-
|
|
24
|
-
| Filter | Description | Example |
|
|
25
|
-
|--------|-------------|---------|
|
|
26
|
-
| `--branch <name>` | Filter by branch | `--branch develop` |
|
|
27
|
-
| `--severity <levels>` | Filter severity | `--severity BLOCKER,CRITICAL` |
|
|
28
|
-
| `--type <types>` | Filter issue type | `--type BUG,VULNERABILITY` |
|
|
29
|
-
| `--new-code` | Only new code issues | `--new-code` |
|
|
30
|
-
|
|
31
|
-
## Instructions
|
|
32
|
-
|
|
33
|
-
1. Parse the query from `$ARGUMENTS` to determine:
|
|
34
|
-
- Query type (issues, metrics, gate, health, pr, hotspots, history)
|
|
35
|
-
- Project key
|
|
36
|
-
- Optional filters (branch, severity, type, new-code, etc.)
|
|
37
|
-
2. Check for `SONARCLOUD_TOKEN` environment variable. If not set, inform user.
|
|
38
|
-
3. Check for `SONARCLOUD_ORG` environment variable or ask user for organization key.
|
|
39
|
-
4. Execute the appropriate API call using curl or the TypeScript client at `next-app/src/lib/integrations/sonarcloud.ts`
|
|
40
|
-
5. Format and present results clearly:
|
|
41
|
-
- For issues: Group by severity/type, show file, line, message
|
|
42
|
-
- For metrics: Show as table with metric name and value
|
|
43
|
-
- For quality gate: Show pass/fail with failed conditions
|
|
44
|
-
- For health: Comprehensive summary with all data
|
|
45
|
-
6. Offer follow-up actions:
|
|
46
|
-
- "Show issues in specific file?"
|
|
47
|
-
- "Get more details on a specific issue?"
|
|
48
|
-
- "Compare with another branch?"
|
|
49
|
-
|
|
50
|
-
## Example Outputs
|
|
51
|
-
|
|
52
|
-
### Issues Query
|
|
53
|
-
|
|
54
|
-
```
|
|
55
|
-
📋 Open Issues for my-project (branch: main)
|
|
56
|
-
|
|
57
|
-
Total: 45 issues
|
|
58
|
-
|
|
59
|
-
By Severity:
|
|
60
|
-
🔴 BLOCKER: 2
|
|
61
|
-
🟠 CRITICAL: 5
|
|
62
|
-
🟡 MAJOR: 18
|
|
63
|
-
⚪ MINOR: 15
|
|
64
|
-
⚫ INFO: 5
|
|
65
|
-
|
|
66
|
-
By Type:
|
|
67
|
-
🐛 BUG: 8
|
|
68
|
-
🔓 VULNERABILITY: 3
|
|
69
|
-
💩 CODE_SMELL: 34
|
|
70
|
-
|
|
71
|
-
Top Issues:
|
|
72
|
-
1. [CRITICAL] src/auth/login.ts:42 - SQL injection vulnerability
|
|
73
|
-
2. [BLOCKER] src/api/users.ts:156 - Null pointer dereference
|
|
74
|
-
...
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### Metrics Query
|
|
78
|
-
|
|
79
|
-
```
|
|
80
|
-
📊 Metrics for my-project
|
|
81
|
-
|
|
82
|
-
| Metric | Value |
|
|
83
|
-
|--------|-------|
|
|
84
|
-
| Lines of Code | 51,234 |
|
|
85
|
-
| Coverage | 78.5% |
|
|
86
|
-
| Duplications | 3.2% |
|
|
87
|
-
| Bugs | 8 |
|
|
88
|
-
| Vulnerabilities | 3 |
|
|
89
|
-
| Code Smells | 34 |
|
|
90
|
-
| Technical Debt | 4d 2h |
|
|
91
|
-
| Maintainability | A |
|
|
92
|
-
| Reliability | B |
|
|
93
|
-
| Security | A |
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
### Quality Gate Query
|
|
97
|
-
|
|
98
|
-
```
|
|
99
|
-
🚦 Quality Gate: ❌ FAILED
|
|
100
|
-
|
|
101
|
-
Failed Conditions:
|
|
102
|
-
| Metric | Threshold | Actual |
|
|
103
|
-
|--------|-----------|--------|
|
|
104
|
-
| Coverage on New Code | ≥ 80% | 65.3% |
|
|
105
|
-
| New Bugs | = 0 | 2 |
|
|
106
|
-
|
|
107
|
-
Passed Conditions:
|
|
108
|
-
| Metric | Threshold | Actual |
|
|
109
|
-
|--------|-----------|--------|
|
|
110
|
-
| New Vulnerabilities | = 0 | 0 |
|
|
111
|
-
| Duplicated Lines | ≤ 3% | 1.2% |
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
## API Reference
|
|
115
|
-
|
|
116
|
-
Base URL: `https://sonarcloud.io/api`
|
|
117
|
-
|
|
118
|
-
### Key Endpoints
|
|
119
|
-
|
|
120
|
-
```bash
|
|
121
|
-
# Issues
|
|
122
|
-
curl -H "Authorization: Bearer $TOKEN" \
|
|
123
|
-
"https://sonarcloud.io/api/issues/search?organization=$ORG&componentKeys=$PROJECT&resolved=false"
|
|
124
|
-
|
|
125
|
-
# Metrics
|
|
126
|
-
curl -H "Authorization: Bearer $TOKEN" \
|
|
127
|
-
"https://sonarcloud.io/api/measures/component?component=$PROJECT&metricKeys=bugs,vulnerabilities,coverage"
|
|
128
|
-
|
|
129
|
-
# Quality Gate
|
|
130
|
-
curl -H "Authorization: Bearer $TOKEN" \
|
|
131
|
-
"https://sonarcloud.io/api/qualitygates/project_status?projectKey=$PROJECT"
|
|
132
|
-
|
|
133
|
-
# Hotspots
|
|
134
|
-
curl -H "Authorization: Bearer $TOKEN" \
|
|
135
|
-
"https://sonarcloud.io/api/hotspots/search?projectKey=$PROJECT&status=TO_REVIEW"
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
## Full Skill Reference
|
|
139
|
-
|
|
140
|
-
See `skills/sonarcloud-analysis/SKILL.md` for complete API documentation including:
|
|
141
|
-
|
|
142
|
-
- All endpoints and parameters
|
|
143
|
-
- Response structures
|
|
144
|
-
- Pagination handling
|
|
145
|
-
- Advanced filtering
|
|
146
|
-
- Integration patterns
|
|
1
|
+
|
|
2
|
+
# SonarCloud Query Command
|
|
3
|
+
|
|
4
|
+
Pull code quality data from SonarCloud. Requires `SONARCLOUD_TOKEN` environment variable.
|
|
5
|
+
|
|
6
|
+
## Arguments
|
|
7
|
+
|
|
8
|
+
- `$ARGUMENTS` - Query type and parameters
|
|
9
|
+
|
|
10
|
+
## Query Types
|
|
11
|
+
|
|
12
|
+
| Query | Description | Example |
|
|
13
|
+
|-------|-------------|---------|
|
|
14
|
+
| `issues <project>` | Get open issues | `/sonarcloud issues my-project` |
|
|
15
|
+
| `metrics <project>` | Get code metrics | `/sonarcloud metrics my-project` |
|
|
16
|
+
| `gate <project>` | Quality gate status | `/sonarcloud gate my-project` |
|
|
17
|
+
| `health <project>` | Full health report | `/sonarcloud health my-project` |
|
|
18
|
+
| `pr <project> <pr#>` | PR analysis | `/sonarcloud pr my-project 123` |
|
|
19
|
+
| `hotspots <project>` | Security hotspots | `/sonarcloud hotspots my-project` |
|
|
20
|
+
| `history <project>` | Analysis history | `/sonarcloud history my-project` |
|
|
21
|
+
|
|
22
|
+
## Filters (append to query)
|
|
23
|
+
|
|
24
|
+
| Filter | Description | Example |
|
|
25
|
+
|--------|-------------|---------|
|
|
26
|
+
| `--branch <name>` | Filter by branch | `--branch develop` |
|
|
27
|
+
| `--severity <levels>` | Filter severity | `--severity BLOCKER,CRITICAL` |
|
|
28
|
+
| `--type <types>` | Filter issue type | `--type BUG,VULNERABILITY` |
|
|
29
|
+
| `--new-code` | Only new code issues | `--new-code` |
|
|
30
|
+
|
|
31
|
+
## Instructions
|
|
32
|
+
|
|
33
|
+
1. Parse the query from `$ARGUMENTS` to determine:
|
|
34
|
+
- Query type (issues, metrics, gate, health, pr, hotspots, history)
|
|
35
|
+
- Project key
|
|
36
|
+
- Optional filters (branch, severity, type, new-code, etc.)
|
|
37
|
+
2. Check for `SONARCLOUD_TOKEN` environment variable. If not set, inform user.
|
|
38
|
+
3. Check for `SONARCLOUD_ORG` environment variable or ask user for organization key.
|
|
39
|
+
4. Execute the appropriate API call using curl or the TypeScript client at `next-app/src/lib/integrations/sonarcloud.ts`
|
|
40
|
+
5. Format and present results clearly:
|
|
41
|
+
- For issues: Group by severity/type, show file, line, message
|
|
42
|
+
- For metrics: Show as table with metric name and value
|
|
43
|
+
- For quality gate: Show pass/fail with failed conditions
|
|
44
|
+
- For health: Comprehensive summary with all data
|
|
45
|
+
6. Offer follow-up actions:
|
|
46
|
+
- "Show issues in specific file?"
|
|
47
|
+
- "Get more details on a specific issue?"
|
|
48
|
+
- "Compare with another branch?"
|
|
49
|
+
|
|
50
|
+
## Example Outputs
|
|
51
|
+
|
|
52
|
+
### Issues Query
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
📋 Open Issues for my-project (branch: main)
|
|
56
|
+
|
|
57
|
+
Total: 45 issues
|
|
58
|
+
|
|
59
|
+
By Severity:
|
|
60
|
+
🔴 BLOCKER: 2
|
|
61
|
+
🟠 CRITICAL: 5
|
|
62
|
+
🟡 MAJOR: 18
|
|
63
|
+
⚪ MINOR: 15
|
|
64
|
+
⚫ INFO: 5
|
|
65
|
+
|
|
66
|
+
By Type:
|
|
67
|
+
🐛 BUG: 8
|
|
68
|
+
🔓 VULNERABILITY: 3
|
|
69
|
+
💩 CODE_SMELL: 34
|
|
70
|
+
|
|
71
|
+
Top Issues:
|
|
72
|
+
1. [CRITICAL] src/auth/login.ts:42 - SQL injection vulnerability
|
|
73
|
+
2. [BLOCKER] src/api/users.ts:156 - Null pointer dereference
|
|
74
|
+
...
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Metrics Query
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
📊 Metrics for my-project
|
|
81
|
+
|
|
82
|
+
| Metric | Value |
|
|
83
|
+
|--------|-------|
|
|
84
|
+
| Lines of Code | 51,234 |
|
|
85
|
+
| Coverage | 78.5% |
|
|
86
|
+
| Duplications | 3.2% |
|
|
87
|
+
| Bugs | 8 |
|
|
88
|
+
| Vulnerabilities | 3 |
|
|
89
|
+
| Code Smells | 34 |
|
|
90
|
+
| Technical Debt | 4d 2h |
|
|
91
|
+
| Maintainability | A |
|
|
92
|
+
| Reliability | B |
|
|
93
|
+
| Security | A |
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Quality Gate Query
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
🚦 Quality Gate: ❌ FAILED
|
|
100
|
+
|
|
101
|
+
Failed Conditions:
|
|
102
|
+
| Metric | Threshold | Actual |
|
|
103
|
+
|--------|-----------|--------|
|
|
104
|
+
| Coverage on New Code | ≥ 80% | 65.3% |
|
|
105
|
+
| New Bugs | = 0 | 2 |
|
|
106
|
+
|
|
107
|
+
Passed Conditions:
|
|
108
|
+
| Metric | Threshold | Actual |
|
|
109
|
+
|--------|-----------|--------|
|
|
110
|
+
| New Vulnerabilities | = 0 | 0 |
|
|
111
|
+
| Duplicated Lines | ≤ 3% | 1.2% |
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## API Reference
|
|
115
|
+
|
|
116
|
+
Base URL: `https://sonarcloud.io/api`
|
|
117
|
+
|
|
118
|
+
### Key Endpoints
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
# Issues
|
|
122
|
+
curl -H "Authorization: Bearer $TOKEN" \
|
|
123
|
+
"https://sonarcloud.io/api/issues/search?organization=$ORG&componentKeys=$PROJECT&resolved=false"
|
|
124
|
+
|
|
125
|
+
# Metrics
|
|
126
|
+
curl -H "Authorization: Bearer $TOKEN" \
|
|
127
|
+
"https://sonarcloud.io/api/measures/component?component=$PROJECT&metricKeys=bugs,vulnerabilities,coverage"
|
|
128
|
+
|
|
129
|
+
# Quality Gate
|
|
130
|
+
curl -H "Authorization: Bearer $TOKEN" \
|
|
131
|
+
"https://sonarcloud.io/api/qualitygates/project_status?projectKey=$PROJECT"
|
|
132
|
+
|
|
133
|
+
# Hotspots
|
|
134
|
+
curl -H "Authorization: Bearer $TOKEN" \
|
|
135
|
+
"https://sonarcloud.io/api/hotspots/search?projectKey=$PROJECT&status=TO_REVIEW"
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## Full Skill Reference
|
|
139
|
+
|
|
140
|
+
See `skills/sonarcloud-analysis/SKILL.md` for complete API documentation including:
|
|
141
|
+
|
|
142
|
+
- All endpoints and parameters
|
|
143
|
+
- Response structures
|
|
144
|
+
- Pagination handling
|
|
145
|
+
- Advanced filtering
|
|
146
|
+
- Integration patterns
|