@programinglive/dev-workflow-mcp-server 1.5.0 → 1.5.2
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/.agent/workflows/dev-workflow-bugfix.md +250 -250
- package/.agent/workflows/dev-workflow-feature.md +201 -201
- package/.agent/workflows/dev-workflow-full-cycle.md +400 -400
- package/.agent/workflows/dev-workflow-refactor.md +238 -238
- package/.github/ISSUE_TEMPLATE/bug_report.md +34 -34
- package/.github/ISSUE_TEMPLATE/feature_request.md +25 -25
- package/.github/pull_request_template.md +22 -22
- package/.github/workflows/npm-publish.yml +50 -47
- package/.husky/commit-msg +0 -0
- package/CHANGELOG.md +750 -491
- package/CODE_OF_CONDUCT.md +79 -79
- package/CONTRIBUTING.md +60 -60
- package/LICENSE +21 -21
- package/README.md +632 -609
- package/SECURITY.md +20 -20
- package/db/index.js +204 -204
- package/docs/NETLIFY_DEPLOYMENT.md +125 -0
- package/docs/PLESK_DEPLOYMENT.md +170 -0
- package/docs/WORKFLOW-BEST-PRACTICES.md +58 -0
- package/docs/antigravity/EXAMPLES.md +535 -535
- package/docs/antigravity/GETTING-STARTED.md +292 -292
- package/docs/antigravity/TROUBLESHOOTING.md +742 -742
- package/docs/antigravity/WALKTHROUGH.md +25 -25
- package/docs/antigravity/WORKFLOW-TEMPLATES.md +670 -670
- package/docs/product/PRD.md +67 -64
- package/docs/release-notes/RELEASE_NOTES.md +226 -132
- package/docs/web-dashboard.md +175 -163
- package/exec.js +49 -49
- package/index.js +279 -279
- package/install.js +73 -73
- package/package.json +11 -9
- package/release-wrapper.js +192 -157
- package/scripts/build-docs.js +63 -63
- package/scripts/hello-world.js +1 -1
- package/scripts/release.cjs +252 -252
- package/scripts/update-release-notes.cjs +178 -182
- package/server.json +23 -0
- package/tailwind.config.js +8 -10
- package/tests/build.test.js +83 -48
- package/tests/exec.test.js +35 -35
- package/tests/handlers.test.js +1058 -980
- package/tests/hello-world.test.js +13 -13
- package/tests/mcpRegistry.test.js +65 -0
- package/tests/release-wrapper.test.js +107 -105
- package/tests/workflowState.test.js +505 -502
- package/tools/definitions.js +332 -332
- package/tools/handlers.js +1019 -1019
- package/vite.config.js +43 -43
- package/vite.web.config.js +23 -0
- package/web/README.md +36 -0
- package/web/app/docs/page.tsx +202 -0
- package/web/app/favicon.ico +0 -0
- package/web/app/globals.css +91 -0
- package/web/app/layout.tsx +36 -0
- package/web/app/page.tsx +15 -0
- package/web/components/ApiReference.tsx +20 -0
- package/web/components/Features.tsx +61 -0
- package/web/components/Footer.tsx +9 -0
- package/web/components/Hero.tsx +96 -0
- package/web/components/History.tsx +143 -0
- package/web/components/Navbar.tsx +64 -0
- package/web/components/Terminal.tsx +114 -0
- package/web/eslint.config.mjs +18 -0
- package/web/lib/db.js +131 -0
- package/web/lib/docs.js +73 -0
- package/web/netlify.toml +3 -0
- package/web/next.config.ts +12 -0
- package/web/package-lock.json +6560 -0
- package/web/package.json +28 -0
- package/web/postcss.config.mjs +9 -0
- package/web/public/assets/android-chrome-192x192.png +0 -0
- package/web/public/assets/android-chrome-512x512.png +0 -0
- package/web/public/assets/apple-touch-icon.png +0 -0
- package/web/public/assets/favicon-16x16.png +0 -0
- package/web/public/assets/favicon-32x32.png +0 -0
- package/web/public/assets/favicon.ico +0 -0
- package/web/public/assets/favicon.png +0 -0
- package/web/public/assets/logo.png +0 -0
- package/web/public/assets/og-preview.png +0 -0
- package/web/public/assets/site.webmanifest +1 -0
- package/web/public/file.svg +1 -0
- package/web/public/globe.svg +1 -0
- package/web/public/next.svg +1 -0
- package/web/public/vercel.svg +1 -0
- package/web/public/window.svg +1 -0
- package/web/server.js +31 -159
- package/web/tailwind.config.ts +19 -0
- package/web/tsconfig.json +42 -0
- package/workflow-state.js +612 -626
- package/dist/docs/EXAMPLES.html +0 -411
- package/dist/docs/GETTING-STARTED.html +0 -233
- package/dist/docs/README.html +0 -535
- package/dist/docs/RELEASE_NOTES.html +0 -167
- package/dist/docs/TROUBLESHOOTING.html +0 -542
- package/dist/docs/WORKFLOW-TEMPLATES.html +0 -591
- package/dist/docs/web-dashboard.html +0 -158
- package/web/public/index.html +0 -1046
- package/web/public/input.css +0 -3
- package/web/public/output.css +0 -1
|
@@ -1,670 +1,670 @@
|
|
|
1
|
-
# Workflow Templates for Dev-Workflow MCP Server
|
|
2
|
-
|
|
3
|
-
Ready-to-use workflow templates for common development scenarios in Antigravity.
|
|
4
|
-
|
|
5
|
-
## Table of Contents
|
|
6
|
-
|
|
7
|
-
- [Feature Development Template](#feature-development-template)
|
|
8
|
-
- [Bug Fix Template](#bug-fix-template)
|
|
9
|
-
- [Refactoring Template](#refactoring-template)
|
|
10
|
-
- [Hotfix Template](#hotfix-template)
|
|
11
|
-
- [Documentation Update Template](#documentation-update-template)
|
|
12
|
-
- [Release Preparation Template](#release-preparation-template)
|
|
13
|
-
|
|
14
|
-
---
|
|
15
|
-
|
|
16
|
-
## Feature Development Template
|
|
17
|
-
|
|
18
|
-
Use this template when adding new functionality to your application.
|
|
19
|
-
|
|
20
|
-
### Checklist
|
|
21
|
-
|
|
22
|
-
```markdown
|
|
23
|
-
## Feature: [Feature Name]
|
|
24
|
-
|
|
25
|
-
### Planning
|
|
26
|
-
- [ ] Define feature requirements
|
|
27
|
-
- [ ] Design API/component interface
|
|
28
|
-
- [ ] Identify affected files
|
|
29
|
-
- [ ] Plan test cases
|
|
30
|
-
|
|
31
|
-
### Implementation
|
|
32
|
-
- [ ] Start workflow task
|
|
33
|
-
- [ ] Implement feature code
|
|
34
|
-
- [ ] Mark as fixed
|
|
35
|
-
|
|
36
|
-
### Testing
|
|
37
|
-
- [ ] Write unit tests
|
|
38
|
-
- [ ] Write integration tests
|
|
39
|
-
- [ ] Create tests in workflow
|
|
40
|
-
- [ ] Run test suite
|
|
41
|
-
- [ ] Record passing tests
|
|
42
|
-
|
|
43
|
-
### Documentation
|
|
44
|
-
- [ ] Update README
|
|
45
|
-
- [ ] Add inline comments
|
|
46
|
-
- [ ] Update API documentation
|
|
47
|
-
- [ ] Create documentation in workflow
|
|
48
|
-
|
|
49
|
-
### Release
|
|
50
|
-
- [ ] Commit and push changes
|
|
51
|
-
- [ ] Perform release (minor version)
|
|
52
|
-
- [ ] Complete task
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
### Workflow Commands
|
|
56
|
-
|
|
57
|
-
```
|
|
58
|
-
# 1. Start
|
|
59
|
-
start_task:
|
|
60
|
-
description: "Add [feature name] to [component/module]"
|
|
61
|
-
type: "feature"
|
|
62
|
-
|
|
63
|
-
# 2. Code the feature
|
|
64
|
-
# ... your implementation ...
|
|
65
|
-
|
|
66
|
-
# 3. Mark as fixed
|
|
67
|
-
mark_bug_fixed:
|
|
68
|
-
summary: "[Brief description of what was implemented]"
|
|
69
|
-
|
|
70
|
-
# 4. Create tests
|
|
71
|
-
# ... write your test files ...
|
|
72
|
-
create_tests
|
|
73
|
-
|
|
74
|
-
# 5. Run tests
|
|
75
|
-
run_tests:
|
|
76
|
-
passed: true
|
|
77
|
-
testCommand: "npm test"
|
|
78
|
-
details: "[X tests passed, coverage Y%]"
|
|
79
|
-
|
|
80
|
-
# 6. Document
|
|
81
|
-
# ... update documentation ...
|
|
82
|
-
create_documentation:
|
|
83
|
-
documentationType: "README"
|
|
84
|
-
summary: "[What you documented]"
|
|
85
|
-
|
|
86
|
-
# 7. Commit
|
|
87
|
-
commit_and_push:
|
|
88
|
-
commitMessage: "feat([scope]): [description]"
|
|
89
|
-
|
|
90
|
-
# 8. Release
|
|
91
|
-
perform_release:
|
|
92
|
-
command: "npm run release:minor"
|
|
93
|
-
notes: "v[X.Y.Z] - [Feature name]"
|
|
94
|
-
|
|
95
|
-
# 9. Complete
|
|
96
|
-
complete_task:
|
|
97
|
-
commitMessage: "feat([scope]): [description]"
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
### Example
|
|
101
|
-
|
|
102
|
-
**Feature:** Add shopping cart functionality
|
|
103
|
-
|
|
104
|
-
```
|
|
105
|
-
start_task:
|
|
106
|
-
description: "Add shopping cart with add/remove items and checkout"
|
|
107
|
-
type: "feature"
|
|
108
|
-
|
|
109
|
-
mark_bug_fixed:
|
|
110
|
-
summary: "Shopping cart with localStorage persistence and quantity controls"
|
|
111
|
-
|
|
112
|
-
create_tests
|
|
113
|
-
|
|
114
|
-
run_tests:
|
|
115
|
-
passed: true
|
|
116
|
-
testCommand: "npm test -- cart"
|
|
117
|
-
details: "12 cart tests passed: add, remove, update quantity, persist"
|
|
118
|
-
|
|
119
|
-
create_documentation:
|
|
120
|
-
documentationType: "README"
|
|
121
|
-
summary: "Added shopping cart API reference and integration guide"
|
|
122
|
-
|
|
123
|
-
commit_and_push:
|
|
124
|
-
commitMessage: "feat(cart): add shopping cart with persistence"
|
|
125
|
-
|
|
126
|
-
perform_release:
|
|
127
|
-
command: "npm run release:minor"
|
|
128
|
-
notes: "v1.5.0 - Shopping cart feature"
|
|
129
|
-
|
|
130
|
-
complete_task:
|
|
131
|
-
commitMessage: "feat(cart): add shopping cart with persistence"
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
---
|
|
135
|
-
|
|
136
|
-
## Bug Fix Template
|
|
137
|
-
|
|
138
|
-
Use this template when fixing defects or unexpected behavior.
|
|
139
|
-
|
|
140
|
-
### Checklist
|
|
141
|
-
|
|
142
|
-
```markdown
|
|
143
|
-
## Bug Fix: [Bug Description]
|
|
144
|
-
|
|
145
|
-
### Investigation
|
|
146
|
-
- [ ] Reproduce the bug
|
|
147
|
-
- [ ] Identify root cause
|
|
148
|
-
- [ ] Document expected vs actual behavior
|
|
149
|
-
|
|
150
|
-
### Implementation
|
|
151
|
-
- [ ] Start workflow task
|
|
152
|
-
- [ ] Fix the bug
|
|
153
|
-
- [ ] Verify fix locally
|
|
154
|
-
- [ ] Mark as fixed
|
|
155
|
-
|
|
156
|
-
### Testing
|
|
157
|
-
- [ ] Write regression test
|
|
158
|
-
- [ ] Update existing tests if needed
|
|
159
|
-
- [ ] Create tests in workflow
|
|
160
|
-
- [ ] Run full test suite
|
|
161
|
-
- [ ] Record passing tests
|
|
162
|
-
|
|
163
|
-
### Documentation
|
|
164
|
-
- [ ] Update CHANGELOG
|
|
165
|
-
- [ ] Add code comments explaining the fix
|
|
166
|
-
- [ ] Create documentation in workflow
|
|
167
|
-
|
|
168
|
-
### Release
|
|
169
|
-
- [ ] Commit and push changes
|
|
170
|
-
- [ ] Perform release (patch version)
|
|
171
|
-
- [ ] Complete task
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
### Workflow Commands
|
|
175
|
-
|
|
176
|
-
```
|
|
177
|
-
# 1. Start
|
|
178
|
-
start_task:
|
|
179
|
-
description: "Fix [bug description]"
|
|
180
|
-
type: "bugfix"
|
|
181
|
-
|
|
182
|
-
# 2. Fix the bug
|
|
183
|
-
# ... your fix ...
|
|
184
|
-
|
|
185
|
-
# 3. Mark as fixed
|
|
186
|
-
mark_bug_fixed:
|
|
187
|
-
summary: "[Brief description of the fix]"
|
|
188
|
-
|
|
189
|
-
# 4. Create regression tests
|
|
190
|
-
# ... write test to prevent recurrence ...
|
|
191
|
-
create_tests
|
|
192
|
-
|
|
193
|
-
# 5. Run tests
|
|
194
|
-
run_tests:
|
|
195
|
-
passed: true
|
|
196
|
-
testCommand: "npm test"
|
|
197
|
-
details: "[Include regression test results]"
|
|
198
|
-
|
|
199
|
-
# 6. Document
|
|
200
|
-
# ... update CHANGELOG ...
|
|
201
|
-
create_documentation:
|
|
202
|
-
documentationType: "changelog"
|
|
203
|
-
summary: "[What you documented]"
|
|
204
|
-
|
|
205
|
-
# 7. Commit
|
|
206
|
-
commit_and_push:
|
|
207
|
-
commitMessage: "fix([scope]): [description]"
|
|
208
|
-
|
|
209
|
-
# 8. Release
|
|
210
|
-
perform_release:
|
|
211
|
-
command: "npm run release:patch"
|
|
212
|
-
notes: "v[X.Y.Z] - Bugfix for [issue]"
|
|
213
|
-
|
|
214
|
-
# 9. Complete
|
|
215
|
-
complete_task:
|
|
216
|
-
commitMessage: "fix([scope]): [description]"
|
|
217
|
-
```
|
|
218
|
-
|
|
219
|
-
### Example
|
|
220
|
-
|
|
221
|
-
**Bug:** Date picker shows wrong month on mobile
|
|
222
|
-
|
|
223
|
-
```
|
|
224
|
-
start_task:
|
|
225
|
-
description: "Fix date picker showing incorrect month on iOS Safari"
|
|
226
|
-
type: "bugfix"
|
|
227
|
-
|
|
228
|
-
mark_bug_fixed:
|
|
229
|
-
summary: "Fixed timezone offset calculation in date picker for iOS Safari"
|
|
230
|
-
|
|
231
|
-
create_tests
|
|
232
|
-
|
|
233
|
-
run_tests:
|
|
234
|
-
passed: true
|
|
235
|
-
testCommand: "npm test -- datepicker"
|
|
236
|
-
details: "Added timezone regression test, all 8 tests pass"
|
|
237
|
-
|
|
238
|
-
create_documentation:
|
|
239
|
-
documentationType: "changelog"
|
|
240
|
-
summary: "Added bug fix entry for date picker iOS issue"
|
|
241
|
-
|
|
242
|
-
commit_and_push:
|
|
243
|
-
commitMessage: "fix(ui): correct date picker timezone handling on iOS"
|
|
244
|
-
|
|
245
|
-
perform_release:
|
|
246
|
-
command: "npm run release:patch"
|
|
247
|
-
notes: "v1.4.1 - iOS date picker fix"
|
|
248
|
-
|
|
249
|
-
complete_task:
|
|
250
|
-
commitMessage: "fix(ui): correct date picker timezone handling on iOS"
|
|
251
|
-
```
|
|
252
|
-
|
|
253
|
-
---
|
|
254
|
-
|
|
255
|
-
## Refactoring Template
|
|
256
|
-
|
|
257
|
-
Use this template when improving code structure without changing behavior.
|
|
258
|
-
|
|
259
|
-
### Checklist
|
|
260
|
-
|
|
261
|
-
```markdown
|
|
262
|
-
## Refactoring: [What You're Refactoring]
|
|
263
|
-
|
|
264
|
-
### Planning
|
|
265
|
-
- [ ] Identify code smell or improvement opportunity
|
|
266
|
-
- [ ] Define refactoring goal
|
|
267
|
-
- [ ] Ensure test coverage exists
|
|
268
|
-
- [ ] Plan incremental changes
|
|
269
|
-
|
|
270
|
-
### Implementation
|
|
271
|
-
- [ ] Start workflow task
|
|
272
|
-
- [ ] Refactor code
|
|
273
|
-
- [ ] Verify behavior unchanged
|
|
274
|
-
- [ ] Mark as fixed
|
|
275
|
-
|
|
276
|
-
### Testing
|
|
277
|
-
- [ ] Update tests for new structure
|
|
278
|
-
- [ ] Ensure all existing tests still pass
|
|
279
|
-
- [ ] Create tests in workflow
|
|
280
|
-
- [ ] Run full test suite
|
|
281
|
-
- [ ] Record passing tests
|
|
282
|
-
|
|
283
|
-
### Documentation
|
|
284
|
-
- [ ] Update inline documentation
|
|
285
|
-
- [ ] Update architecture docs if needed
|
|
286
|
-
- [ ] Create documentation in workflow
|
|
287
|
-
|
|
288
|
-
### Release
|
|
289
|
-
- [ ] Commit and push changes
|
|
290
|
-
- [ ] Perform release (minor/patch)
|
|
291
|
-
- [ ] Complete task
|
|
292
|
-
```
|
|
293
|
-
|
|
294
|
-
### Workflow Commands
|
|
295
|
-
|
|
296
|
-
```
|
|
297
|
-
# 1. Start
|
|
298
|
-
start_task:
|
|
299
|
-
description: "Refactor [component/module] to [improvement goal]"
|
|
300
|
-
type: "refactor"
|
|
301
|
-
|
|
302
|
-
# 2. Refactor
|
|
303
|
-
# ... your refactoring ...
|
|
304
|
-
|
|
305
|
-
# 3. Mark as fixed
|
|
306
|
-
mark_bug_fixed:
|
|
307
|
-
summary: "[Brief description of refactoring]"
|
|
308
|
-
|
|
309
|
-
# 4. Update tests
|
|
310
|
-
# ... update test structure ...
|
|
311
|
-
create_tests
|
|
312
|
-
|
|
313
|
-
# 5. Run tests
|
|
314
|
-
run_tests:
|
|
315
|
-
passed: true
|
|
316
|
-
testCommand: "npm test -- --coverage"
|
|
317
|
-
details: "[All tests pass, coverage maintained/improved]"
|
|
318
|
-
|
|
319
|
-
# 6. Document
|
|
320
|
-
create_documentation:
|
|
321
|
-
documentationType: "inline-comments"
|
|
322
|
-
summary: "[Updated documentation]"
|
|
323
|
-
|
|
324
|
-
# 7. Commit
|
|
325
|
-
commit_and_push:
|
|
326
|
-
commitMessage: "refactor([scope]): [description]"
|
|
327
|
-
|
|
328
|
-
# 8. Release
|
|
329
|
-
perform_release:
|
|
330
|
-
command: "npm run release:minor"
|
|
331
|
-
notes: "v[X.Y.Z] - Internal improvements"
|
|
332
|
-
|
|
333
|
-
# 9. Complete
|
|
334
|
-
complete_task:
|
|
335
|
-
commitMessage: "refactor([scope]): [description]"
|
|
336
|
-
```
|
|
337
|
-
|
|
338
|
-
### Example
|
|
339
|
-
|
|
340
|
-
**Refactoring:** Extract authentication logic to custom hooks
|
|
341
|
-
|
|
342
|
-
```
|
|
343
|
-
start_task:
|
|
344
|
-
description: "Refactor authentication logic into reusable custom hooks"
|
|
345
|
-
type: "refactor"
|
|
346
|
-
|
|
347
|
-
mark_bug_fixed:
|
|
348
|
-
summary: "Extracted useAuth and usePermissions hooks from component logic"
|
|
349
|
-
|
|
350
|
-
create_tests
|
|
351
|
-
|
|
352
|
-
run_tests:
|
|
353
|
-
passed: true
|
|
354
|
-
testCommand: "npm test -- --coverage"
|
|
355
|
-
details: "All 145 tests pass, coverage improved from 89% to 92%"
|
|
356
|
-
|
|
357
|
-
create_documentation:
|
|
358
|
-
documentationType: "inline-comments"
|
|
359
|
-
summary: "Added JSDoc for custom hooks and usage examples"
|
|
360
|
-
|
|
361
|
-
commit_and_push:
|
|
362
|
-
commitMessage: "refactor(auth): extract authentication logic to custom hooks"
|
|
363
|
-
|
|
364
|
-
perform_release:
|
|
365
|
-
command: "npm run release:minor"
|
|
366
|
-
notes: "v1.6.0 - Authentication refactoring (improved maintainability)"
|
|
367
|
-
|
|
368
|
-
complete_task:
|
|
369
|
-
commitMessage: "refactor(auth): extract authentication logic to custom hooks"
|
|
370
|
-
```
|
|
371
|
-
|
|
372
|
-
---
|
|
373
|
-
|
|
374
|
-
## Hotfix Template
|
|
375
|
-
|
|
376
|
-
Use this for urgent production fixes that need immediate deployment.
|
|
377
|
-
|
|
378
|
-
### Checklist
|
|
379
|
-
|
|
380
|
-
```markdown
|
|
381
|
-
## Hotfix: [Critical Issue]
|
|
382
|
-
|
|
383
|
-
### Urgent Actions
|
|
384
|
-
- [ ] Identify production issue
|
|
385
|
-
- [ ] Create hotfix branch if using git-flow
|
|
386
|
-
- [ ] Start workflow task
|
|
387
|
-
|
|
388
|
-
### Fix
|
|
389
|
-
- [ ] Implement minimal fix
|
|
390
|
-
- [ ] Test fix locally
|
|
391
|
-
- [ ] Mark as fixed
|
|
392
|
-
|
|
393
|
-
### Testing
|
|
394
|
-
- [ ] Create focused regression test
|
|
395
|
-
- [ ] Run relevant test suite
|
|
396
|
-
- [ ] Manual verification in staging
|
|
397
|
-
- [ ] Record passing tests
|
|
398
|
-
|
|
399
|
-
### Documentation
|
|
400
|
-
- [ ] Update CHANGELOG with hotfix note
|
|
401
|
-
- [ ] Document in workflow
|
|
402
|
-
|
|
403
|
-
### Release
|
|
404
|
-
- [ ] Commit and push
|
|
405
|
-
- [ ] Perform PATCH release
|
|
406
|
-
- [ ] Deploy to production immediately
|
|
407
|
-
- [ ] Complete task
|
|
408
|
-
- [ ] Notify team
|
|
409
|
-
```
|
|
410
|
-
|
|
411
|
-
### Workflow Commands
|
|
412
|
-
|
|
413
|
-
```
|
|
414
|
-
# 1. Start immediately
|
|
415
|
-
start_task:
|
|
416
|
-
description: "HOTFIX: [critical issue description]"
|
|
417
|
-
type: "bugfix"
|
|
418
|
-
|
|
419
|
-
# 2. Minimal fix
|
|
420
|
-
# ... implement fix ...
|
|
421
|
-
|
|
422
|
-
# 3. Mark as fixed
|
|
423
|
-
mark_bug_fixed:
|
|
424
|
-
summary: "[Brief description of hotfix]"
|
|
425
|
-
|
|
426
|
-
# 4. Focused test
|
|
427
|
-
create_tests
|
|
428
|
-
|
|
429
|
-
# 5. Run tests
|
|
430
|
-
run_tests:
|
|
431
|
-
passed: true
|
|
432
|
-
testCommand: "npm test -- [relevant-tests]"
|
|
433
|
-
details: "[Critical path tests pass]"
|
|
434
|
-
|
|
435
|
-
# 6. Document urgency
|
|
436
|
-
create_documentation:
|
|
437
|
-
documentationType: "changelog"
|
|
438
|
-
summary: "HOTFIX: [issue] - [fix description]"
|
|
439
|
-
|
|
440
|
-
# 7. Commit
|
|
441
|
-
commit_and_push:
|
|
442
|
-
commitMessage: "fix([scope])!: HOTFIX - [description]"
|
|
443
|
-
|
|
444
|
-
# 8. Emergency release
|
|
445
|
-
perform_release:
|
|
446
|
-
command: "npm run release:patch"
|
|
447
|
-
notes: "v[X.Y.Z] - HOTFIX: [issue]"
|
|
448
|
-
|
|
449
|
-
# 9. Complete
|
|
450
|
-
complete_task:
|
|
451
|
-
commitMessage: "fix([scope])!: HOTFIX - [description]"
|
|
452
|
-
```
|
|
453
|
-
|
|
454
|
-
### Example
|
|
455
|
-
|
|
456
|
-
**Hotfix:** Payment processing fails on production
|
|
457
|
-
|
|
458
|
-
```
|
|
459
|
-
start_task:
|
|
460
|
-
description: "HOTFIX: Payment gateway timeout causing checkout failures"
|
|
461
|
-
type: "bugfix"
|
|
462
|
-
|
|
463
|
-
mark_bug_fixed:
|
|
464
|
-
summary: "Increased payment API timeout from 5s to 30s and added retry logic"
|
|
465
|
-
|
|
466
|
-
create_tests
|
|
467
|
-
|
|
468
|
-
run_tests:
|
|
469
|
-
passed: true
|
|
470
|
-
testCommand: "npm test -- payment"
|
|
471
|
-
details: "Payment flow tests pass with timeout scenarios"
|
|
472
|
-
|
|
473
|
-
create_documentation:
|
|
474
|
-
documentationType: "changelog"
|
|
475
|
-
summary: "HOTFIX: Resolved payment timeout failures with increased timeout and retry"
|
|
476
|
-
|
|
477
|
-
commit_and_push:
|
|
478
|
-
commitMessage: "fix(payment)!: HOTFIX - increase timeout and add retry logic"
|
|
479
|
-
|
|
480
|
-
perform_release:
|
|
481
|
-
command: "npm run release:patch"
|
|
482
|
-
notes: "v1.4.2 - HOTFIX: Payment processing timeout"
|
|
483
|
-
|
|
484
|
-
complete_task:
|
|
485
|
-
commitMessage: "fix(payment)!: HOTFIX - increase timeout and add retry logic"
|
|
486
|
-
```
|
|
487
|
-
|
|
488
|
-
---
|
|
489
|
-
|
|
490
|
-
## Documentation Update Template
|
|
491
|
-
|
|
492
|
-
Use this when updating documentation without code changes.
|
|
493
|
-
|
|
494
|
-
### Workflow Commands
|
|
495
|
-
|
|
496
|
-
```
|
|
497
|
-
# 1. Start
|
|
498
|
-
start_task:
|
|
499
|
-
description: "Update documentation for [topic]"
|
|
500
|
-
type: "other"
|
|
501
|
-
|
|
502
|
-
# 2. Update docs
|
|
503
|
-
# ... write documentation ...
|
|
504
|
-
|
|
505
|
-
# 3. Mark as complete
|
|
506
|
-
mark_bug_fixed:
|
|
507
|
-
summary: "Updated [documentation type] with [additions]"
|
|
508
|
-
|
|
509
|
-
# 4. Skip tests (documentation only)
|
|
510
|
-
skip_tests:
|
|
511
|
-
reason: "Documentation-only change, no code modified"
|
|
512
|
-
|
|
513
|
-
# 5. Document
|
|
514
|
-
create_documentation:
|
|
515
|
-
documentationType: "README"
|
|
516
|
-
summary: "[What documentation was added/updated]"
|
|
517
|
-
|
|
518
|
-
# 6. Commit
|
|
519
|
-
commit_and_push:
|
|
520
|
-
commitMessage: "docs([scope]): [description]"
|
|
521
|
-
|
|
522
|
-
# 7. Release
|
|
523
|
-
perform_release:
|
|
524
|
-
command: "npm run release:patch"
|
|
525
|
-
notes: "v[X.Y.Z] - Documentation updates"
|
|
526
|
-
|
|
527
|
-
# 8. Complete
|
|
528
|
-
complete_task:
|
|
529
|
-
commitMessage: "docs([scope]): [description]"
|
|
530
|
-
```
|
|
531
|
-
|
|
532
|
-
### Example
|
|
533
|
-
|
|
534
|
-
```
|
|
535
|
-
start_task:
|
|
536
|
-
description: "Add migration guide for v2.0 breaking changes"
|
|
537
|
-
type: "other"
|
|
538
|
-
|
|
539
|
-
mark_bug_fixed:
|
|
540
|
-
summary: "Created comprehensive v2.0 migration guide with examples"
|
|
541
|
-
|
|
542
|
-
skip_tests:
|
|
543
|
-
reason: "Documentation-only update, no code changes"
|
|
544
|
-
|
|
545
|
-
create_documentation:
|
|
546
|
-
documentationType: "API-docs"
|
|
547
|
-
summary: "Added MIGRATION_V2.md with breaking changes and upgrade steps"
|
|
548
|
-
|
|
549
|
-
commit_and_push:
|
|
550
|
-
commitMessage: "docs(migration): add v2.0 migration guide"
|
|
551
|
-
|
|
552
|
-
perform_release:
|
|
553
|
-
command: "npm run release:patch"
|
|
554
|
-
notes: "v1.4.3 - v2.0 migration guide"
|
|
555
|
-
|
|
556
|
-
complete_task:
|
|
557
|
-
commitMessage: "docs(migration): add v2.0 migration guide"
|
|
558
|
-
```
|
|
559
|
-
|
|
560
|
-
---
|
|
561
|
-
|
|
562
|
-
## Release Preparation Template
|
|
563
|
-
|
|
564
|
-
Use this when preparing a major/minor release with multiple features.
|
|
565
|
-
|
|
566
|
-
### Checklist
|
|
567
|
-
|
|
568
|
-
```markdown
|
|
569
|
-
## Release Preparation: v[X.Y.Z]
|
|
570
|
-
|
|
571
|
-
### Pre-Release
|
|
572
|
-
- [ ] Review all merged features
|
|
573
|
-
- [ ] Update version numbers
|
|
574
|
-
- [ ] Update CHANGELOG
|
|
575
|
-
- [ ] Run full test suite
|
|
576
|
-
- [ ] Check documentation completeness
|
|
577
|
-
|
|
578
|
-
### Workflow
|
|
579
|
-
- [ ] Start workflow task
|
|
580
|
-
- [ ] Mark preparation as complete
|
|
581
|
-
- [ ] Verify tests
|
|
582
|
-
- [ ] Create documentation
|
|
583
|
-
- [ ] Commit and push
|
|
584
|
-
- [ ] Perform release
|
|
585
|
-
- [ ] Complete task
|
|
586
|
-
|
|
587
|
-
### Post-Release
|
|
588
|
-
- [ ] Tag release in git
|
|
589
|
-
- [ ] Create GitHub release notes
|
|
590
|
-
- [ ] Publish to npm/registry
|
|
591
|
-
- [ ] Notify users
|
|
592
|
-
```
|
|
593
|
-
|
|
594
|
-
### Workflow Commands
|
|
595
|
-
|
|
596
|
-
```
|
|
597
|
-
start_task:
|
|
598
|
-
description: "Prepare release v[X.Y.Z] with [feature list]"
|
|
599
|
-
type: "other"
|
|
600
|
-
|
|
601
|
-
mark_bug_fixed:
|
|
602
|
-
summary: "Release preparation complete: CHANGELOG updated, version bumped to [X.Y.Z]"
|
|
603
|
-
|
|
604
|
-
create_tests
|
|
605
|
-
|
|
606
|
-
run_tests:
|
|
607
|
-
passed: true
|
|
608
|
-
testCommand: "npm test -- --coverage"
|
|
609
|
-
details: "Full test suite: [X tests pass], coverage [Y%]"
|
|
610
|
-
|
|
611
|
-
create_documentation:
|
|
612
|
-
documentationType: "changelog"
|
|
613
|
-
summary: "Updated CHANGELOG with all v[X.Y.Z] features and fixes"
|
|
614
|
-
|
|
615
|
-
commit_and_push:
|
|
616
|
-
commitMessage: "chore(release): prepare v[X.Y.Z]"
|
|
617
|
-
|
|
618
|
-
perform_release:
|
|
619
|
-
command: "npm run release:minor"
|
|
620
|
-
notes: "v[X.Y.Z] - [Release highlights]"
|
|
621
|
-
|
|
622
|
-
complete_task:
|
|
623
|
-
commitMessage: "chore(release): prepare v[X.Y.Z]"
|
|
624
|
-
```
|
|
625
|
-
|
|
626
|
-
---
|
|
627
|
-
|
|
628
|
-
## Using Templates in Antigravity
|
|
629
|
-
|
|
630
|
-
### Quick Template Application
|
|
631
|
-
|
|
632
|
-
1. **Choose your template** based on task type
|
|
633
|
-
2. **Copy the workflow commands** section
|
|
634
|
-
3. **Customize** brackets [...] with your specific details
|
|
635
|
-
4. **Execute** commands in Antigravity
|
|
636
|
-
|
|
637
|
-
### Template Variables
|
|
638
|
-
|
|
639
|
-
Replace these placeholders in templates:
|
|
640
|
-
|
|
641
|
-
- `[Feature Name]` - Your feature description
|
|
642
|
-
- `[Bug Description]` - Bug summary
|
|
643
|
-
- `[scope]` - Conventional commit scope (e.g., auth, ui, api)
|
|
644
|
-
- `[description]` - Commit description
|
|
645
|
-
- `[X.Y.Z]` - Version number
|
|
646
|
-
- `[X tests]` - Number of tests
|
|
647
|
-
- `[Y%]` - Coverage percentage
|
|
648
|
-
|
|
649
|
-
### Automation with Workflows
|
|
650
|
-
|
|
651
|
-
Save these as Antigravity workflow files in `.agent/workflows/`:
|
|
652
|
-
|
|
653
|
-
- `dev-workflow-feature.md`
|
|
654
|
-
- `dev-workflow-bugfix.md`
|
|
655
|
-
- `dev-workflow-refactor.md`
|
|
656
|
-
- `dev-workflow-hotfix.md`
|
|
657
|
-
|
|
658
|
-
Then use slash commands like `/dev-workflow-feature` to load templates!
|
|
659
|
-
|
|
660
|
-
---
|
|
661
|
-
|
|
662
|
-
## Next Steps
|
|
663
|
-
|
|
664
|
-
- See [EXAMPLES.md](./EXAMPLES.md) for real-world usage scenarios
|
|
665
|
-
- Check [TROUBLESHOOTING.md](./TROUBLESHOOTING.md) for common issues
|
|
666
|
-
- Return to [GETTING-STARTED.md](./GETTING-STARTED.md) for setup
|
|
667
|
-
|
|
668
|
-
---
|
|
669
|
-
|
|
670
|
-
**Consistent workflows lead to consistent quality!** ⚡
|
|
1
|
+
# Workflow Templates for Dev-Workflow MCP Server
|
|
2
|
+
|
|
3
|
+
Ready-to-use workflow templates for common development scenarios in Antigravity.
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
- [Feature Development Template](#feature-development-template)
|
|
8
|
+
- [Bug Fix Template](#bug-fix-template)
|
|
9
|
+
- [Refactoring Template](#refactoring-template)
|
|
10
|
+
- [Hotfix Template](#hotfix-template)
|
|
11
|
+
- [Documentation Update Template](#documentation-update-template)
|
|
12
|
+
- [Release Preparation Template](#release-preparation-template)
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Feature Development Template
|
|
17
|
+
|
|
18
|
+
Use this template when adding new functionality to your application.
|
|
19
|
+
|
|
20
|
+
### Checklist
|
|
21
|
+
|
|
22
|
+
```markdown
|
|
23
|
+
## Feature: [Feature Name]
|
|
24
|
+
|
|
25
|
+
### Planning
|
|
26
|
+
- [ ] Define feature requirements
|
|
27
|
+
- [ ] Design API/component interface
|
|
28
|
+
- [ ] Identify affected files
|
|
29
|
+
- [ ] Plan test cases
|
|
30
|
+
|
|
31
|
+
### Implementation
|
|
32
|
+
- [ ] Start workflow task
|
|
33
|
+
- [ ] Implement feature code
|
|
34
|
+
- [ ] Mark as fixed
|
|
35
|
+
|
|
36
|
+
### Testing
|
|
37
|
+
- [ ] Write unit tests
|
|
38
|
+
- [ ] Write integration tests
|
|
39
|
+
- [ ] Create tests in workflow
|
|
40
|
+
- [ ] Run test suite
|
|
41
|
+
- [ ] Record passing tests
|
|
42
|
+
|
|
43
|
+
### Documentation
|
|
44
|
+
- [ ] Update README
|
|
45
|
+
- [ ] Add inline comments
|
|
46
|
+
- [ ] Update API documentation
|
|
47
|
+
- [ ] Create documentation in workflow
|
|
48
|
+
|
|
49
|
+
### Release
|
|
50
|
+
- [ ] Commit and push changes
|
|
51
|
+
- [ ] Perform release (minor version)
|
|
52
|
+
- [ ] Complete task
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Workflow Commands
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
# 1. Start
|
|
59
|
+
start_task:
|
|
60
|
+
description: "Add [feature name] to [component/module]"
|
|
61
|
+
type: "feature"
|
|
62
|
+
|
|
63
|
+
# 2. Code the feature
|
|
64
|
+
# ... your implementation ...
|
|
65
|
+
|
|
66
|
+
# 3. Mark as fixed
|
|
67
|
+
mark_bug_fixed:
|
|
68
|
+
summary: "[Brief description of what was implemented]"
|
|
69
|
+
|
|
70
|
+
# 4. Create tests
|
|
71
|
+
# ... write your test files ...
|
|
72
|
+
create_tests
|
|
73
|
+
|
|
74
|
+
# 5. Run tests
|
|
75
|
+
run_tests:
|
|
76
|
+
passed: true
|
|
77
|
+
testCommand: "npm test"
|
|
78
|
+
details: "[X tests passed, coverage Y%]"
|
|
79
|
+
|
|
80
|
+
# 6. Document
|
|
81
|
+
# ... update documentation ...
|
|
82
|
+
create_documentation:
|
|
83
|
+
documentationType: "README"
|
|
84
|
+
summary: "[What you documented]"
|
|
85
|
+
|
|
86
|
+
# 7. Commit
|
|
87
|
+
commit_and_push:
|
|
88
|
+
commitMessage: "feat([scope]): [description]"
|
|
89
|
+
|
|
90
|
+
# 8. Release
|
|
91
|
+
perform_release:
|
|
92
|
+
command: "npm run release:minor"
|
|
93
|
+
notes: "v[X.Y.Z] - [Feature name]"
|
|
94
|
+
|
|
95
|
+
# 9. Complete
|
|
96
|
+
complete_task:
|
|
97
|
+
commitMessage: "feat([scope]): [description]"
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Example
|
|
101
|
+
|
|
102
|
+
**Feature:** Add shopping cart functionality
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
start_task:
|
|
106
|
+
description: "Add shopping cart with add/remove items and checkout"
|
|
107
|
+
type: "feature"
|
|
108
|
+
|
|
109
|
+
mark_bug_fixed:
|
|
110
|
+
summary: "Shopping cart with localStorage persistence and quantity controls"
|
|
111
|
+
|
|
112
|
+
create_tests
|
|
113
|
+
|
|
114
|
+
run_tests:
|
|
115
|
+
passed: true
|
|
116
|
+
testCommand: "npm test -- cart"
|
|
117
|
+
details: "12 cart tests passed: add, remove, update quantity, persist"
|
|
118
|
+
|
|
119
|
+
create_documentation:
|
|
120
|
+
documentationType: "README"
|
|
121
|
+
summary: "Added shopping cart API reference and integration guide"
|
|
122
|
+
|
|
123
|
+
commit_and_push:
|
|
124
|
+
commitMessage: "feat(cart): add shopping cart with persistence"
|
|
125
|
+
|
|
126
|
+
perform_release:
|
|
127
|
+
command: "npm run release:minor"
|
|
128
|
+
notes: "v1.5.0 - Shopping cart feature"
|
|
129
|
+
|
|
130
|
+
complete_task:
|
|
131
|
+
commitMessage: "feat(cart): add shopping cart with persistence"
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## Bug Fix Template
|
|
137
|
+
|
|
138
|
+
Use this template when fixing defects or unexpected behavior.
|
|
139
|
+
|
|
140
|
+
### Checklist
|
|
141
|
+
|
|
142
|
+
```markdown
|
|
143
|
+
## Bug Fix: [Bug Description]
|
|
144
|
+
|
|
145
|
+
### Investigation
|
|
146
|
+
- [ ] Reproduce the bug
|
|
147
|
+
- [ ] Identify root cause
|
|
148
|
+
- [ ] Document expected vs actual behavior
|
|
149
|
+
|
|
150
|
+
### Implementation
|
|
151
|
+
- [ ] Start workflow task
|
|
152
|
+
- [ ] Fix the bug
|
|
153
|
+
- [ ] Verify fix locally
|
|
154
|
+
- [ ] Mark as fixed
|
|
155
|
+
|
|
156
|
+
### Testing
|
|
157
|
+
- [ ] Write regression test
|
|
158
|
+
- [ ] Update existing tests if needed
|
|
159
|
+
- [ ] Create tests in workflow
|
|
160
|
+
- [ ] Run full test suite
|
|
161
|
+
- [ ] Record passing tests
|
|
162
|
+
|
|
163
|
+
### Documentation
|
|
164
|
+
- [ ] Update CHANGELOG
|
|
165
|
+
- [ ] Add code comments explaining the fix
|
|
166
|
+
- [ ] Create documentation in workflow
|
|
167
|
+
|
|
168
|
+
### Release
|
|
169
|
+
- [ ] Commit and push changes
|
|
170
|
+
- [ ] Perform release (patch version)
|
|
171
|
+
- [ ] Complete task
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### Workflow Commands
|
|
175
|
+
|
|
176
|
+
```
|
|
177
|
+
# 1. Start
|
|
178
|
+
start_task:
|
|
179
|
+
description: "Fix [bug description]"
|
|
180
|
+
type: "bugfix"
|
|
181
|
+
|
|
182
|
+
# 2. Fix the bug
|
|
183
|
+
# ... your fix ...
|
|
184
|
+
|
|
185
|
+
# 3. Mark as fixed
|
|
186
|
+
mark_bug_fixed:
|
|
187
|
+
summary: "[Brief description of the fix]"
|
|
188
|
+
|
|
189
|
+
# 4. Create regression tests
|
|
190
|
+
# ... write test to prevent recurrence ...
|
|
191
|
+
create_tests
|
|
192
|
+
|
|
193
|
+
# 5. Run tests
|
|
194
|
+
run_tests:
|
|
195
|
+
passed: true
|
|
196
|
+
testCommand: "npm test"
|
|
197
|
+
details: "[Include regression test results]"
|
|
198
|
+
|
|
199
|
+
# 6. Document
|
|
200
|
+
# ... update CHANGELOG ...
|
|
201
|
+
create_documentation:
|
|
202
|
+
documentationType: "changelog"
|
|
203
|
+
summary: "[What you documented]"
|
|
204
|
+
|
|
205
|
+
# 7. Commit
|
|
206
|
+
commit_and_push:
|
|
207
|
+
commitMessage: "fix([scope]): [description]"
|
|
208
|
+
|
|
209
|
+
# 8. Release
|
|
210
|
+
perform_release:
|
|
211
|
+
command: "npm run release:patch"
|
|
212
|
+
notes: "v[X.Y.Z] - Bugfix for [issue]"
|
|
213
|
+
|
|
214
|
+
# 9. Complete
|
|
215
|
+
complete_task:
|
|
216
|
+
commitMessage: "fix([scope]): [description]"
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
### Example
|
|
220
|
+
|
|
221
|
+
**Bug:** Date picker shows wrong month on mobile
|
|
222
|
+
|
|
223
|
+
```
|
|
224
|
+
start_task:
|
|
225
|
+
description: "Fix date picker showing incorrect month on iOS Safari"
|
|
226
|
+
type: "bugfix"
|
|
227
|
+
|
|
228
|
+
mark_bug_fixed:
|
|
229
|
+
summary: "Fixed timezone offset calculation in date picker for iOS Safari"
|
|
230
|
+
|
|
231
|
+
create_tests
|
|
232
|
+
|
|
233
|
+
run_tests:
|
|
234
|
+
passed: true
|
|
235
|
+
testCommand: "npm test -- datepicker"
|
|
236
|
+
details: "Added timezone regression test, all 8 tests pass"
|
|
237
|
+
|
|
238
|
+
create_documentation:
|
|
239
|
+
documentationType: "changelog"
|
|
240
|
+
summary: "Added bug fix entry for date picker iOS issue"
|
|
241
|
+
|
|
242
|
+
commit_and_push:
|
|
243
|
+
commitMessage: "fix(ui): correct date picker timezone handling on iOS"
|
|
244
|
+
|
|
245
|
+
perform_release:
|
|
246
|
+
command: "npm run release:patch"
|
|
247
|
+
notes: "v1.4.1 - iOS date picker fix"
|
|
248
|
+
|
|
249
|
+
complete_task:
|
|
250
|
+
commitMessage: "fix(ui): correct date picker timezone handling on iOS"
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
---
|
|
254
|
+
|
|
255
|
+
## Refactoring Template
|
|
256
|
+
|
|
257
|
+
Use this template when improving code structure without changing behavior.
|
|
258
|
+
|
|
259
|
+
### Checklist
|
|
260
|
+
|
|
261
|
+
```markdown
|
|
262
|
+
## Refactoring: [What You're Refactoring]
|
|
263
|
+
|
|
264
|
+
### Planning
|
|
265
|
+
- [ ] Identify code smell or improvement opportunity
|
|
266
|
+
- [ ] Define refactoring goal
|
|
267
|
+
- [ ] Ensure test coverage exists
|
|
268
|
+
- [ ] Plan incremental changes
|
|
269
|
+
|
|
270
|
+
### Implementation
|
|
271
|
+
- [ ] Start workflow task
|
|
272
|
+
- [ ] Refactor code
|
|
273
|
+
- [ ] Verify behavior unchanged
|
|
274
|
+
- [ ] Mark as fixed
|
|
275
|
+
|
|
276
|
+
### Testing
|
|
277
|
+
- [ ] Update tests for new structure
|
|
278
|
+
- [ ] Ensure all existing tests still pass
|
|
279
|
+
- [ ] Create tests in workflow
|
|
280
|
+
- [ ] Run full test suite
|
|
281
|
+
- [ ] Record passing tests
|
|
282
|
+
|
|
283
|
+
### Documentation
|
|
284
|
+
- [ ] Update inline documentation
|
|
285
|
+
- [ ] Update architecture docs if needed
|
|
286
|
+
- [ ] Create documentation in workflow
|
|
287
|
+
|
|
288
|
+
### Release
|
|
289
|
+
- [ ] Commit and push changes
|
|
290
|
+
- [ ] Perform release (minor/patch)
|
|
291
|
+
- [ ] Complete task
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
### Workflow Commands
|
|
295
|
+
|
|
296
|
+
```
|
|
297
|
+
# 1. Start
|
|
298
|
+
start_task:
|
|
299
|
+
description: "Refactor [component/module] to [improvement goal]"
|
|
300
|
+
type: "refactor"
|
|
301
|
+
|
|
302
|
+
# 2. Refactor
|
|
303
|
+
# ... your refactoring ...
|
|
304
|
+
|
|
305
|
+
# 3. Mark as fixed
|
|
306
|
+
mark_bug_fixed:
|
|
307
|
+
summary: "[Brief description of refactoring]"
|
|
308
|
+
|
|
309
|
+
# 4. Update tests
|
|
310
|
+
# ... update test structure ...
|
|
311
|
+
create_tests
|
|
312
|
+
|
|
313
|
+
# 5. Run tests
|
|
314
|
+
run_tests:
|
|
315
|
+
passed: true
|
|
316
|
+
testCommand: "npm test -- --coverage"
|
|
317
|
+
details: "[All tests pass, coverage maintained/improved]"
|
|
318
|
+
|
|
319
|
+
# 6. Document
|
|
320
|
+
create_documentation:
|
|
321
|
+
documentationType: "inline-comments"
|
|
322
|
+
summary: "[Updated documentation]"
|
|
323
|
+
|
|
324
|
+
# 7. Commit
|
|
325
|
+
commit_and_push:
|
|
326
|
+
commitMessage: "refactor([scope]): [description]"
|
|
327
|
+
|
|
328
|
+
# 8. Release
|
|
329
|
+
perform_release:
|
|
330
|
+
command: "npm run release:minor"
|
|
331
|
+
notes: "v[X.Y.Z] - Internal improvements"
|
|
332
|
+
|
|
333
|
+
# 9. Complete
|
|
334
|
+
complete_task:
|
|
335
|
+
commitMessage: "refactor([scope]): [description]"
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
### Example
|
|
339
|
+
|
|
340
|
+
**Refactoring:** Extract authentication logic to custom hooks
|
|
341
|
+
|
|
342
|
+
```
|
|
343
|
+
start_task:
|
|
344
|
+
description: "Refactor authentication logic into reusable custom hooks"
|
|
345
|
+
type: "refactor"
|
|
346
|
+
|
|
347
|
+
mark_bug_fixed:
|
|
348
|
+
summary: "Extracted useAuth and usePermissions hooks from component logic"
|
|
349
|
+
|
|
350
|
+
create_tests
|
|
351
|
+
|
|
352
|
+
run_tests:
|
|
353
|
+
passed: true
|
|
354
|
+
testCommand: "npm test -- --coverage"
|
|
355
|
+
details: "All 145 tests pass, coverage improved from 89% to 92%"
|
|
356
|
+
|
|
357
|
+
create_documentation:
|
|
358
|
+
documentationType: "inline-comments"
|
|
359
|
+
summary: "Added JSDoc for custom hooks and usage examples"
|
|
360
|
+
|
|
361
|
+
commit_and_push:
|
|
362
|
+
commitMessage: "refactor(auth): extract authentication logic to custom hooks"
|
|
363
|
+
|
|
364
|
+
perform_release:
|
|
365
|
+
command: "npm run release:minor"
|
|
366
|
+
notes: "v1.6.0 - Authentication refactoring (improved maintainability)"
|
|
367
|
+
|
|
368
|
+
complete_task:
|
|
369
|
+
commitMessage: "refactor(auth): extract authentication logic to custom hooks"
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
---
|
|
373
|
+
|
|
374
|
+
## Hotfix Template
|
|
375
|
+
|
|
376
|
+
Use this for urgent production fixes that need immediate deployment.
|
|
377
|
+
|
|
378
|
+
### Checklist
|
|
379
|
+
|
|
380
|
+
```markdown
|
|
381
|
+
## Hotfix: [Critical Issue]
|
|
382
|
+
|
|
383
|
+
### Urgent Actions
|
|
384
|
+
- [ ] Identify production issue
|
|
385
|
+
- [ ] Create hotfix branch if using git-flow
|
|
386
|
+
- [ ] Start workflow task
|
|
387
|
+
|
|
388
|
+
### Fix
|
|
389
|
+
- [ ] Implement minimal fix
|
|
390
|
+
- [ ] Test fix locally
|
|
391
|
+
- [ ] Mark as fixed
|
|
392
|
+
|
|
393
|
+
### Testing
|
|
394
|
+
- [ ] Create focused regression test
|
|
395
|
+
- [ ] Run relevant test suite
|
|
396
|
+
- [ ] Manual verification in staging
|
|
397
|
+
- [ ] Record passing tests
|
|
398
|
+
|
|
399
|
+
### Documentation
|
|
400
|
+
- [ ] Update CHANGELOG with hotfix note
|
|
401
|
+
- [ ] Document in workflow
|
|
402
|
+
|
|
403
|
+
### Release
|
|
404
|
+
- [ ] Commit and push
|
|
405
|
+
- [ ] Perform PATCH release
|
|
406
|
+
- [ ] Deploy to production immediately
|
|
407
|
+
- [ ] Complete task
|
|
408
|
+
- [ ] Notify team
|
|
409
|
+
```
|
|
410
|
+
|
|
411
|
+
### Workflow Commands
|
|
412
|
+
|
|
413
|
+
```
|
|
414
|
+
# 1. Start immediately
|
|
415
|
+
start_task:
|
|
416
|
+
description: "HOTFIX: [critical issue description]"
|
|
417
|
+
type: "bugfix"
|
|
418
|
+
|
|
419
|
+
# 2. Minimal fix
|
|
420
|
+
# ... implement fix ...
|
|
421
|
+
|
|
422
|
+
# 3. Mark as fixed
|
|
423
|
+
mark_bug_fixed:
|
|
424
|
+
summary: "[Brief description of hotfix]"
|
|
425
|
+
|
|
426
|
+
# 4. Focused test
|
|
427
|
+
create_tests
|
|
428
|
+
|
|
429
|
+
# 5. Run tests
|
|
430
|
+
run_tests:
|
|
431
|
+
passed: true
|
|
432
|
+
testCommand: "npm test -- [relevant-tests]"
|
|
433
|
+
details: "[Critical path tests pass]"
|
|
434
|
+
|
|
435
|
+
# 6. Document urgency
|
|
436
|
+
create_documentation:
|
|
437
|
+
documentationType: "changelog"
|
|
438
|
+
summary: "HOTFIX: [issue] - [fix description]"
|
|
439
|
+
|
|
440
|
+
# 7. Commit
|
|
441
|
+
commit_and_push:
|
|
442
|
+
commitMessage: "fix([scope])!: HOTFIX - [description]"
|
|
443
|
+
|
|
444
|
+
# 8. Emergency release
|
|
445
|
+
perform_release:
|
|
446
|
+
command: "npm run release:patch"
|
|
447
|
+
notes: "v[X.Y.Z] - HOTFIX: [issue]"
|
|
448
|
+
|
|
449
|
+
# 9. Complete
|
|
450
|
+
complete_task:
|
|
451
|
+
commitMessage: "fix([scope])!: HOTFIX - [description]"
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
### Example
|
|
455
|
+
|
|
456
|
+
**Hotfix:** Payment processing fails on production
|
|
457
|
+
|
|
458
|
+
```
|
|
459
|
+
start_task:
|
|
460
|
+
description: "HOTFIX: Payment gateway timeout causing checkout failures"
|
|
461
|
+
type: "bugfix"
|
|
462
|
+
|
|
463
|
+
mark_bug_fixed:
|
|
464
|
+
summary: "Increased payment API timeout from 5s to 30s and added retry logic"
|
|
465
|
+
|
|
466
|
+
create_tests
|
|
467
|
+
|
|
468
|
+
run_tests:
|
|
469
|
+
passed: true
|
|
470
|
+
testCommand: "npm test -- payment"
|
|
471
|
+
details: "Payment flow tests pass with timeout scenarios"
|
|
472
|
+
|
|
473
|
+
create_documentation:
|
|
474
|
+
documentationType: "changelog"
|
|
475
|
+
summary: "HOTFIX: Resolved payment timeout failures with increased timeout and retry"
|
|
476
|
+
|
|
477
|
+
commit_and_push:
|
|
478
|
+
commitMessage: "fix(payment)!: HOTFIX - increase timeout and add retry logic"
|
|
479
|
+
|
|
480
|
+
perform_release:
|
|
481
|
+
command: "npm run release:patch"
|
|
482
|
+
notes: "v1.4.2 - HOTFIX: Payment processing timeout"
|
|
483
|
+
|
|
484
|
+
complete_task:
|
|
485
|
+
commitMessage: "fix(payment)!: HOTFIX - increase timeout and add retry logic"
|
|
486
|
+
```
|
|
487
|
+
|
|
488
|
+
---
|
|
489
|
+
|
|
490
|
+
## Documentation Update Template
|
|
491
|
+
|
|
492
|
+
Use this when updating documentation without code changes.
|
|
493
|
+
|
|
494
|
+
### Workflow Commands
|
|
495
|
+
|
|
496
|
+
```
|
|
497
|
+
# 1. Start
|
|
498
|
+
start_task:
|
|
499
|
+
description: "Update documentation for [topic]"
|
|
500
|
+
type: "other"
|
|
501
|
+
|
|
502
|
+
# 2. Update docs
|
|
503
|
+
# ... write documentation ...
|
|
504
|
+
|
|
505
|
+
# 3. Mark as complete
|
|
506
|
+
mark_bug_fixed:
|
|
507
|
+
summary: "Updated [documentation type] with [additions]"
|
|
508
|
+
|
|
509
|
+
# 4. Skip tests (documentation only)
|
|
510
|
+
skip_tests:
|
|
511
|
+
reason: "Documentation-only change, no code modified"
|
|
512
|
+
|
|
513
|
+
# 5. Document
|
|
514
|
+
create_documentation:
|
|
515
|
+
documentationType: "README"
|
|
516
|
+
summary: "[What documentation was added/updated]"
|
|
517
|
+
|
|
518
|
+
# 6. Commit
|
|
519
|
+
commit_and_push:
|
|
520
|
+
commitMessage: "docs([scope]): [description]"
|
|
521
|
+
|
|
522
|
+
# 7. Release
|
|
523
|
+
perform_release:
|
|
524
|
+
command: "npm run release:patch"
|
|
525
|
+
notes: "v[X.Y.Z] - Documentation updates"
|
|
526
|
+
|
|
527
|
+
# 8. Complete
|
|
528
|
+
complete_task:
|
|
529
|
+
commitMessage: "docs([scope]): [description]"
|
|
530
|
+
```
|
|
531
|
+
|
|
532
|
+
### Example
|
|
533
|
+
|
|
534
|
+
```
|
|
535
|
+
start_task:
|
|
536
|
+
description: "Add migration guide for v2.0 breaking changes"
|
|
537
|
+
type: "other"
|
|
538
|
+
|
|
539
|
+
mark_bug_fixed:
|
|
540
|
+
summary: "Created comprehensive v2.0 migration guide with examples"
|
|
541
|
+
|
|
542
|
+
skip_tests:
|
|
543
|
+
reason: "Documentation-only update, no code changes"
|
|
544
|
+
|
|
545
|
+
create_documentation:
|
|
546
|
+
documentationType: "API-docs"
|
|
547
|
+
summary: "Added MIGRATION_V2.md with breaking changes and upgrade steps"
|
|
548
|
+
|
|
549
|
+
commit_and_push:
|
|
550
|
+
commitMessage: "docs(migration): add v2.0 migration guide"
|
|
551
|
+
|
|
552
|
+
perform_release:
|
|
553
|
+
command: "npm run release:patch"
|
|
554
|
+
notes: "v1.4.3 - v2.0 migration guide"
|
|
555
|
+
|
|
556
|
+
complete_task:
|
|
557
|
+
commitMessage: "docs(migration): add v2.0 migration guide"
|
|
558
|
+
```
|
|
559
|
+
|
|
560
|
+
---
|
|
561
|
+
|
|
562
|
+
## Release Preparation Template
|
|
563
|
+
|
|
564
|
+
Use this when preparing a major/minor release with multiple features.
|
|
565
|
+
|
|
566
|
+
### Checklist
|
|
567
|
+
|
|
568
|
+
```markdown
|
|
569
|
+
## Release Preparation: v[X.Y.Z]
|
|
570
|
+
|
|
571
|
+
### Pre-Release
|
|
572
|
+
- [ ] Review all merged features
|
|
573
|
+
- [ ] Update version numbers
|
|
574
|
+
- [ ] Update CHANGELOG
|
|
575
|
+
- [ ] Run full test suite
|
|
576
|
+
- [ ] Check documentation completeness
|
|
577
|
+
|
|
578
|
+
### Workflow
|
|
579
|
+
- [ ] Start workflow task
|
|
580
|
+
- [ ] Mark preparation as complete
|
|
581
|
+
- [ ] Verify tests
|
|
582
|
+
- [ ] Create documentation
|
|
583
|
+
- [ ] Commit and push
|
|
584
|
+
- [ ] Perform release
|
|
585
|
+
- [ ] Complete task
|
|
586
|
+
|
|
587
|
+
### Post-Release
|
|
588
|
+
- [ ] Tag release in git
|
|
589
|
+
- [ ] Create GitHub release notes
|
|
590
|
+
- [ ] Publish to npm/registry
|
|
591
|
+
- [ ] Notify users
|
|
592
|
+
```
|
|
593
|
+
|
|
594
|
+
### Workflow Commands
|
|
595
|
+
|
|
596
|
+
```
|
|
597
|
+
start_task:
|
|
598
|
+
description: "Prepare release v[X.Y.Z] with [feature list]"
|
|
599
|
+
type: "other"
|
|
600
|
+
|
|
601
|
+
mark_bug_fixed:
|
|
602
|
+
summary: "Release preparation complete: CHANGELOG updated, version bumped to [X.Y.Z]"
|
|
603
|
+
|
|
604
|
+
create_tests
|
|
605
|
+
|
|
606
|
+
run_tests:
|
|
607
|
+
passed: true
|
|
608
|
+
testCommand: "npm test -- --coverage"
|
|
609
|
+
details: "Full test suite: [X tests pass], coverage [Y%]"
|
|
610
|
+
|
|
611
|
+
create_documentation:
|
|
612
|
+
documentationType: "changelog"
|
|
613
|
+
summary: "Updated CHANGELOG with all v[X.Y.Z] features and fixes"
|
|
614
|
+
|
|
615
|
+
commit_and_push:
|
|
616
|
+
commitMessage: "chore(release): prepare v[X.Y.Z]"
|
|
617
|
+
|
|
618
|
+
perform_release:
|
|
619
|
+
command: "npm run release:minor"
|
|
620
|
+
notes: "v[X.Y.Z] - [Release highlights]"
|
|
621
|
+
|
|
622
|
+
complete_task:
|
|
623
|
+
commitMessage: "chore(release): prepare v[X.Y.Z]"
|
|
624
|
+
```
|
|
625
|
+
|
|
626
|
+
---
|
|
627
|
+
|
|
628
|
+
## Using Templates in Antigravity
|
|
629
|
+
|
|
630
|
+
### Quick Template Application
|
|
631
|
+
|
|
632
|
+
1. **Choose your template** based on task type
|
|
633
|
+
2. **Copy the workflow commands** section
|
|
634
|
+
3. **Customize** brackets [...] with your specific details
|
|
635
|
+
4. **Execute** commands in Antigravity
|
|
636
|
+
|
|
637
|
+
### Template Variables
|
|
638
|
+
|
|
639
|
+
Replace these placeholders in templates:
|
|
640
|
+
|
|
641
|
+
- `[Feature Name]` - Your feature description
|
|
642
|
+
- `[Bug Description]` - Bug summary
|
|
643
|
+
- `[scope]` - Conventional commit scope (e.g., auth, ui, api)
|
|
644
|
+
- `[description]` - Commit description
|
|
645
|
+
- `[X.Y.Z]` - Version number
|
|
646
|
+
- `[X tests]` - Number of tests
|
|
647
|
+
- `[Y%]` - Coverage percentage
|
|
648
|
+
|
|
649
|
+
### Automation with Workflows
|
|
650
|
+
|
|
651
|
+
Save these as Antigravity workflow files in `.agent/workflows/`:
|
|
652
|
+
|
|
653
|
+
- `dev-workflow-feature.md`
|
|
654
|
+
- `dev-workflow-bugfix.md`
|
|
655
|
+
- `dev-workflow-refactor.md`
|
|
656
|
+
- `dev-workflow-hotfix.md`
|
|
657
|
+
|
|
658
|
+
Then use slash commands like `/dev-workflow-feature` to load templates!
|
|
659
|
+
|
|
660
|
+
---
|
|
661
|
+
|
|
662
|
+
## Next Steps
|
|
663
|
+
|
|
664
|
+
- See [EXAMPLES.md](./EXAMPLES.md) for real-world usage scenarios
|
|
665
|
+
- Check [TROUBLESHOOTING.md](./TROUBLESHOOTING.md) for common issues
|
|
666
|
+
- Return to [GETTING-STARTED.md](./GETTING-STARTED.md) for setup
|
|
667
|
+
|
|
668
|
+
---
|
|
669
|
+
|
|
670
|
+
**Consistent workflows lead to consistent quality!** ⚡
|