agentvibes 2.13.7 → 2.13.9

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.
Files changed (430) hide show
  1. package/.claude/commands/agent-vibes/bmad.md +16 -14
  2. package/.claude/hooks/play-tts-elevenlabs.sh +3 -1
  3. package/.claude/hooks/provider-manager.sh +112 -23
  4. package/.claude/personalities/rapper.md +1 -1
  5. package/README.md +7 -8
  6. package/RELEASE_NOTES.md +145 -255
  7. package/mcp-server/install-deps.js +7 -6
  8. package/mcp-server/server.py +4 -2
  9. package/package.json +1 -1
  10. package/src/commands/bmad-voices.js +3 -15
  11. package/src/commands/install-mcp.js +15 -9
  12. package/src/installer.js +19 -29
  13. package/test/unit/provider-manager.bats +13 -9
  14. package/.bmad/_cfg/agent-manifest.csv +0 -11
  15. package/.bmad/_cfg/agent-voice-map.csv +0 -11
  16. package/.bmad/_cfg/agents/bmm-analyst.customize.yaml +0 -42
  17. package/.bmad/_cfg/agents/bmm-architect.customize.yaml +0 -42
  18. package/.bmad/_cfg/agents/bmm-dev.customize.yaml +0 -42
  19. package/.bmad/_cfg/agents/bmm-frame-expert.customize.yaml +0 -42
  20. package/.bmad/_cfg/agents/bmm-pm.customize.yaml +0 -42
  21. package/.bmad/_cfg/agents/bmm-sm.customize.yaml +0 -42
  22. package/.bmad/_cfg/agents/bmm-tea.customize.yaml +0 -42
  23. package/.bmad/_cfg/agents/bmm-tech-writer.customize.yaml +0 -42
  24. package/.bmad/_cfg/agents/bmm-ux-designer.customize.yaml +0 -42
  25. package/.bmad/_cfg/agents/core-bmad-master.customize.yaml +0 -42
  26. package/.bmad/_cfg/files-manifest.csv +0 -243
  27. package/.bmad/_cfg/ides/claude-code.yaml +0 -6
  28. package/.bmad/_cfg/manifest.yaml +0 -9
  29. package/.bmad/_cfg/task-manifest.csv +0 -5
  30. package/.bmad/_cfg/tool-manifest.csv +0 -2
  31. package/.bmad/_cfg/workflow-manifest.csv +0 -38
  32. package/.bmad/bmm/README.md +0 -128
  33. package/.bmad/bmm/agents/analyst.md +0 -79
  34. package/.bmad/bmm/agents/analyst.md.backup-pre-tts +0 -75
  35. package/.bmad/bmm/agents/architect.md +0 -80
  36. package/.bmad/bmm/agents/dev.md +0 -70
  37. package/.bmad/bmm/agents/frame-expert.md +0 -72
  38. package/.bmad/bmm/agents/pm.md +0 -84
  39. package/.bmad/bmm/agents/sm.md +0 -93
  40. package/.bmad/bmm/agents/tea.md +0 -80
  41. package/.bmad/bmm/agents/tech-writer.md +0 -84
  42. package/.bmad/bmm/agents/ux-designer.md +0 -79
  43. package/.bmad/bmm/config.yaml +0 -17
  44. package/.bmad/bmm/docs/README.md +0 -236
  45. package/.bmad/bmm/docs/agents-guide.md +0 -1058
  46. package/.bmad/bmm/docs/brownfield-guide.md +0 -762
  47. package/.bmad/bmm/docs/enterprise-agentic-development.md +0 -686
  48. package/.bmad/bmm/docs/faq.md +0 -588
  49. package/.bmad/bmm/docs/glossary.md +0 -320
  50. package/.bmad/bmm/docs/party-mode.md +0 -224
  51. package/.bmad/bmm/docs/quick-spec-flow.md +0 -652
  52. package/.bmad/bmm/docs/quick-start.md +0 -376
  53. package/.bmad/bmm/docs/scale-adaptive-system.md +0 -612
  54. package/.bmad/bmm/docs/test-architecture.md +0 -396
  55. package/.bmad/bmm/docs/workflow-architecture-reference.md +0 -366
  56. package/.bmad/bmm/docs/workflow-document-project-reference.md +0 -489
  57. package/.bmad/bmm/docs/workflows-analysis.md +0 -370
  58. package/.bmad/bmm/docs/workflows-implementation.md +0 -286
  59. package/.bmad/bmm/docs/workflows-planning.md +0 -612
  60. package/.bmad/bmm/docs/workflows-solutioning.md +0 -554
  61. package/.bmad/bmm/teams/default-party.csv +0 -20
  62. package/.bmad/bmm/teams/team-fullstack.yaml +0 -13
  63. package/.bmad/bmm/testarch/knowledge/ci-burn-in.md +0 -675
  64. package/.bmad/bmm/testarch/knowledge/component-tdd.md +0 -486
  65. package/.bmad/bmm/testarch/knowledge/contract-testing.md +0 -957
  66. package/.bmad/bmm/testarch/knowledge/data-factories.md +0 -500
  67. package/.bmad/bmm/testarch/knowledge/email-auth.md +0 -721
  68. package/.bmad/bmm/testarch/knowledge/error-handling.md +0 -725
  69. package/.bmad/bmm/testarch/knowledge/feature-flags.md +0 -750
  70. package/.bmad/bmm/testarch/knowledge/fixture-architecture.md +0 -401
  71. package/.bmad/bmm/testarch/knowledge/network-first.md +0 -486
  72. package/.bmad/bmm/testarch/knowledge/nfr-criteria.md +0 -670
  73. package/.bmad/bmm/testarch/knowledge/playwright-config.md +0 -730
  74. package/.bmad/bmm/testarch/knowledge/probability-impact.md +0 -601
  75. package/.bmad/bmm/testarch/knowledge/risk-governance.md +0 -615
  76. package/.bmad/bmm/testarch/knowledge/selective-testing.md +0 -732
  77. package/.bmad/bmm/testarch/knowledge/selector-resilience.md +0 -527
  78. package/.bmad/bmm/testarch/knowledge/test-healing-patterns.md +0 -644
  79. package/.bmad/bmm/testarch/knowledge/test-levels-framework.md +0 -473
  80. package/.bmad/bmm/testarch/knowledge/test-priorities-matrix.md +0 -373
  81. package/.bmad/bmm/testarch/knowledge/test-quality.md +0 -664
  82. package/.bmad/bmm/testarch/knowledge/timing-debugging.md +0 -372
  83. package/.bmad/bmm/testarch/knowledge/visual-debugging.md +0 -524
  84. package/.bmad/bmm/testarch/tea-index.csv +0 -22
  85. package/.bmad/bmm/workflows/1-analysis/brainstorm-project/instructions.md +0 -112
  86. package/.bmad/bmm/workflows/1-analysis/brainstorm-project/project-context.md +0 -25
  87. package/.bmad/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml +0 -26
  88. package/.bmad/bmm/workflows/1-analysis/domain-research/instructions.md +0 -425
  89. package/.bmad/bmm/workflows/1-analysis/domain-research/template.md +0 -180
  90. package/.bmad/bmm/workflows/1-analysis/domain-research/workflow.yaml +0 -28
  91. package/.bmad/bmm/workflows/1-analysis/product-brief/checklist.md +0 -115
  92. package/.bmad/bmm/workflows/1-analysis/product-brief/instructions.md +0 -524
  93. package/.bmad/bmm/workflows/1-analysis/product-brief/template.md +0 -181
  94. package/.bmad/bmm/workflows/1-analysis/product-brief/workflow.yaml +0 -45
  95. package/.bmad/bmm/workflows/1-analysis/research/checklist-deep-prompt.md +0 -144
  96. package/.bmad/bmm/workflows/1-analysis/research/checklist-technical.md +0 -249
  97. package/.bmad/bmm/workflows/1-analysis/research/checklist.md +0 -299
  98. package/.bmad/bmm/workflows/1-analysis/research/claude-code/injections.yaml +0 -114
  99. package/.bmad/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +0 -438
  100. package/.bmad/bmm/workflows/1-analysis/research/instructions-market.md +0 -675
  101. package/.bmad/bmm/workflows/1-analysis/research/instructions-router.md +0 -134
  102. package/.bmad/bmm/workflows/1-analysis/research/instructions-technical.md +0 -534
  103. package/.bmad/bmm/workflows/1-analysis/research/template-deep-prompt.md +0 -94
  104. package/.bmad/bmm/workflows/1-analysis/research/template-market.md +0 -347
  105. package/.bmad/bmm/workflows/1-analysis/research/template-technical.md +0 -245
  106. package/.bmad/bmm/workflows/1-analysis/research/workflow.yaml +0 -44
  107. package/.bmad/bmm/workflows/2-plan-workflows/create-epics-and-stories/epics-template.md +0 -80
  108. package/.bmad/bmm/workflows/2-plan-workflows/create-epics-and-stories/instructions.md +0 -616
  109. package/.bmad/bmm/workflows/2-plan-workflows/create-epics-and-stories/workflow.yaml +0 -53
  110. package/.bmad/bmm/workflows/2-plan-workflows/create-ux-design/checklist.md +0 -310
  111. package/.bmad/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +0 -1308
  112. package/.bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +0 -145
  113. package/.bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml +0 -61
  114. package/.bmad/bmm/workflows/2-plan-workflows/prd/checklist.md +0 -346
  115. package/.bmad/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv +0 -13
  116. package/.bmad/bmm/workflows/2-plan-workflows/prd/instructions.md +0 -703
  117. package/.bmad/bmm/workflows/2-plan-workflows/prd/prd-template.md +0 -204
  118. package/.bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv +0 -11
  119. package/.bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml +0 -52
  120. package/.bmad/bmm/workflows/2-plan-workflows/tech-spec/checklist.md +0 -217
  121. package/.bmad/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md +0 -74
  122. package/.bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions-generate-stories.md +0 -436
  123. package/.bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +0 -980
  124. package/.bmad/bmm/workflows/2-plan-workflows/tech-spec/tech-spec-template.md +0 -181
  125. package/.bmad/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md +0 -90
  126. package/.bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +0 -58
  127. package/.bmad/bmm/workflows/3-solutioning/architecture/architecture-patterns.yaml +0 -321
  128. package/.bmad/bmm/workflows/3-solutioning/architecture/architecture-template.md +0 -103
  129. package/.bmad/bmm/workflows/3-solutioning/architecture/checklist.md +0 -240
  130. package/.bmad/bmm/workflows/3-solutioning/architecture/decision-catalog.yaml +0 -222
  131. package/.bmad/bmm/workflows/3-solutioning/architecture/instructions.md +0 -768
  132. package/.bmad/bmm/workflows/3-solutioning/architecture/pattern-categories.csv +0 -13
  133. package/.bmad/bmm/workflows/3-solutioning/architecture/workflow.yaml +0 -55
  134. package/.bmad/bmm/workflows/3-solutioning/implementation-readiness/checklist.md +0 -169
  135. package/.bmad/bmm/workflows/3-solutioning/implementation-readiness/instructions.md +0 -332
  136. package/.bmad/bmm/workflows/3-solutioning/implementation-readiness/template.md +0 -146
  137. package/.bmad/bmm/workflows/3-solutioning/implementation-readiness/workflow.yaml +0 -62
  138. package/.bmad/bmm/workflows/4-implementation/code-review/backlog_template.md +0 -12
  139. package/.bmad/bmm/workflows/4-implementation/code-review/checklist.md +0 -22
  140. package/.bmad/bmm/workflows/4-implementation/code-review/instructions.md +0 -398
  141. package/.bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +0 -60
  142. package/.bmad/bmm/workflows/4-implementation/correct-course/checklist.md +0 -279
  143. package/.bmad/bmm/workflows/4-implementation/correct-course/instructions.md +0 -206
  144. package/.bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +0 -56
  145. package/.bmad/bmm/workflows/4-implementation/create-story/checklist.md +0 -240
  146. package/.bmad/bmm/workflows/4-implementation/create-story/instructions.md +0 -256
  147. package/.bmad/bmm/workflows/4-implementation/create-story/template.md +0 -51
  148. package/.bmad/bmm/workflows/4-implementation/create-story/workflow.yaml +0 -71
  149. package/.bmad/bmm/workflows/4-implementation/dev-story/checklist.md +0 -38
  150. package/.bmad/bmm/workflows/4-implementation/dev-story/instructions.md +0 -267
  151. package/.bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +0 -56
  152. package/.bmad/bmm/workflows/4-implementation/epic-tech-context/checklist.md +0 -17
  153. package/.bmad/bmm/workflows/4-implementation/epic-tech-context/instructions.md +0 -164
  154. package/.bmad/bmm/workflows/4-implementation/epic-tech-context/template.md +0 -76
  155. package/.bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +0 -57
  156. package/.bmad/bmm/workflows/4-implementation/retrospective/instructions.md +0 -1443
  157. package/.bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +0 -56
  158. package/.bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +0 -33
  159. package/.bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +0 -234
  160. package/.bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +0 -55
  161. package/.bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +0 -49
  162. package/.bmad/bmm/workflows/4-implementation/story-context/checklist.md +0 -16
  163. package/.bmad/bmm/workflows/4-implementation/story-context/context-template.xml +0 -34
  164. package/.bmad/bmm/workflows/4-implementation/story-context/instructions.md +0 -209
  165. package/.bmad/bmm/workflows/4-implementation/story-context/workflow.yaml +0 -61
  166. package/.bmad/bmm/workflows/4-implementation/story-done/instructions.md +0 -111
  167. package/.bmad/bmm/workflows/4-implementation/story-done/workflow.yaml +0 -26
  168. package/.bmad/bmm/workflows/4-implementation/story-ready/instructions.md +0 -117
  169. package/.bmad/bmm/workflows/4-implementation/story-ready/workflow.yaml +0 -23
  170. package/.bmad/bmm/workflows/document-project/checklist.md +0 -245
  171. package/.bmad/bmm/workflows/document-project/documentation-requirements.csv +0 -12
  172. package/.bmad/bmm/workflows/document-project/instructions.md +0 -222
  173. package/.bmad/bmm/workflows/document-project/templates/deep-dive-template.md +0 -345
  174. package/.bmad/bmm/workflows/document-project/templates/index-template.md +0 -169
  175. package/.bmad/bmm/workflows/document-project/templates/project-overview-template.md +0 -103
  176. package/.bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +0 -160
  177. package/.bmad/bmm/workflows/document-project/templates/source-tree-template.md +0 -135
  178. package/.bmad/bmm/workflows/document-project/workflow.yaml +0 -29
  179. package/.bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +0 -298
  180. package/.bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +0 -31
  181. package/.bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +0 -1106
  182. package/.bmad/bmm/workflows/document-project/workflows/full-scan.yaml +0 -31
  183. package/.bmad/bmm/workflows/frame-expert/_shared/excalidraw-helpers.md +0 -127
  184. package/.bmad/bmm/workflows/frame-expert/_shared/excalidraw-library.json +0 -90
  185. package/.bmad/bmm/workflows/frame-expert/_shared/excalidraw-templates.yaml +0 -127
  186. package/.bmad/bmm/workflows/frame-expert/_shared/validate-json-instructions.md +0 -79
  187. package/.bmad/bmm/workflows/frame-expert/create-dataflow/checklist.md +0 -39
  188. package/.bmad/bmm/workflows/frame-expert/create-dataflow/instructions.md +0 -131
  189. package/.bmad/bmm/workflows/frame-expert/create-dataflow/workflow.yaml +0 -23
  190. package/.bmad/bmm/workflows/frame-expert/create-diagram/checklist.md +0 -43
  191. package/.bmad/bmm/workflows/frame-expert/create-diagram/instructions.md +0 -142
  192. package/.bmad/bmm/workflows/frame-expert/create-diagram/workflow.yaml +0 -24
  193. package/.bmad/bmm/workflows/frame-expert/create-flowchart/checklist.md +0 -49
  194. package/.bmad/bmm/workflows/frame-expert/create-flowchart/instructions.md +0 -242
  195. package/.bmad/bmm/workflows/frame-expert/create-flowchart/workflow.yaml +0 -27
  196. package/.bmad/bmm/workflows/frame-expert/create-wireframe/checklist.md +0 -38
  197. package/.bmad/bmm/workflows/frame-expert/create-wireframe/instructions.md +0 -133
  198. package/.bmad/bmm/workflows/frame-expert/create-wireframe/workflow.yaml +0 -23
  199. package/.bmad/bmm/workflows/techdoc/documentation-standards.md +0 -262
  200. package/.bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +0 -363
  201. package/.bmad/bmm/workflows/testarch/atdd/checklist.md +0 -373
  202. package/.bmad/bmm/workflows/testarch/atdd/instructions.md +0 -785
  203. package/.bmad/bmm/workflows/testarch/atdd/workflow.yaml +0 -45
  204. package/.bmad/bmm/workflows/testarch/automate/checklist.md +0 -580
  205. package/.bmad/bmm/workflows/testarch/automate/instructions.md +0 -1303
  206. package/.bmad/bmm/workflows/testarch/automate/workflow.yaml +0 -52
  207. package/.bmad/bmm/workflows/testarch/ci/checklist.md +0 -246
  208. package/.bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +0 -165
  209. package/.bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +0 -128
  210. package/.bmad/bmm/workflows/testarch/ci/instructions.md +0 -517
  211. package/.bmad/bmm/workflows/testarch/ci/workflow.yaml +0 -45
  212. package/.bmad/bmm/workflows/testarch/framework/checklist.md +0 -321
  213. package/.bmad/bmm/workflows/testarch/framework/instructions.md +0 -455
  214. package/.bmad/bmm/workflows/testarch/framework/workflow.yaml +0 -47
  215. package/.bmad/bmm/workflows/testarch/nfr-assess/checklist.md +0 -405
  216. package/.bmad/bmm/workflows/testarch/nfr-assess/instructions.md +0 -722
  217. package/.bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +0 -443
  218. package/.bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +0 -47
  219. package/.bmad/bmm/workflows/testarch/test-design/checklist.md +0 -234
  220. package/.bmad/bmm/workflows/testarch/test-design/instructions.md +0 -782
  221. package/.bmad/bmm/workflows/testarch/test-design/test-design-template.md +0 -285
  222. package/.bmad/bmm/workflows/testarch/test-design/workflow.yaml +0 -48
  223. package/.bmad/bmm/workflows/testarch/test-review/checklist.md +0 -470
  224. package/.bmad/bmm/workflows/testarch/test-review/instructions.md +0 -608
  225. package/.bmad/bmm/workflows/testarch/test-review/test-review-template.md +0 -388
  226. package/.bmad/bmm/workflows/testarch/test-review/workflow.yaml +0 -46
  227. package/.bmad/bmm/workflows/testarch/trace/checklist.md +0 -654
  228. package/.bmad/bmm/workflows/testarch/trace/instructions.md +0 -1045
  229. package/.bmad/bmm/workflows/testarch/trace/trace-template.md +0 -673
  230. package/.bmad/bmm/workflows/testarch/trace/workflow.yaml +0 -55
  231. package/.bmad/bmm/workflows/workflow-status/init/instructions.md +0 -334
  232. package/.bmad/bmm/workflows/workflow-status/init/workflow.yaml +0 -28
  233. package/.bmad/bmm/workflows/workflow-status/instructions.md +0 -388
  234. package/.bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +0 -138
  235. package/.bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +0 -126
  236. package/.bmad/bmm/workflows/workflow-status/paths/game-design.yaml +0 -52
  237. package/.bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml +0 -122
  238. package/.bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml +0 -113
  239. package/.bmad/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml +0 -58
  240. package/.bmad/bmm/workflows/workflow-status/paths/quick-flow-greenfield.yaml +0 -47
  241. package/.bmad/bmm/workflows/workflow-status/project-levels.yaml +0 -59
  242. package/.bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +0 -24
  243. package/.bmad/bmm/workflows/workflow-status/workflow.yaml +0 -28
  244. package/.bmad/core/agents/bmad-master.md +0 -72
  245. package/.bmad/core/agents/bmad-web-orchestrator.agent.xml +0 -113
  246. package/.bmad/core/config.yaml +0 -11
  247. package/.bmad/core/tasks/adv-elicit-methods.csv +0 -39
  248. package/.bmad/core/tasks/advanced-elicitation-methods.csv +0 -21
  249. package/.bmad/core/tasks/advanced-elicitation.xml +0 -106
  250. package/.bmad/core/tasks/index-docs.xml +0 -65
  251. package/.bmad/core/tasks/validate-workflow.xml +0 -89
  252. package/.bmad/core/tasks/workflow.xml +0 -270
  253. package/.bmad/core/tools/shard-doc.xml +0 -109
  254. package/.bmad/core/workflows/brainstorming/README.md +0 -261
  255. package/.bmad/core/workflows/brainstorming/brain-methods.csv +0 -36
  256. package/.bmad/core/workflows/brainstorming/instructions.md +0 -315
  257. package/.bmad/core/workflows/brainstorming/template.md +0 -106
  258. package/.bmad/core/workflows/brainstorming/workflow.yaml +0 -38
  259. package/.bmad/core/workflows/party-mode/instructions.md +0 -203
  260. package/.bmad/core/workflows/party-mode/workflow.yaml +0 -28
  261. package/.bmad/docs/claude-code-instructions.md +0 -25
  262. package/.claude/commands/BMad/analyst.md +0 -88
  263. package/.claude/commands/BMad/architect.md +0 -89
  264. package/.claude/commands/BMad/bmad-master.md +0 -114
  265. package/.claude/commands/BMad/bmad-orchestrator.md +0 -151
  266. package/.claude/commands/BMad/dev.md +0 -85
  267. package/.claude/commands/BMad/pm.md +0 -88
  268. package/.claude/commands/BMad/po.md +0 -83
  269. package/.claude/commands/BMad/qa.md +0 -91
  270. package/.claude/commands/BMad/sm.md +0 -69
  271. package/.claude/commands/BMad/tasks/advanced-elicitation.md +0 -123
  272. package/.claude/commands/BMad/tasks/apply-qa-fixes.md +0 -154
  273. package/.claude/commands/BMad/tasks/brownfield-create-epic.md +0 -166
  274. package/.claude/commands/BMad/tasks/brownfield-create-story.md +0 -153
  275. package/.claude/commands/BMad/tasks/correct-course.md +0 -76
  276. package/.claude/commands/BMad/tasks/create-brownfield-story.md +0 -318
  277. package/.claude/commands/BMad/tasks/create-deep-research-prompt.md +0 -284
  278. package/.claude/commands/BMad/tasks/create-doc.md +0 -107
  279. package/.claude/commands/BMad/tasks/create-next-story.md +0 -118
  280. package/.claude/commands/BMad/tasks/document-project.md +0 -349
  281. package/.claude/commands/BMad/tasks/execute-checklist.md +0 -92
  282. package/.claude/commands/BMad/tasks/facilitate-brainstorming-session.md +0 -142
  283. package/.claude/commands/BMad/tasks/generate-ai-frontend-prompt.md +0 -57
  284. package/.claude/commands/BMad/tasks/index-docs.md +0 -179
  285. package/.claude/commands/BMad/tasks/kb-mode-interaction.md +0 -81
  286. package/.claude/commands/BMad/tasks/nfr-assess.md +0 -349
  287. package/.claude/commands/BMad/tasks/qa-gate.md +0 -167
  288. package/.claude/commands/BMad/tasks/review-story.md +0 -320
  289. package/.claude/commands/BMad/tasks/risk-profile.md +0 -359
  290. package/.claude/commands/BMad/tasks/shard-doc.md +0 -191
  291. package/.claude/commands/BMad/tasks/test-design.md +0 -180
  292. package/.claude/commands/BMad/tasks/trace-requirements.md +0 -270
  293. package/.claude/commands/BMad/tasks/validate-next-story.md +0 -140
  294. package/.claude/commands/BMad/ux-expert.md +0 -73
  295. package/.claude/commands/bmad/bmm/agents/analyst.md +0 -14
  296. package/.claude/commands/bmad/bmm/agents/architect.md +0 -14
  297. package/.claude/commands/bmad/bmm/agents/dev.md +0 -14
  298. package/.claude/commands/bmad/bmm/agents/frame-expert.md +0 -14
  299. package/.claude/commands/bmad/bmm/agents/pm.md +0 -14
  300. package/.claude/commands/bmad/bmm/agents/sm.md +0 -14
  301. package/.claude/commands/bmad/bmm/agents/tea.md +0 -14
  302. package/.claude/commands/bmad/bmm/agents/tech-writer.md +0 -14
  303. package/.claude/commands/bmad/bmm/agents/ux-designer.md +0 -14
  304. package/.claude/commands/bmad/bmm/workflows/architecture.md +0 -13
  305. package/.claude/commands/bmad/bmm/workflows/brainstorm-project.md +0 -13
  306. package/.claude/commands/bmad/bmm/workflows/code-review.md +0 -13
  307. package/.claude/commands/bmad/bmm/workflows/correct-course.md +0 -13
  308. package/.claude/commands/bmad/bmm/workflows/create-dataflow.md +0 -13
  309. package/.claude/commands/bmad/bmm/workflows/create-diagram.md +0 -13
  310. package/.claude/commands/bmad/bmm/workflows/create-epics-and-stories.md +0 -13
  311. package/.claude/commands/bmad/bmm/workflows/create-flowchart.md +0 -13
  312. package/.claude/commands/bmad/bmm/workflows/create-story.md +0 -13
  313. package/.claude/commands/bmad/bmm/workflows/create-ux-design.md +0 -13
  314. package/.claude/commands/bmad/bmm/workflows/create-wireframe.md +0 -13
  315. package/.claude/commands/bmad/bmm/workflows/dev-story.md +0 -13
  316. package/.claude/commands/bmad/bmm/workflows/document-project.md +0 -13
  317. package/.claude/commands/bmad/bmm/workflows/domain-research.md +0 -13
  318. package/.claude/commands/bmad/bmm/workflows/epic-tech-context.md +0 -13
  319. package/.claude/commands/bmad/bmm/workflows/implementation-readiness.md +0 -13
  320. package/.claude/commands/bmad/bmm/workflows/prd.md +0 -13
  321. package/.claude/commands/bmad/bmm/workflows/product-brief.md +0 -13
  322. package/.claude/commands/bmad/bmm/workflows/research.md +0 -13
  323. package/.claude/commands/bmad/bmm/workflows/retrospective.md +0 -13
  324. package/.claude/commands/bmad/bmm/workflows/sprint-planning.md +0 -13
  325. package/.claude/commands/bmad/bmm/workflows/story-context.md +0 -13
  326. package/.claude/commands/bmad/bmm/workflows/story-done.md +0 -13
  327. package/.claude/commands/bmad/bmm/workflows/story-ready.md +0 -13
  328. package/.claude/commands/bmad/bmm/workflows/tech-spec.md +0 -13
  329. package/.claude/commands/bmad/bmm/workflows/workflow-init.md +0 -13
  330. package/.claude/commands/bmad/bmm/workflows/workflow-status.md +0 -13
  331. package/.claude/commands/bmad/core/agents/bmad-master.md +0 -14
  332. package/.claude/commands/bmad/core/tasks/advanced-elicitation.md +0 -9
  333. package/.claude/commands/bmad/core/tasks/index-docs.md +0 -9
  334. package/.claude/commands/bmad/core/tools/shard-doc.md +0 -9
  335. package/.claude/commands/bmad/core/workflows/brainstorming.md +0 -13
  336. package/.claude/commands/bmad/core/workflows/party-mode.md +0 -13
  337. package/.claude/github-star-reminder.txt +0 -1
  338. package/.claude/hooks/bmad-party-manager.sh +0 -225
  339. package/.claude/hooks/stop.sh +0 -221
  340. package/.claude/piper-voices-dir.txt +0 -1
  341. package/.mcp.json +0 -88
  342. package/RELEASE_NOTES_v2.4.0_DRAFT.md +0 -116
  343. package/RELEASE_NOTES_v2.4.1_DRAFT.md +0 -61
  344. package/docs/2025-11-15_15-14-33.snagx +0 -0
  345. package/docs/Screenshot 2025-11-15 151325.png +0 -0
  346. package/docs/Screenshot 2025-11-15 151432.png +0 -0
  347. package/docs/macos-piper-issue.md +0 -172
  348. package/docs/stargazer-cms-prd.md +0 -1918
  349. package/docs/whatsapp-plugin-github-issue.md +0 -393
  350. package/docs/whatsapp-tts-plugin-feasibility.md +0 -418
  351. package/docs/whatsapp-tts-standalone-plugin.md +0 -628
  352. package/github-profile-draft.md +0 -57
  353. package/linkedin/vibe-coding-and-pulseaudio.md +0 -121
  354. package/mcp-server/agentvibes.db +0 -0
  355. package/scripts/audio-tunnel.config +0 -17
  356. package/v4-backup/.bmad-core/agent-teams/team-all.yaml +0 -15
  357. package/v4-backup/.bmad-core/agent-teams/team-fullstack.yaml +0 -19
  358. package/v4-backup/.bmad-core/agent-teams/team-ide-minimal.yaml +0 -11
  359. package/v4-backup/.bmad-core/agent-teams/team-no-ui.yaml +0 -14
  360. package/v4-backup/.bmad-core/agents/analyst.md +0 -84
  361. package/v4-backup/.bmad-core/agents/architect.md +0 -85
  362. package/v4-backup/.bmad-core/agents/bmad-master.md +0 -110
  363. package/v4-backup/.bmad-core/agents/bmad-orchestrator.md +0 -147
  364. package/v4-backup/.bmad-core/agents/dev.md +0 -81
  365. package/v4-backup/.bmad-core/agents/pm.md +0 -84
  366. package/v4-backup/.bmad-core/agents/po.md +0 -79
  367. package/v4-backup/.bmad-core/agents/qa.md +0 -87
  368. package/v4-backup/.bmad-core/agents/sm.md +0 -65
  369. package/v4-backup/.bmad-core/agents/ux-expert.md +0 -69
  370. package/v4-backup/.bmad-core/checklists/architect-checklist.md +0 -440
  371. package/v4-backup/.bmad-core/checklists/change-checklist.md +0 -184
  372. package/v4-backup/.bmad-core/checklists/pm-checklist.md +0 -372
  373. package/v4-backup/.bmad-core/checklists/po-master-checklist.md +0 -434
  374. package/v4-backup/.bmad-core/checklists/story-dod-checklist.md +0 -96
  375. package/v4-backup/.bmad-core/checklists/story-draft-checklist.md +0 -155
  376. package/v4-backup/.bmad-core/core-config.yaml +0 -22
  377. package/v4-backup/.bmad-core/data/bmad-kb.md +0 -809
  378. package/v4-backup/.bmad-core/data/brainstorming-techniques.md +0 -38
  379. package/v4-backup/.bmad-core/data/elicitation-methods.md +0 -156
  380. package/v4-backup/.bmad-core/data/technical-preferences.md +0 -5
  381. package/v4-backup/.bmad-core/data/test-levels-framework.md +0 -148
  382. package/v4-backup/.bmad-core/data/test-priorities-matrix.md +0 -174
  383. package/v4-backup/.bmad-core/enhanced-ide-development-workflow.md +0 -248
  384. package/v4-backup/.bmad-core/install-manifest.yaml +0 -230
  385. package/v4-backup/.bmad-core/tasks/advanced-elicitation.md +0 -119
  386. package/v4-backup/.bmad-core/tasks/apply-qa-fixes.md +0 -150
  387. package/v4-backup/.bmad-core/tasks/brownfield-create-epic.md +0 -162
  388. package/v4-backup/.bmad-core/tasks/brownfield-create-story.md +0 -149
  389. package/v4-backup/.bmad-core/tasks/correct-course.md +0 -72
  390. package/v4-backup/.bmad-core/tasks/create-brownfield-story.md +0 -314
  391. package/v4-backup/.bmad-core/tasks/create-deep-research-prompt.md +0 -280
  392. package/v4-backup/.bmad-core/tasks/create-doc.md +0 -103
  393. package/v4-backup/.bmad-core/tasks/create-next-story.md +0 -114
  394. package/v4-backup/.bmad-core/tasks/document-project.md +0 -345
  395. package/v4-backup/.bmad-core/tasks/execute-checklist.md +0 -88
  396. package/v4-backup/.bmad-core/tasks/facilitate-brainstorming-session.md +0 -138
  397. package/v4-backup/.bmad-core/tasks/generate-ai-frontend-prompt.md +0 -53
  398. package/v4-backup/.bmad-core/tasks/index-docs.md +0 -175
  399. package/v4-backup/.bmad-core/tasks/kb-mode-interaction.md +0 -77
  400. package/v4-backup/.bmad-core/tasks/nfr-assess.md +0 -345
  401. package/v4-backup/.bmad-core/tasks/qa-gate.md +0 -163
  402. package/v4-backup/.bmad-core/tasks/review-story.md +0 -316
  403. package/v4-backup/.bmad-core/tasks/risk-profile.md +0 -355
  404. package/v4-backup/.bmad-core/tasks/shard-doc.md +0 -187
  405. package/v4-backup/.bmad-core/tasks/test-design.md +0 -176
  406. package/v4-backup/.bmad-core/tasks/trace-requirements.md +0 -266
  407. package/v4-backup/.bmad-core/tasks/validate-next-story.md +0 -136
  408. package/v4-backup/.bmad-core/templates/architecture-tmpl.yaml +0 -651
  409. package/v4-backup/.bmad-core/templates/brainstorming-output-tmpl.yaml +0 -156
  410. package/v4-backup/.bmad-core/templates/brownfield-architecture-tmpl.yaml +0 -477
  411. package/v4-backup/.bmad-core/templates/brownfield-prd-tmpl.yaml +0 -281
  412. package/v4-backup/.bmad-core/templates/competitor-analysis-tmpl.yaml +0 -307
  413. package/v4-backup/.bmad-core/templates/front-end-architecture-tmpl.yaml +0 -219
  414. package/v4-backup/.bmad-core/templates/front-end-spec-tmpl.yaml +0 -350
  415. package/v4-backup/.bmad-core/templates/fullstack-architecture-tmpl.yaml +0 -824
  416. package/v4-backup/.bmad-core/templates/market-research-tmpl.yaml +0 -253
  417. package/v4-backup/.bmad-core/templates/prd-tmpl.yaml +0 -203
  418. package/v4-backup/.bmad-core/templates/project-brief-tmpl.yaml +0 -222
  419. package/v4-backup/.bmad-core/templates/qa-gate-tmpl.yaml +0 -103
  420. package/v4-backup/.bmad-core/templates/story-tmpl.yaml +0 -138
  421. package/v4-backup/.bmad-core/user-guide.md +0 -577
  422. package/v4-backup/.bmad-core/utils/bmad-doc-template.md +0 -327
  423. package/v4-backup/.bmad-core/utils/workflow-management.md +0 -71
  424. package/v4-backup/.bmad-core/workflows/brownfield-fullstack.yaml +0 -298
  425. package/v4-backup/.bmad-core/workflows/brownfield-service.yaml +0 -188
  426. package/v4-backup/.bmad-core/workflows/brownfield-ui.yaml +0 -198
  427. package/v4-backup/.bmad-core/workflows/greenfield-fullstack.yaml +0 -241
  428. package/v4-backup/.bmad-core/workflows/greenfield-service.yaml +0 -207
  429. package/v4-backup/.bmad-core/workflows/greenfield-ui.yaml +0 -236
  430. package/v4-backup/.bmad-core/working-in-the-brownfield.md +0 -606
@@ -1,957 +0,0 @@
1
- # Contract Testing Essentials (Pact)
2
-
3
- ## Principle
4
-
5
- Contract testing validates API contracts between consumer and provider services without requiring integrated end-to-end tests. Store consumer contracts alongside integration specs, version contracts semantically, and publish on every CI run. Provider verification before merge surfaces breaking changes immediately, while explicit fallback behavior (timeouts, retries, error payloads) captures resilience guarantees in contracts.
6
-
7
- ## Rationale
8
-
9
- Traditional integration testing requires running both consumer and provider simultaneously, creating slow, flaky tests with complex setup. Contract testing decouples services: consumers define expectations (pact files), providers verify against those expectations independently. This enables parallel development, catches breaking changes early, and documents API behavior as executable specifications. Pair contract tests with API smoke tests to validate data mapping and UI rendering in tandem.
10
-
11
- ## Pattern Examples
12
-
13
- ### Example 1: Pact Consumer Test (Frontend → Backend API)
14
-
15
- **Context**: React application consuming a user management API, defining expected interactions.
16
-
17
- **Implementation**:
18
-
19
- ```typescript
20
- // tests/contract/user-api.pact.spec.ts
21
- import { PactV3, MatchersV3 } from '@pact-foundation/pact';
22
- import { getUserById, createUser, User } from '@/api/user-service';
23
-
24
- const { like, eachLike, string, integer } = MatchersV3;
25
-
26
- /**
27
- * Consumer-Driven Contract Test
28
- * - Consumer (React app) defines expected API behavior
29
- * - Generates pact file for provider to verify
30
- * - Runs in isolation (no real backend required)
31
- */
32
-
33
- const provider = new PactV3({
34
- consumer: 'user-management-web',
35
- provider: 'user-api-service',
36
- dir: './pacts', // Output directory for pact files
37
- logLevel: 'warn',
38
- });
39
-
40
- describe('User API Contract', () => {
41
- describe('GET /users/:id', () => {
42
- it('should return user when user exists', async () => {
43
- // Arrange: Define expected interaction
44
- await provider
45
- .given('user with id 1 exists') // Provider state
46
- .uponReceiving('a request for user 1')
47
- .withRequest({
48
- method: 'GET',
49
- path: '/users/1',
50
- headers: {
51
- Accept: 'application/json',
52
- Authorization: like('Bearer token123'), // Matcher: any string
53
- },
54
- })
55
- .willRespondWith({
56
- status: 200,
57
- headers: {
58
- 'Content-Type': 'application/json',
59
- },
60
- body: like({
61
- id: integer(1),
62
- name: string('John Doe'),
63
- email: string('john@example.com'),
64
- role: string('user'),
65
- createdAt: string('2025-01-15T10:00:00Z'),
66
- }),
67
- })
68
- .executeTest(async (mockServer) => {
69
- // Act: Call consumer code against mock server
70
- const user = await getUserById(1, {
71
- baseURL: mockServer.url,
72
- headers: { Authorization: 'Bearer token123' },
73
- });
74
-
75
- // Assert: Validate consumer behavior
76
- expect(user).toEqual(
77
- expect.objectContaining({
78
- id: 1,
79
- name: 'John Doe',
80
- email: 'john@example.com',
81
- role: 'user',
82
- }),
83
- );
84
- });
85
- });
86
-
87
- it('should handle 404 when user does not exist', async () => {
88
- await provider
89
- .given('user with id 999 does not exist')
90
- .uponReceiving('a request for non-existent user')
91
- .withRequest({
92
- method: 'GET',
93
- path: '/users/999',
94
- headers: { Accept: 'application/json' },
95
- })
96
- .willRespondWith({
97
- status: 404,
98
- headers: { 'Content-Type': 'application/json' },
99
- body: {
100
- error: 'User not found',
101
- code: 'USER_NOT_FOUND',
102
- },
103
- })
104
- .executeTest(async (mockServer) => {
105
- // Act & Assert: Consumer handles 404 gracefully
106
- await expect(getUserById(999, { baseURL: mockServer.url })).rejects.toThrow('User not found');
107
- });
108
- });
109
- });
110
-
111
- describe('POST /users', () => {
112
- it('should create user and return 201', async () => {
113
- const newUser: Omit<User, 'id' | 'createdAt'> = {
114
- name: 'Jane Smith',
115
- email: 'jane@example.com',
116
- role: 'admin',
117
- };
118
-
119
- await provider
120
- .given('no users exist')
121
- .uponReceiving('a request to create a user')
122
- .withRequest({
123
- method: 'POST',
124
- path: '/users',
125
- headers: {
126
- 'Content-Type': 'application/json',
127
- Accept: 'application/json',
128
- },
129
- body: like(newUser),
130
- })
131
- .willRespondWith({
132
- status: 201,
133
- headers: { 'Content-Type': 'application/json' },
134
- body: like({
135
- id: integer(2),
136
- name: string('Jane Smith'),
137
- email: string('jane@example.com'),
138
- role: string('admin'),
139
- createdAt: string('2025-01-15T11:00:00Z'),
140
- }),
141
- })
142
- .executeTest(async (mockServer) => {
143
- const createdUser = await createUser(newUser, {
144
- baseURL: mockServer.url,
145
- });
146
-
147
- expect(createdUser).toEqual(
148
- expect.objectContaining({
149
- id: expect.any(Number),
150
- name: 'Jane Smith',
151
- email: 'jane@example.com',
152
- role: 'admin',
153
- }),
154
- );
155
- });
156
- });
157
- });
158
- });
159
- ```
160
-
161
- **package.json scripts**:
162
-
163
- ```json
164
- {
165
- "scripts": {
166
- "test:contract": "jest tests/contract --testTimeout=30000",
167
- "pact:publish": "pact-broker publish ./pacts --consumer-app-version=$GIT_SHA --broker-base-url=$PACT_BROKER_URL --broker-token=$PACT_BROKER_TOKEN"
168
- }
169
- }
170
- ```
171
-
172
- **Key Points**:
173
-
174
- - **Consumer-driven**: Frontend defines expectations, not backend
175
- - **Matchers**: `like`, `string`, `integer` for flexible matching
176
- - **Provider states**: given() sets up test preconditions
177
- - **Isolation**: No real backend needed, runs fast
178
- - **Pact generation**: Automatically creates JSON pact files
179
-
180
- ---
181
-
182
- ### Example 2: Pact Provider Verification (Backend validates contracts)
183
-
184
- **Context**: Node.js/Express API verifying pacts published by consumers.
185
-
186
- **Implementation**:
187
-
188
- ```typescript
189
- // tests/contract/user-api.provider.spec.ts
190
- import { Verifier, VerifierOptions } from '@pact-foundation/pact';
191
- import { server } from '../../src/server'; // Your Express/Fastify app
192
- import { seedDatabase, resetDatabase } from '../support/db-helpers';
193
-
194
- /**
195
- * Provider Verification Test
196
- * - Provider (backend API) verifies against published pacts
197
- * - State handlers setup test data for each interaction
198
- * - Runs before merge to catch breaking changes
199
- */
200
-
201
- describe('Pact Provider Verification', () => {
202
- let serverInstance;
203
- const PORT = 3001;
204
-
205
- beforeAll(async () => {
206
- // Start provider server
207
- serverInstance = server.listen(PORT);
208
- console.log(`Provider server running on port ${PORT}`);
209
- });
210
-
211
- afterAll(async () => {
212
- // Cleanup
213
- await serverInstance.close();
214
- });
215
-
216
- it('should verify pacts from all consumers', async () => {
217
- const opts: VerifierOptions = {
218
- // Provider details
219
- provider: 'user-api-service',
220
- providerBaseUrl: `http://localhost:${PORT}`,
221
-
222
- // Pact Broker configuration
223
- pactBrokerUrl: process.env.PACT_BROKER_URL,
224
- pactBrokerToken: process.env.PACT_BROKER_TOKEN,
225
- publishVerificationResult: process.env.CI === 'true',
226
- providerVersion: process.env.GIT_SHA || 'dev',
227
-
228
- // State handlers: Setup provider state for each interaction
229
- stateHandlers: {
230
- 'user with id 1 exists': async () => {
231
- await seedDatabase({
232
- users: [
233
- {
234
- id: 1,
235
- name: 'John Doe',
236
- email: 'john@example.com',
237
- role: 'user',
238
- createdAt: '2025-01-15T10:00:00Z',
239
- },
240
- ],
241
- });
242
- return 'User seeded successfully';
243
- },
244
-
245
- 'user with id 999 does not exist': async () => {
246
- // Ensure user doesn't exist
247
- await resetDatabase();
248
- return 'Database reset';
249
- },
250
-
251
- 'no users exist': async () => {
252
- await resetDatabase();
253
- return 'Database empty';
254
- },
255
- },
256
-
257
- // Request filters: Add auth headers to all requests
258
- requestFilter: (req, res, next) => {
259
- // Mock authentication for verification
260
- req.headers['x-user-id'] = 'test-user';
261
- req.headers['authorization'] = 'Bearer valid-test-token';
262
- next();
263
- },
264
-
265
- // Timeout for verification
266
- timeout: 30000,
267
- };
268
-
269
- // Run verification
270
- await new Verifier(opts).verifyProvider();
271
- });
272
- });
273
- ```
274
-
275
- **CI integration**:
276
-
277
- ```yaml
278
- # .github/workflows/pact-provider.yml
279
- name: Pact Provider Verification
280
- on:
281
- pull_request:
282
- push:
283
- branches: [main]
284
-
285
- jobs:
286
- verify-contracts:
287
- runs-on: ubuntu-latest
288
- steps:
289
- - uses: actions/checkout@v4
290
-
291
- - name: Setup Node.js
292
- uses: actions/setup-node@v4
293
- with:
294
- node-version-file: '.nvmrc'
295
-
296
- - name: Install dependencies
297
- run: npm ci
298
-
299
- - name: Start database
300
- run: docker-compose up -d postgres
301
-
302
- - name: Run migrations
303
- run: npm run db:migrate
304
-
305
- - name: Verify pacts
306
- run: npm run test:contract:provider
307
- env:
308
- PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
309
- PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
310
- GIT_SHA: ${{ github.sha }}
311
- CI: true
312
-
313
- - name: Can I Deploy?
314
- run: |
315
- npx pact-broker can-i-deploy \
316
- --pacticipant user-api-service \
317
- --version ${{ github.sha }} \
318
- --to-environment production
319
- env:
320
- PACT_BROKER_BASE_URL: ${{ secrets.PACT_BROKER_URL }}
321
- PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
322
- ```
323
-
324
- **Key Points**:
325
-
326
- - **State handlers**: Setup provider data for each given() state
327
- - **Request filters**: Add auth/headers for verification requests
328
- - **CI publishing**: Verification results sent to broker
329
- - **can-i-deploy**: Safety check before production deployment
330
- - **Database isolation**: Reset between state handlers
331
-
332
- ---
333
-
334
- ### Example 3: Contract CI Integration (Consumer & Provider Workflow)
335
-
336
- **Context**: Complete CI/CD workflow coordinating consumer pact publishing and provider verification.
337
-
338
- **Implementation**:
339
-
340
- ```yaml
341
- # .github/workflows/pact-consumer.yml (Consumer side)
342
- name: Pact Consumer Tests
343
- on:
344
- pull_request:
345
- push:
346
- branches: [main]
347
-
348
- jobs:
349
- consumer-tests:
350
- runs-on: ubuntu-latest
351
- steps:
352
- - uses: actions/checkout@v4
353
-
354
- - name: Setup Node.js
355
- uses: actions/setup-node@v4
356
- with:
357
- node-version-file: '.nvmrc'
358
-
359
- - name: Install dependencies
360
- run: npm ci
361
-
362
- - name: Run consumer contract tests
363
- run: npm run test:contract
364
-
365
- - name: Publish pacts to broker
366
- if: github.ref == 'refs/heads/main' || github.event_name == 'pull_request'
367
- run: |
368
- npx pact-broker publish ./pacts \
369
- --consumer-app-version ${{ github.sha }} \
370
- --branch ${{ github.head_ref || github.ref_name }} \
371
- --broker-base-url ${{ secrets.PACT_BROKER_URL }} \
372
- --broker-token ${{ secrets.PACT_BROKER_TOKEN }}
373
-
374
- - name: Tag pact with environment (main branch only)
375
- if: github.ref == 'refs/heads/main'
376
- run: |
377
- npx pact-broker create-version-tag \
378
- --pacticipant user-management-web \
379
- --version ${{ github.sha }} \
380
- --tag production \
381
- --broker-base-url ${{ secrets.PACT_BROKER_URL }} \
382
- --broker-token ${{ secrets.PACT_BROKER_TOKEN }}
383
- ```
384
-
385
- ```yaml
386
- # .github/workflows/pact-provider.yml (Provider side)
387
- name: Pact Provider Verification
388
- on:
389
- pull_request:
390
- push:
391
- branches: [main]
392
- repository_dispatch:
393
- types: [pact_changed] # Webhook from Pact Broker
394
-
395
- jobs:
396
- verify-contracts:
397
- runs-on: ubuntu-latest
398
- steps:
399
- - uses: actions/checkout@v4
400
-
401
- - name: Setup Node.js
402
- uses: actions/setup-node@v4
403
- with:
404
- node-version-file: '.nvmrc'
405
-
406
- - name: Install dependencies
407
- run: npm ci
408
-
409
- - name: Start dependencies
410
- run: docker-compose up -d
411
-
412
- - name: Run provider verification
413
- run: npm run test:contract:provider
414
- env:
415
- PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
416
- PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
417
- GIT_SHA: ${{ github.sha }}
418
- CI: true
419
-
420
- - name: Publish verification results
421
- if: always()
422
- run: echo "Verification results published to broker"
423
-
424
- - name: Can I Deploy to Production?
425
- if: github.ref == 'refs/heads/main'
426
- run: |
427
- npx pact-broker can-i-deploy \
428
- --pacticipant user-api-service \
429
- --version ${{ github.sha }} \
430
- --to-environment production \
431
- --broker-base-url ${{ secrets.PACT_BROKER_URL }} \
432
- --broker-token ${{ secrets.PACT_BROKER_TOKEN }} \
433
- --retry-while-unknown 6 \
434
- --retry-interval 10
435
-
436
- - name: Record deployment (if can-i-deploy passed)
437
- if: success() && github.ref == 'refs/heads/main'
438
- run: |
439
- npx pact-broker record-deployment \
440
- --pacticipant user-api-service \
441
- --version ${{ github.sha }} \
442
- --environment production \
443
- --broker-base-url ${{ secrets.PACT_BROKER_URL }} \
444
- --broker-token ${{ secrets.PACT_BROKER_TOKEN }}
445
- ```
446
-
447
- **Pact Broker Webhook Configuration**:
448
-
449
- ```json
450
- {
451
- "events": [
452
- {
453
- "name": "contract_content_changed"
454
- }
455
- ],
456
- "request": {
457
- "method": "POST",
458
- "url": "https://api.github.com/repos/your-org/user-api/dispatches",
459
- "headers": {
460
- "Authorization": "Bearer ${user.githubToken}",
461
- "Content-Type": "application/json",
462
- "Accept": "application/vnd.github.v3+json"
463
- },
464
- "body": {
465
- "event_type": "pact_changed",
466
- "client_payload": {
467
- "pact_url": "${pactbroker.pactUrl}",
468
- "consumer": "${pactbroker.consumerName}",
469
- "provider": "${pactbroker.providerName}"
470
- }
471
- }
472
- }
473
- }
474
- ```
475
-
476
- **Key Points**:
477
-
478
- - **Automatic trigger**: Consumer pact changes trigger provider verification via webhook
479
- - **Branch tracking**: Pacts published per branch for feature testing
480
- - **can-i-deploy**: Safety gate before production deployment
481
- - **Record deployment**: Track which version is in each environment
482
- - **Parallel dev**: Consumer and provider teams work independently
483
-
484
- ---
485
-
486
- ### Example 4: Resilience Coverage (Testing Fallback Behavior)
487
-
488
- **Context**: Capture timeout, retry, and error handling behavior explicitly in contracts.
489
-
490
- **Implementation**:
491
-
492
- ```typescript
493
- // tests/contract/user-api-resilience.pact.spec.ts
494
- import { PactV3, MatchersV3 } from '@pact-foundation/pact';
495
- import { getUserById, ApiError } from '@/api/user-service';
496
-
497
- const { like, string } = MatchersV3;
498
-
499
- const provider = new PactV3({
500
- consumer: 'user-management-web',
501
- provider: 'user-api-service',
502
- dir: './pacts',
503
- });
504
-
505
- describe('User API Resilience Contract', () => {
506
- /**
507
- * Test 500 error handling
508
- * Verifies consumer handles server errors gracefully
509
- */
510
- it('should handle 500 errors with retry logic', async () => {
511
- await provider
512
- .given('server is experiencing errors')
513
- .uponReceiving('a request that returns 500')
514
- .withRequest({
515
- method: 'GET',
516
- path: '/users/1',
517
- headers: { Accept: 'application/json' },
518
- })
519
- .willRespondWith({
520
- status: 500,
521
- headers: { 'Content-Type': 'application/json' },
522
- body: {
523
- error: 'Internal server error',
524
- code: 'INTERNAL_ERROR',
525
- retryable: true,
526
- },
527
- })
528
- .executeTest(async (mockServer) => {
529
- // Consumer should retry on 500
530
- try {
531
- await getUserById(1, {
532
- baseURL: mockServer.url,
533
- retries: 3,
534
- retryDelay: 100,
535
- });
536
- fail('Should have thrown error after retries');
537
- } catch (error) {
538
- expect(error).toBeInstanceOf(ApiError);
539
- expect((error as ApiError).code).toBe('INTERNAL_ERROR');
540
- expect((error as ApiError).retryable).toBe(true);
541
- }
542
- });
543
- });
544
-
545
- /**
546
- * Test 429 rate limiting
547
- * Verifies consumer respects rate limits
548
- */
549
- it('should handle 429 rate limit with backoff', async () => {
550
- await provider
551
- .given('rate limit exceeded for user')
552
- .uponReceiving('a request that is rate limited')
553
- .withRequest({
554
- method: 'GET',
555
- path: '/users/1',
556
- })
557
- .willRespondWith({
558
- status: 429,
559
- headers: {
560
- 'Content-Type': 'application/json',
561
- 'Retry-After': '60', // Retry after 60 seconds
562
- },
563
- body: {
564
- error: 'Too many requests',
565
- code: 'RATE_LIMIT_EXCEEDED',
566
- },
567
- })
568
- .executeTest(async (mockServer) => {
569
- try {
570
- await getUserById(1, {
571
- baseURL: mockServer.url,
572
- respectRateLimit: true,
573
- });
574
- fail('Should have thrown rate limit error');
575
- } catch (error) {
576
- expect(error).toBeInstanceOf(ApiError);
577
- expect((error as ApiError).code).toBe('RATE_LIMIT_EXCEEDED');
578
- expect((error as ApiError).retryAfter).toBe(60);
579
- }
580
- });
581
- });
582
-
583
- /**
584
- * Test timeout handling
585
- * Verifies consumer has appropriate timeout configuration
586
- */
587
- it('should timeout after 10 seconds', async () => {
588
- await provider
589
- .given('server is slow to respond')
590
- .uponReceiving('a request that times out')
591
- .withRequest({
592
- method: 'GET',
593
- path: '/users/1',
594
- })
595
- .willRespondWith({
596
- status: 200,
597
- headers: { 'Content-Type': 'application/json' },
598
- body: like({ id: 1, name: 'John' }),
599
- })
600
- .withDelay(15000) // Simulate 15 second delay
601
- .executeTest(async (mockServer) => {
602
- try {
603
- await getUserById(1, {
604
- baseURL: mockServer.url,
605
- timeout: 10000, // 10 second timeout
606
- });
607
- fail('Should have timed out');
608
- } catch (error) {
609
- expect(error).toBeInstanceOf(ApiError);
610
- expect((error as ApiError).code).toBe('TIMEOUT');
611
- }
612
- });
613
- });
614
-
615
- /**
616
- * Test partial response (optional fields)
617
- * Verifies consumer handles missing optional data
618
- */
619
- it('should handle response with missing optional fields', async () => {
620
- await provider
621
- .given('user exists with minimal data')
622
- .uponReceiving('a request for user with partial data')
623
- .withRequest({
624
- method: 'GET',
625
- path: '/users/1',
626
- })
627
- .willRespondWith({
628
- status: 200,
629
- headers: { 'Content-Type': 'application/json' },
630
- body: {
631
- id: integer(1),
632
- name: string('John Doe'),
633
- email: string('john@example.com'),
634
- // role, createdAt, etc. omitted (optional fields)
635
- },
636
- })
637
- .executeTest(async (mockServer) => {
638
- const user = await getUserById(1, { baseURL: mockServer.url });
639
-
640
- // Consumer handles missing optional fields gracefully
641
- expect(user.id).toBe(1);
642
- expect(user.name).toBe('John Doe');
643
- expect(user.role).toBeUndefined(); // Optional field
644
- expect(user.createdAt).toBeUndefined(); // Optional field
645
- });
646
- });
647
- });
648
- ```
649
-
650
- **API client with retry logic**:
651
-
652
- ```typescript
653
- // src/api/user-service.ts
654
- import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
655
-
656
- export class ApiError extends Error {
657
- constructor(
658
- message: string,
659
- public code: string,
660
- public retryable: boolean = false,
661
- public retryAfter?: number,
662
- ) {
663
- super(message);
664
- }
665
- }
666
-
667
- /**
668
- * User API client with retry and error handling
669
- */
670
- export async function getUserById(
671
- id: number,
672
- config?: AxiosRequestConfig & { retries?: number; retryDelay?: number; respectRateLimit?: boolean },
673
- ): Promise<User> {
674
- const { retries = 3, retryDelay = 1000, respectRateLimit = true, ...axiosConfig } = config || {};
675
-
676
- let lastError: Error;
677
-
678
- for (let attempt = 1; attempt <= retries; attempt++) {
679
- try {
680
- const response = await axios.get(`/users/${id}`, axiosConfig);
681
- return response.data;
682
- } catch (error: any) {
683
- lastError = error;
684
-
685
- // Handle rate limiting
686
- if (error.response?.status === 429) {
687
- const retryAfter = parseInt(error.response.headers['retry-after'] || '60');
688
- throw new ApiError('Too many requests', 'RATE_LIMIT_EXCEEDED', false, retryAfter);
689
- }
690
-
691
- // Retry on 500 errors
692
- if (error.response?.status === 500 && attempt < retries) {
693
- await new Promise((resolve) => setTimeout(resolve, retryDelay * attempt));
694
- continue;
695
- }
696
-
697
- // Handle 404
698
- if (error.response?.status === 404) {
699
- throw new ApiError('User not found', 'USER_NOT_FOUND', false);
700
- }
701
-
702
- // Handle timeout
703
- if (error.code === 'ECONNABORTED') {
704
- throw new ApiError('Request timeout', 'TIMEOUT', true);
705
- }
706
-
707
- break;
708
- }
709
- }
710
-
711
- throw new ApiError('Request failed after retries', 'INTERNAL_ERROR', true);
712
- }
713
- ```
714
-
715
- **Key Points**:
716
-
717
- - **Resilience contracts**: Timeouts, retries, errors explicitly tested
718
- - **State handlers**: Provider sets up each test scenario
719
- - **Error handling**: Consumer validates graceful degradation
720
- - **Retry logic**: Exponential backoff tested
721
- - **Optional fields**: Consumer handles partial responses
722
-
723
- ---
724
-
725
- ### Example 4: Pact Broker Housekeeping & Lifecycle Management
726
-
727
- **Context**: Automated broker maintenance to prevent contract sprawl and noise.
728
-
729
- **Implementation**:
730
-
731
- ```typescript
732
- // scripts/pact-broker-housekeeping.ts
733
- /**
734
- * Pact Broker Housekeeping Script
735
- * - Archive superseded contracts
736
- * - Expire unused pacts
737
- * - Tag releases for environment tracking
738
- */
739
-
740
- import { execSync } from 'child_process';
741
-
742
- const PACT_BROKER_URL = process.env.PACT_BROKER_URL!;
743
- const PACT_BROKER_TOKEN = process.env.PACT_BROKER_TOKEN!;
744
- const PACTICIPANT = 'user-api-service';
745
-
746
- /**
747
- * Tag release with environment
748
- */
749
- function tagRelease(version: string, environment: 'staging' | 'production') {
750
- console.log(`🏷️ Tagging ${PACTICIPANT} v${version} as ${environment}`);
751
-
752
- execSync(
753
- `npx pact-broker create-version-tag \
754
- --pacticipant ${PACTICIPANT} \
755
- --version ${version} \
756
- --tag ${environment} \
757
- --broker-base-url ${PACT_BROKER_URL} \
758
- --broker-token ${PACT_BROKER_TOKEN}`,
759
- { stdio: 'inherit' },
760
- );
761
- }
762
-
763
- /**
764
- * Record deployment to environment
765
- */
766
- function recordDeployment(version: string, environment: 'staging' | 'production') {
767
- console.log(`📝 Recording deployment of ${PACTICIPANT} v${version} to ${environment}`);
768
-
769
- execSync(
770
- `npx pact-broker record-deployment \
771
- --pacticipant ${PACTICIPANT} \
772
- --version ${version} \
773
- --environment ${environment} \
774
- --broker-base-url ${PACT_BROKER_URL} \
775
- --broker-token ${PACT_BROKER_TOKEN}`,
776
- { stdio: 'inherit' },
777
- );
778
- }
779
-
780
- /**
781
- * Clean up old pact versions (retention policy)
782
- * Keep: last 30 days, all production tags, latest from each branch
783
- */
784
- function cleanupOldPacts() {
785
- console.log(`🧹 Cleaning up old pacts for ${PACTICIPANT}`);
786
-
787
- execSync(
788
- `npx pact-broker clean \
789
- --pacticipant ${PACTICIPANT} \
790
- --broker-base-url ${PACT_BROKER_URL} \
791
- --broker-token ${PACT_BROKER_TOKEN} \
792
- --keep-latest-for-branch 1 \
793
- --keep-min-age 30`,
794
- { stdio: 'inherit' },
795
- );
796
- }
797
-
798
- /**
799
- * Check deployment compatibility
800
- */
801
- function canIDeploy(version: string, toEnvironment: string): boolean {
802
- console.log(`🔍 Checking if ${PACTICIPANT} v${version} can deploy to ${toEnvironment}`);
803
-
804
- try {
805
- execSync(
806
- `npx pact-broker can-i-deploy \
807
- --pacticipant ${PACTICIPANT} \
808
- --version ${version} \
809
- --to-environment ${toEnvironment} \
810
- --broker-base-url ${PACT_BROKER_URL} \
811
- --broker-token ${PACT_BROKER_TOKEN} \
812
- --retry-while-unknown 6 \
813
- --retry-interval 10`,
814
- { stdio: 'inherit' },
815
- );
816
- return true;
817
- } catch (error) {
818
- console.error(`❌ Cannot deploy to ${toEnvironment}`);
819
- return false;
820
- }
821
- }
822
-
823
- /**
824
- * Main housekeeping workflow
825
- */
826
- async function main() {
827
- const command = process.argv[2];
828
- const version = process.argv[3];
829
- const environment = process.argv[4] as 'staging' | 'production';
830
-
831
- switch (command) {
832
- case 'tag-release':
833
- tagRelease(version, environment);
834
- break;
835
-
836
- case 'record-deployment':
837
- recordDeployment(version, environment);
838
- break;
839
-
840
- case 'can-i-deploy':
841
- const canDeploy = canIDeploy(version, environment);
842
- process.exit(canDeploy ? 0 : 1);
843
-
844
- case 'cleanup':
845
- cleanupOldPacts();
846
- break;
847
-
848
- default:
849
- console.error('Unknown command. Use: tag-release | record-deployment | can-i-deploy | cleanup');
850
- process.exit(1);
851
- }
852
- }
853
-
854
- main();
855
- ```
856
-
857
- **package.json scripts**:
858
-
859
- ```json
860
- {
861
- "scripts": {
862
- "pact:tag": "ts-node scripts/pact-broker-housekeeping.ts tag-release",
863
- "pact:record": "ts-node scripts/pact-broker-housekeeping.ts record-deployment",
864
- "pact:can-deploy": "ts-node scripts/pact-broker-housekeeping.ts can-i-deploy",
865
- "pact:cleanup": "ts-node scripts/pact-broker-housekeeping.ts cleanup"
866
- }
867
- }
868
- ```
869
-
870
- **Deployment workflow integration**:
871
-
872
- ```yaml
873
- # .github/workflows/deploy-production.yml
874
- name: Deploy to Production
875
- on:
876
- push:
877
- tags:
878
- - 'v*'
879
-
880
- jobs:
881
- verify-contracts:
882
- runs-on: ubuntu-latest
883
- steps:
884
- - uses: actions/checkout@v4
885
-
886
- - name: Check pact compatibility
887
- run: npm run pact:can-deploy ${{ github.ref_name }} production
888
- env:
889
- PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
890
- PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
891
-
892
- deploy:
893
- needs: verify-contracts
894
- runs-on: ubuntu-latest
895
- steps:
896
- - name: Deploy to production
897
- run: ./scripts/deploy.sh production
898
-
899
- - name: Record deployment in Pact Broker
900
- run: npm run pact:record ${{ github.ref_name }} production
901
- env:
902
- PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
903
- PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
904
- ```
905
-
906
- **Scheduled cleanup**:
907
-
908
- ```yaml
909
- # .github/workflows/pact-housekeeping.yml
910
- name: Pact Broker Housekeeping
911
- on:
912
- schedule:
913
- - cron: '0 2 * * 0' # Weekly on Sunday at 2 AM
914
-
915
- jobs:
916
- cleanup:
917
- runs-on: ubuntu-latest
918
- steps:
919
- - uses: actions/checkout@v4
920
-
921
- - name: Cleanup old pacts
922
- run: npm run pact:cleanup
923
- env:
924
- PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
925
- PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
926
- ```
927
-
928
- **Key Points**:
929
-
930
- - **Automated tagging**: Releases tagged with environment
931
- - **Deployment tracking**: Broker knows which version is where
932
- - **Safety gate**: can-i-deploy blocks incompatible deployments
933
- - **Retention policy**: Keep recent, production, and branch-latest pacts
934
- - **Webhook triggers**: Provider verification runs on consumer changes
935
-
936
- ---
937
-
938
- ## Contract Testing Checklist
939
-
940
- Before implementing contract testing, verify:
941
-
942
- - [ ] **Pact Broker setup**: Hosted (Pactflow) or self-hosted broker configured
943
- - [ ] **Consumer tests**: Generate pacts in CI, publish to broker on merge
944
- - [ ] **Provider verification**: Runs on PR, verifies all consumer pacts
945
- - [ ] **State handlers**: Provider implements all given() states
946
- - [ ] **can-i-deploy**: Blocks deployment if contracts incompatible
947
- - [ ] **Webhooks configured**: Consumer changes trigger provider verification
948
- - [ ] **Retention policy**: Old pacts archived (keep 30 days, all production tags)
949
- - [ ] **Resilience tested**: Timeouts, retries, error codes in contracts
950
-
951
- ## Integration Points
952
-
953
- - Used in workflows: `*automate` (integration test generation), `*ci` (contract CI setup)
954
- - Related fragments: `test-levels-framework.md`, `ci-burn-in.md`
955
- - Tools: Pact.js, Pact Broker (Pactflow or self-hosted), Pact CLI
956
-
957
- _Source: Pact consumer/provider sample repos, Murat contract testing blog, Pact official documentation_