@hivehub/rulebook 4.2.2 → 4.3.0

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 (334) hide show
  1. package/.claude/commands/continue.md +33 -33
  2. package/.claude/commands/ralph-config.md +112 -112
  3. package/.claude/commands/ralph-history.md +110 -110
  4. package/.claude/commands/ralph-init.md +72 -72
  5. package/.claude/commands/ralph-pause-resume.md +105 -105
  6. package/.claude/commands/ralph-run.md +101 -101
  7. package/.claude/commands/ralph-status.md +76 -76
  8. package/.claude/commands/rulebook-memory-save.md +48 -48
  9. package/.claude/commands/rulebook-memory-search.md +47 -47
  10. package/.claude/commands/rulebook-task-apply.md +67 -67
  11. package/.claude/commands/rulebook-task-archive.md +70 -70
  12. package/.claude/commands/rulebook-task-create.md +93 -93
  13. package/.claude/commands/rulebook-task-list.md +42 -42
  14. package/.claude/commands/rulebook-task-show.md +52 -52
  15. package/.claude/commands/rulebook-task-validate.md +53 -53
  16. package/.claude-plugin/marketplace.json +28 -28
  17. package/.claude-plugin/plugin.json +8 -8
  18. package/README.md +8 -1
  19. package/dist/cli/commands.d.ts.map +1 -1
  20. package/dist/cli/commands.js +4 -4
  21. package/dist/cli/commands.js.map +1 -1
  22. package/dist/core/claude-mcp.d.ts +8 -1
  23. package/dist/core/claude-mcp.d.ts.map +1 -1
  24. package/dist/core/claude-mcp.js +32 -1
  25. package/dist/core/claude-mcp.js.map +1 -1
  26. package/dist/core/generator.d.ts +13 -0
  27. package/dist/core/generator.d.ts.map +1 -1
  28. package/dist/core/generator.js +283 -28
  29. package/dist/core/generator.js.map +1 -1
  30. package/dist/core/workspace/workspace-manager.d.ts.map +1 -1
  31. package/dist/core/workspace/workspace-manager.js +2 -6
  32. package/dist/core/workspace/workspace-manager.js.map +1 -1
  33. package/dist/index.js +1 -3
  34. package/dist/index.js.map +1 -1
  35. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  36. package/dist/mcp/rulebook-server.js +5 -4
  37. package/dist/mcp/rulebook-server.js.map +1 -1
  38. package/package.json +21 -22
  39. package/templates/agents/accessibility-reviewer.md +43 -0
  40. package/templates/agents/api-designer.md +42 -0
  41. package/templates/agents/architect.md +51 -0
  42. package/templates/agents/build-engineer.md +36 -0
  43. package/templates/agents/code-reviewer.md +47 -0
  44. package/templates/agents/database-architect.md +41 -0
  45. package/templates/agents/devops-engineer.md +42 -0
  46. package/templates/agents/docs-writer.md +38 -0
  47. package/templates/agents/i18n-engineer.md +42 -0
  48. package/templates/agents/implementer.md +38 -35
  49. package/templates/agents/migration-engineer.md +42 -0
  50. package/templates/agents/performance-engineer.md +49 -0
  51. package/templates/agents/refactoring-agent.md +41 -0
  52. package/templates/agents/researcher.md +38 -34
  53. package/templates/agents/security-reviewer.md +40 -0
  54. package/templates/agents/team-lead.md +37 -34
  55. package/templates/agents/tester.md +45 -42
  56. package/templates/agents/ux-reviewer.md +43 -0
  57. package/templates/ci/rulebook-review.yml +26 -26
  58. package/templates/cli/AIDER.md +49 -49
  59. package/templates/cli/AMAZON_Q.md +25 -25
  60. package/templates/cli/AUGGIE.md +32 -32
  61. package/templates/cli/CLAUDE.md +117 -117
  62. package/templates/cli/CLINE.md +99 -99
  63. package/templates/cli/CODEBUDDY.md +20 -20
  64. package/templates/cli/CODEIUM.md +20 -20
  65. package/templates/cli/CODEX.md +21 -21
  66. package/templates/cli/CONTINUE.md +34 -34
  67. package/templates/cli/CURSOR_CLI.md +62 -62
  68. package/templates/cli/FACTORY.md +18 -18
  69. package/templates/cli/GEMINI.md +35 -35
  70. package/templates/cli/KILOCODE.md +18 -18
  71. package/templates/cli/OPENCODE.md +18 -18
  72. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  73. package/templates/commands/rulebook-memory-save.md +48 -48
  74. package/templates/commands/rulebook-memory-search.md +47 -47
  75. package/templates/commands/rulebook-task-apply.md +67 -67
  76. package/templates/commands/rulebook-task-archive.md +94 -94
  77. package/templates/commands/rulebook-task-create.md +93 -93
  78. package/templates/commands/rulebook-task-list.md +42 -42
  79. package/templates/commands/rulebook-task-show.md +52 -52
  80. package/templates/commands/rulebook-task-validate.md +53 -53
  81. package/templates/core/AGENTS_LEAN.md +25 -25
  82. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  83. package/templates/core/AGENT_AUTOMATION.md +288 -288
  84. package/templates/core/DAG.md +304 -304
  85. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  86. package/templates/core/MULTI_AGENT.md +74 -74
  87. package/templates/core/PLANS.md +28 -28
  88. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  89. package/templates/core/RALPH.md +471 -471
  90. package/templates/core/RULEBOOK.md +1935 -1935
  91. package/templates/frameworks/ANGULAR.md +36 -36
  92. package/templates/frameworks/DJANGO.md +83 -83
  93. package/templates/frameworks/ELECTRON.md +147 -147
  94. package/templates/frameworks/FLASK.md +38 -38
  95. package/templates/frameworks/FLUTTER.md +55 -55
  96. package/templates/frameworks/JQUERY.md +32 -32
  97. package/templates/frameworks/LARAVEL.md +38 -38
  98. package/templates/frameworks/NESTJS.md +43 -43
  99. package/templates/frameworks/NEXTJS.md +127 -127
  100. package/templates/frameworks/NUXT.md +40 -40
  101. package/templates/frameworks/RAILS.md +66 -66
  102. package/templates/frameworks/REACT.md +38 -38
  103. package/templates/frameworks/REACT_NATIVE.md +47 -47
  104. package/templates/frameworks/SPRING.md +39 -39
  105. package/templates/frameworks/SYMFONY.md +36 -36
  106. package/templates/frameworks/VUE.md +36 -36
  107. package/templates/frameworks/ZEND.md +35 -35
  108. package/templates/git/CI_CD_PATTERNS.md +661 -661
  109. package/templates/git/GITHUB_ACTIONS.md +728 -728
  110. package/templates/git/GITLAB_CI.md +730 -730
  111. package/templates/git/GIT_WORKFLOW.md +1157 -1157
  112. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  113. package/templates/hooks/COMMIT_MSG.md +530 -530
  114. package/templates/hooks/POST_CHECKOUT.md +546 -546
  115. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  116. package/templates/hooks/PRE_COMMIT.md +414 -414
  117. package/templates/hooks/PRE_PUSH.md +601 -601
  118. package/templates/ides/CONTINUE_RULES.md +16 -16
  119. package/templates/ides/COPILOT.md +37 -37
  120. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  121. package/templates/ides/CURSOR.md +43 -43
  122. package/templates/ides/GEMINI_RULES.md +17 -17
  123. package/templates/ides/JETBRAINS_AI.md +35 -35
  124. package/templates/ides/REPLIT.md +36 -36
  125. package/templates/ides/TABNINE.md +29 -29
  126. package/templates/ides/VSCODE.md +40 -40
  127. package/templates/ides/WINDSURF.md +36 -36
  128. package/templates/ides/WINDSURF_RULES.md +14 -14
  129. package/templates/ides/ZED.md +32 -32
  130. package/templates/ides/cursor-mdc/go.mdc +24 -24
  131. package/templates/ides/cursor-mdc/python.mdc +24 -24
  132. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  133. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  134. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  135. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  136. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  137. package/templates/languages/C.md +333 -333
  138. package/templates/languages/CPP.md +743 -743
  139. package/templates/languages/CSHARP.md +417 -417
  140. package/templates/languages/ELIXIR.md +454 -454
  141. package/templates/languages/ERLANG.md +361 -361
  142. package/templates/languages/GO.md +645 -645
  143. package/templates/languages/HASKELL.md +177 -177
  144. package/templates/languages/JAVA.md +607 -607
  145. package/templates/languages/JAVASCRIPT.md +631 -631
  146. package/templates/languages/JULIA.md +97 -97
  147. package/templates/languages/KOTLIN.md +511 -511
  148. package/templates/languages/LISP.md +100 -100
  149. package/templates/languages/LUA.md +74 -74
  150. package/templates/languages/OBJECTIVEC.md +90 -90
  151. package/templates/languages/PHP.md +416 -416
  152. package/templates/languages/PYTHON.md +682 -682
  153. package/templates/languages/RUBY.md +421 -421
  154. package/templates/languages/RUST.md +477 -477
  155. package/templates/languages/SAS.md +73 -73
  156. package/templates/languages/SCALA.md +348 -348
  157. package/templates/languages/SOLIDITY.md +580 -580
  158. package/templates/languages/SQL.md +137 -137
  159. package/templates/languages/SWIFT.md +466 -466
  160. package/templates/languages/TYPESCRIPT.md +591 -591
  161. package/templates/languages/ZIG.md +265 -265
  162. package/templates/modules/ATLASSIAN.md +255 -255
  163. package/templates/modules/CONTEXT7.md +54 -54
  164. package/templates/modules/FIGMA.md +267 -267
  165. package/templates/modules/GITHUB_MCP.md +64 -64
  166. package/templates/modules/GRAFANA.md +328 -328
  167. package/templates/modules/MEMORY.md +126 -126
  168. package/templates/modules/NOTION.md +247 -247
  169. package/templates/modules/PLAYWRIGHT.md +90 -90
  170. package/templates/modules/RULEBOOK_MCP.md +156 -156
  171. package/templates/modules/SERENA.md +337 -337
  172. package/templates/modules/SUPABASE.md +223 -223
  173. package/templates/modules/SYNAP.md +69 -69
  174. package/templates/modules/VECTORIZER.md +63 -63
  175. package/templates/modules/sequential-thinking.md +42 -42
  176. package/templates/ralph/ralph-history.bat +4 -4
  177. package/templates/ralph/ralph-history.sh +5 -5
  178. package/templates/ralph/ralph-init.bat +5 -5
  179. package/templates/ralph/ralph-init.sh +5 -5
  180. package/templates/ralph/ralph-pause.bat +5 -5
  181. package/templates/ralph/ralph-pause.sh +5 -5
  182. package/templates/ralph/ralph-run.bat +5 -5
  183. package/templates/ralph/ralph-run.sh +5 -5
  184. package/templates/ralph/ralph-status.bat +4 -4
  185. package/templates/ralph/ralph-status.sh +5 -5
  186. package/templates/services/AZURE_BLOB.md +184 -184
  187. package/templates/services/CASSANDRA.md +239 -239
  188. package/templates/services/DATADOG.md +26 -26
  189. package/templates/services/DOCKER.md +124 -124
  190. package/templates/services/DOCKER_COMPOSE.md +168 -168
  191. package/templates/services/DYNAMODB.md +308 -308
  192. package/templates/services/ELASTICSEARCH.md +347 -347
  193. package/templates/services/GCS.md +178 -178
  194. package/templates/services/HELM.md +194 -194
  195. package/templates/services/INFLUXDB.md +265 -265
  196. package/templates/services/KAFKA.md +341 -341
  197. package/templates/services/KUBERNETES.md +208 -208
  198. package/templates/services/MARIADB.md +183 -183
  199. package/templates/services/MEMCACHED.md +242 -242
  200. package/templates/services/MINIO.md +201 -201
  201. package/templates/services/MONGODB.md +268 -268
  202. package/templates/services/MYSQL.md +358 -358
  203. package/templates/services/NEO4J.md +247 -247
  204. package/templates/services/OPENTELEMETRY.md +25 -25
  205. package/templates/services/ORACLE.md +290 -290
  206. package/templates/services/PINO.md +24 -24
  207. package/templates/services/POSTGRESQL.md +326 -326
  208. package/templates/services/PROMETHEUS.md +33 -33
  209. package/templates/services/RABBITMQ.md +286 -286
  210. package/templates/services/REDIS.md +292 -292
  211. package/templates/services/S3.md +298 -298
  212. package/templates/services/SENTRY.md +23 -23
  213. package/templates/services/SQLITE.md +294 -294
  214. package/templates/services/SQLSERVER.md +294 -294
  215. package/templates/services/WINSTON.md +30 -30
  216. package/templates/skills/cli/aider/SKILL.md +59 -59
  217. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  218. package/templates/skills/cli/auggie/SKILL.md +42 -42
  219. package/templates/skills/cli/claude/SKILL.md +42 -42
  220. package/templates/skills/cli/cline/SKILL.md +42 -42
  221. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  222. package/templates/skills/cli/codeium/SKILL.md +30 -30
  223. package/templates/skills/cli/codex/SKILL.md +31 -31
  224. package/templates/skills/cli/continue/SKILL.md +44 -44
  225. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  226. package/templates/skills/cli/factory/SKILL.md +28 -28
  227. package/templates/skills/cli/gemini/SKILL.md +45 -45
  228. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  229. package/templates/skills/cli/opencode/SKILL.md +28 -28
  230. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  231. package/templates/skills/core/dag/SKILL.md +314 -314
  232. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  233. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  234. package/templates/skills/core/rulebook/SKILL.md +176 -176
  235. package/templates/skills/dev/accessibility/SKILL.md +17 -0
  236. package/templates/skills/dev/api-design/SKILL.md +15 -0
  237. package/templates/skills/dev/architect/SKILL.md +17 -0
  238. package/templates/skills/dev/build-fix/SKILL.md +17 -0
  239. package/templates/skills/dev/db-design/SKILL.md +15 -0
  240. package/templates/skills/dev/debug/SKILL.md +16 -0
  241. package/templates/skills/dev/deploy/SKILL.md +17 -0
  242. package/templates/skills/dev/docs/SKILL.md +17 -0
  243. package/templates/skills/dev/migrate/SKILL.md +15 -0
  244. package/templates/skills/dev/perf/SKILL.md +17 -0
  245. package/templates/skills/dev/refactor/SKILL.md +17 -0
  246. package/templates/skills/dev/research/SKILL.md +14 -0
  247. package/templates/skills/dev/review/SKILL.md +18 -0
  248. package/templates/skills/dev/security-audit/SKILL.md +17 -0
  249. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  250. package/templates/skills/frameworks/django/SKILL.md +93 -93
  251. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  252. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  253. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  254. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  255. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  256. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  257. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  258. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  259. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  260. package/templates/skills/frameworks/react/SKILL.md +48 -48
  261. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  262. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  263. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  264. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  265. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  266. package/templates/skills/ides/copilot/SKILL.md +47 -47
  267. package/templates/skills/ides/cursor/SKILL.md +53 -53
  268. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  269. package/templates/skills/ides/replit/SKILL.md +46 -46
  270. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  271. package/templates/skills/ides/vscode/SKILL.md +50 -50
  272. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  273. package/templates/skills/ides/zed/SKILL.md +42 -42
  274. package/templates/skills/languages/c/SKILL.md +343 -343
  275. package/templates/skills/languages/cpp/SKILL.md +753 -753
  276. package/templates/skills/languages/csharp/SKILL.md +427 -427
  277. package/templates/skills/languages/elixir/SKILL.md +464 -464
  278. package/templates/skills/languages/erlang/SKILL.md +371 -371
  279. package/templates/skills/languages/go/SKILL.md +655 -655
  280. package/templates/skills/languages/haskell/SKILL.md +187 -187
  281. package/templates/skills/languages/java/SKILL.md +617 -617
  282. package/templates/skills/languages/javascript/SKILL.md +641 -641
  283. package/templates/skills/languages/julia/SKILL.md +107 -107
  284. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  285. package/templates/skills/languages/lisp/SKILL.md +110 -110
  286. package/templates/skills/languages/lua/SKILL.md +84 -84
  287. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  288. package/templates/skills/languages/php/SKILL.md +426 -426
  289. package/templates/skills/languages/python/SKILL.md +692 -692
  290. package/templates/skills/languages/ruby/SKILL.md +431 -431
  291. package/templates/skills/languages/rust/SKILL.md +487 -487
  292. package/templates/skills/languages/sas/SKILL.md +83 -83
  293. package/templates/skills/languages/scala/SKILL.md +358 -358
  294. package/templates/skills/languages/solidity/SKILL.md +590 -590
  295. package/templates/skills/languages/sql/SKILL.md +147 -147
  296. package/templates/skills/languages/swift/SKILL.md +476 -476
  297. package/templates/skills/languages/typescript/SKILL.md +302 -302
  298. package/templates/skills/languages/zig/SKILL.md +275 -275
  299. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  300. package/templates/skills/modules/context7/SKILL.md +64 -64
  301. package/templates/skills/modules/figma/SKILL.md +277 -277
  302. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  303. package/templates/skills/modules/grafana/SKILL.md +338 -338
  304. package/templates/skills/modules/memory/SKILL.md +73 -73
  305. package/templates/skills/modules/notion/SKILL.md +257 -257
  306. package/templates/skills/modules/playwright/SKILL.md +100 -100
  307. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  308. package/templates/skills/modules/serena/SKILL.md +347 -347
  309. package/templates/skills/modules/supabase/SKILL.md +233 -233
  310. package/templates/skills/modules/synap/SKILL.md +79 -79
  311. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  312. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  313. package/templates/skills/services/cassandra/SKILL.md +249 -249
  314. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  315. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  316. package/templates/skills/services/gcs/SKILL.md +188 -188
  317. package/templates/skills/services/influxdb/SKILL.md +275 -275
  318. package/templates/skills/services/kafka/SKILL.md +351 -351
  319. package/templates/skills/services/mariadb/SKILL.md +193 -193
  320. package/templates/skills/services/memcached/SKILL.md +252 -252
  321. package/templates/skills/services/minio/SKILL.md +211 -211
  322. package/templates/skills/services/mongodb/SKILL.md +278 -278
  323. package/templates/skills/services/mysql/SKILL.md +368 -368
  324. package/templates/skills/services/neo4j/SKILL.md +257 -257
  325. package/templates/skills/services/oracle/SKILL.md +300 -300
  326. package/templates/skills/services/postgresql/SKILL.md +336 -336
  327. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  328. package/templates/skills/services/redis/SKILL.md +302 -302
  329. package/templates/skills/services/s3/SKILL.md +308 -308
  330. package/templates/skills/services/sqlite/SKILL.md +304 -304
  331. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  332. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  333. package/templates/skills/workflows/ralph/install.sh +87 -87
  334. package/templates/skills/workflows/ralph/manifest.json +158 -158
@@ -1,661 +1,661 @@
1
- # CI/CD Patterns
2
-
3
- This template provides common CI/CD patterns and best practices applicable across all CI/CD platforms (GitHub Actions, GitLab CI, CircleCI, Jenkins, etc.).
4
-
5
- ## Purpose
6
-
7
- CI/CD patterns ensure:
8
- - Consistent build/test/deploy processes
9
- - Fast feedback loops
10
- - Reliable deployments
11
- - Quality gates enforcement
12
- - Automated release management
13
-
14
- ## Core CI/CD Stages
15
-
16
- ### 1. Validate Stage (Fastest - < 2 minutes)
17
-
18
- **Purpose**: Catch syntax errors and basic issues quickly
19
-
20
- **Includes**:
21
- - Linting
22
- - Code formatting check
23
- - Type checking
24
- - Basic syntax validation
25
-
26
- **Example**:
27
- ```yaml
28
- validate:
29
- script:
30
- - npm run lint
31
- - npm run format:check
32
- - npm run type-check
33
- ```
34
-
35
- ### 2. Build Stage (Fast - < 5 minutes)
36
-
37
- **Purpose**: Verify code compiles/builds successfully
38
-
39
- **Includes**:
40
- - Compilation
41
- - Bundling
42
- - Asset generation
43
- - Build artifact creation
44
-
45
- **Example**:
46
- ```yaml
47
- build:
48
- script:
49
- - npm run build
50
- artifacts:
51
- paths:
52
- - dist/
53
- expire_in: 7 days
54
- ```
55
-
56
- ### 3. Test Stage (Medium - < 15 minutes)
57
-
58
- **Purpose**: Verify functionality and quality
59
-
60
- **Includes**:
61
- - Unit tests
62
- - Integration tests
63
- - Coverage reporting
64
- - Security scanning
65
-
66
- **Example**:
67
- ```yaml
68
- test:
69
- parallel:
70
- matrix:
71
- - NODE_VERSION: ['18', '20', '22']
72
- script:
73
- - npm ci
74
- - npm test
75
- - npm run test:coverage
76
- ```
77
-
78
- ### 4. E2E Stage (Slow - < 30 minutes)
79
-
80
- **Purpose**: Verify end-to-end functionality
81
-
82
- **Includes**:
83
- - E2E tests
84
- - Visual regression tests
85
- - Performance tests
86
- - Smoke tests
87
-
88
- **Example**:
89
- ```yaml
90
- e2e:
91
- script:
92
- - npm run test:e2e
93
- artifacts:
94
- when: on_failure
95
- paths:
96
- - test-results/
97
- - screenshots/
98
- ```
99
-
100
- ### 5. Release Stage (Conditional)
101
-
102
- **Purpose**: Publish packages and create releases
103
-
104
- **Includes**:
105
- - Version bumping
106
- - Changelog generation
107
- - Package publishing
108
- - GitHub release creation
109
-
110
- **Example**:
111
- ```yaml
112
- release:
113
- only:
114
- - tags
115
- script:
116
- - npm run build
117
- - npm publish --access public
118
- ```
119
-
120
- ### 6. Deploy Stage (Conditional)
121
-
122
- **Purpose**: Deploy to environments
123
-
124
- **Includes**:
125
- - Environment-specific deployments
126
- - Database migrations
127
- - Health checks
128
- - Rollback capabilities
129
-
130
- **Example**:
131
- ```yaml
132
- deploy:production:
133
- only:
134
- - main
135
- environment:
136
- name: production
137
- url: https://example.com
138
- script:
139
- - deploy.sh production
140
- when: manual # Require manual approval
141
- ```
142
-
143
- ## CI/CD Pipeline Patterns
144
-
145
- ### Pattern 1: Linear Pipeline (Simple Projects)
146
-
147
- ```
148
- ┌─────────┐ ┌───────┐ ┌──────┐ ┌────────┐
149
- │ Validate│───▶│ Build │───▶│ Test │───▶│ Deploy │
150
- └─────────┘ └───────┘ └──────┘ └────────┘
151
- ```
152
-
153
- **When to use**: Small projects, single environment, simple workflows
154
-
155
- **Example** (GitHub Actions):
156
- ```yaml
157
- jobs:
158
- validate:
159
- runs-on: ubuntu-latest
160
- steps:
161
- - run: npm run lint
162
-
163
- build:
164
- needs: validate
165
- steps:
166
- - run: npm run build
167
-
168
- test:
169
- needs: build
170
- steps:
171
- - run: npm test
172
-
173
- deploy:
174
- needs: test
175
- if: github.ref == 'refs/heads/main'
176
- steps:
177
- - run: deploy.sh
178
- ```
179
-
180
- ### Pattern 2: Fan-Out/Fan-In (Parallel Testing)
181
-
182
- ```
183
- ┌──────────┐
184
- │ Validate │
185
- └────┬─────┘
186
-
187
- ┌────────────┼────────────┐
188
- ▼ ▼ ▼
189
- ┌────────┐ ┌────────┐ ┌────────┐
190
- │ Test 18│ │ Test 20│ │ Test 22│
191
- └────┬───┘ └────┬───┘ └────┬───┘
192
- └────────────┼────────────┘
193
-
194
- ┌────────┐
195
- │ Deploy │
196
- └────────┘
197
- ```
198
-
199
- **When to use**: Multi-version testing, cross-platform builds
200
-
201
- **Example**:
202
- ```yaml
203
- test:
204
- strategy:
205
- matrix:
206
- node-version: ['18', '20', '22']
207
- os: [ubuntu-latest, windows-latest, macos-latest]
208
- steps:
209
- - uses: actions/setup-node@v4
210
- with:
211
- node-version: ${{ matrix.node-version }}
212
- - run: npm test
213
-
214
- deploy:
215
- needs: test # Waits for ALL test jobs
216
- steps:
217
- - run: deploy.sh
218
- ```
219
-
220
- ### Pattern 3: Multi-Environment Pipeline
221
-
222
- ```
223
- ┌──────┐ ┌────┐ ┌──────────┐ ┌────────────┐ ┌────────────┐
224
- │ Test │──▶│Push│──▶│Deploy Dev│──▶│Deploy Stage│──▶│Deploy Prod │
225
- └──────┘ └────┘ └──────────┘ └────────────┘ └────────────┘
226
- (auto) (auto) (manual)
227
- ```
228
-
229
- **When to use**: Production applications, multiple environments
230
-
231
- **Example**:
232
- ```yaml
233
- deploy:dev:
234
- environment: development
235
- only:
236
- - develop
237
- script:
238
- - deploy.sh dev
239
-
240
- deploy:staging:
241
- environment: staging
242
- only:
243
- - main
244
- script:
245
- - deploy.sh staging
246
-
247
- deploy:production:
248
- environment: production
249
- only:
250
- - tags
251
- when: manual # Manual approval required
252
- script:
253
- - deploy.sh production
254
- ```
255
-
256
- ### Pattern 4: Trunk-Based Deployment
257
-
258
- ```
259
- feature/123 ──▶ main ──▶ Deploy (with feature flags)
260
-
261
- └──▶ Rollback if issues
262
- ```
263
-
264
- **When to use**: High-velocity teams, continuous deployment
265
-
266
- **Key Principles**:
267
- - Deploy to production on every merge to main
268
- - Use feature flags for incomplete features
269
- - Monitor and rollback quickly if issues
270
- - Small, frequent deployments
271
-
272
- **Example**:
273
- ```yaml
274
- deploy:
275
- only:
276
- - main
277
- script:
278
- # Deploy with feature flags
279
- - export FEATURE_NEW_UI=false
280
- - deploy.sh production
281
- # Monitor for 5 minutes
282
- - monitor.sh 300
283
- # Rollback if errors detected
284
- - rollback-if-errors.sh
285
- ```
286
-
287
- ## Quality Gates
288
-
289
- ### Gate 1: Pre-Merge Checks (Required)
290
-
291
- **Enforce on Pull Requests**:
292
- - ✅ All tests pass
293
- - ✅ Code coverage ≥ 95%
294
- - ✅ Linting passes (no warnings)
295
- - ✅ Build succeeds
296
- - ✅ No security vulnerabilities
297
-
298
- **Implementation**:
299
- ```yaml
300
- # GitHub Actions - Require status checks
301
- # Settings → Branches → Branch protection rules
302
- # ✓ Require status checks to pass before merging
303
- # ✓ lint
304
- # ✓ test
305
- # ✓ build
306
- ```
307
-
308
- ### Gate 2: Pre-Deploy Checks (Production)
309
-
310
- **Required Before Production Deploy**:
311
- - ✅ All quality gates passed
312
- - ✅ Manual approval obtained
313
- - ✅ Staging tests passed
314
- - ✅ Security scan completed
315
- - ✅ Documentation updated
316
-
317
- **Implementation**:
318
- ```yaml
319
- deploy:production:
320
- needs: [test, security-scan, docs-check]
321
- environment:
322
- name: production
323
- url: https://example.com
324
- when: manual # Require manual approval
325
- ```
326
-
327
- ### Gate 3: Post-Deploy Validation
328
-
329
- **After Deployment**:
330
- - ✅ Health check passes
331
- - ✅ Smoke tests pass
332
- - ✅ Metrics within thresholds
333
- - ✅ No error rate increase
334
-
335
- **Implementation**:
336
- ```yaml
337
- deploy:production:
338
- script:
339
- - deploy.sh production
340
- - |
341
- # Wait for health check
342
- for i in {1..30}; do
343
- if curl -f https://example.com/health; then
344
- echo "Health check passed"
345
- exit 0
346
- fi
347
- sleep 10
348
- done
349
- echo "Health check failed"
350
- rollback.sh
351
- exit 1
352
- ```
353
-
354
- ## Caching Strategies
355
-
356
- ### Dependency Caching (Essential)
357
-
358
- **Pattern**: Cache dependencies based on lock file hash
359
-
360
- ```yaml
361
- # npm
362
- cache:
363
- key: ${{ hashFiles('package-lock.json') }}
364
- paths:
365
- - node_modules/
366
-
367
- # pip
368
- cache:
369
- key: ${{ hashFiles('requirements.txt') }}
370
- paths:
371
- - .venv/
372
-
373
- # cargo
374
- cache:
375
- key: ${{ hashFiles('Cargo.lock') }}
376
- paths:
377
- - target/
378
- - ~/.cargo/
379
- ```
380
-
381
- ### Build Artifact Caching
382
-
383
- **Pattern**: Cache build outputs to avoid rebuilding
384
-
385
- ```yaml
386
- cache:
387
- key: build-${{ github.sha }}
388
- paths:
389
- - dist/
390
- - .cache/
391
- ```
392
-
393
- ### Incremental Builds
394
-
395
- **Pattern**: Cache intermediate build artifacts
396
-
397
- ```yaml
398
- # TypeScript incremental builds
399
- cache:
400
- key: tsbuildinfo-${{ hashFiles('**/*.ts') }}
401
- paths:
402
- - tsconfig.tsbuildinfo
403
-
404
- # Rust incremental builds
405
- cache:
406
- key: rust-incremental-${{ hashFiles('**/*.rs') }}
407
- paths:
408
- - target/debug/incremental/
409
- ```
410
-
411
- ## Parallelization Strategies
412
-
413
- ### 1. Job-Level Parallelization
414
-
415
- **Run independent jobs simultaneously**:
416
- ```yaml
417
- jobs:
418
- lint:
419
- # Runs immediately
420
- test:
421
- # Runs immediately (parallel with lint)
422
- build:
423
- needs: [lint, test] # Waits for both
424
- ```
425
-
426
- ### 2. Matrix Parallelization
427
-
428
- **Test multiple configurations in parallel**:
429
- ```yaml
430
- test:
431
- strategy:
432
- matrix:
433
- node: ['18', '20', '22']
434
- os: [ubuntu, windows, macos]
435
- # Runs 9 jobs in parallel (3 × 3)
436
- ```
437
-
438
- ### 3. Test Sharding
439
-
440
- **Split tests across multiple runners**:
441
- ```yaml
442
- test:
443
- strategy:
444
- matrix:
445
- shard: [1, 2, 3, 4]
446
- script:
447
- - npm test -- --shard=${{ matrix.shard }}/4
448
- ```
449
-
450
- ### 4. Conditional Parallelization
451
-
452
- **Only parallelize when needed**:
453
- ```yaml
454
- test:
455
- strategy:
456
- matrix:
457
- # Only test multiple versions on main branch
458
- node: ${{ github.ref == 'refs/heads/main' && ['18', '20', '22'] || ['20'] }}
459
- ```
460
-
461
- ## Optimization Patterns
462
-
463
- ### Pattern 1: Fail Fast
464
-
465
- **Stop pipeline immediately on critical failures**:
466
- ```yaml
467
- strategy:
468
- matrix:
469
- node: ['18', '20', '22']
470
- fail-fast: true # Stop all jobs if one fails
471
- ```
472
-
473
- ### Pattern 2: Skip Redundant Builds
474
-
475
- **Skip builds for docs-only changes**:
476
- ```yaml
477
- on:
478
- push:
479
- paths-ignore:
480
- - '**.md'
481
- - 'docs/**'
482
- ```
483
-
484
- ### Pattern 3: Smart Caching
485
-
486
- **Multi-level cache fallback**:
487
- ```yaml
488
- cache:
489
- key: ${{ runner.os }}-deps-${{ hashFiles('**/package-lock.json') }}
490
- restore-keys: |
491
- ${{ runner.os }}-deps-
492
- ${{ runner.os }}-
493
- ```
494
-
495
- ### Pattern 4: Artifact Reuse
496
-
497
- **Build once, test/deploy many times**:
498
- ```yaml
499
- build:
500
- script:
501
- - npm run build
502
- artifacts:
503
- paths: [dist/]
504
-
505
- test:
506
- needs: build
507
- script:
508
- - npm test # Uses dist/ from build
509
-
510
- deploy:
511
- needs: build
512
- script:
513
- - deploy dist/ # Uses same dist/
514
- ```
515
-
516
- ## Monitoring and Observability
517
-
518
- ### Pipeline Metrics to Track
519
-
520
- 1. **Pipeline Duration**
521
- - Target: < 10 minutes for CI
522
- - Track: P50, P95, P99
523
-
524
- 2. **Failure Rate**
525
- - Target: < 5% false positives
526
- - Track: Flaky tests, infrastructure failures
527
-
528
- 3. **Deploy Frequency**
529
- - Target: Multiple times per day (high-velocity)
530
- - Track: Deploys per day/week
531
-
532
- 4. **Mean Time to Recovery (MTTR)**
533
- - Target: < 1 hour
534
- - Track: Time from incident to fix deployed
535
-
536
- ### Notification Patterns
537
-
538
- **Slack/Discord Notifications**:
539
- ```yaml
540
- notify:
541
- script:
542
- - |
543
- curl -X POST $SLACK_WEBHOOK_URL \
544
- -H 'Content-Type: application/json' \
545
- -d '{
546
- "text": "Pipeline failed: ${{ job.name }}",
547
- "channel": "#ci-alerts"
548
- }'
549
- when: on_failure
550
- ```
551
-
552
- ## Security Patterns
553
-
554
- ### Pattern 1: Secrets Rotation
555
-
556
- **Rotate secrets regularly**:
557
- - API keys: Every 90 days
558
- - Deploy keys: Every 180 days
559
- - Service account tokens: Every 90 days
560
-
561
- ### Pattern 2: Least Privilege
562
-
563
- **Grant minimal permissions**:
564
- ```yaml
565
- permissions:
566
- contents: read # Read-only by default
567
- pull-requests: write # Only if needed
568
- ```
569
-
570
- ### Pattern 3: Dependency Scanning
571
-
572
- **Scan dependencies for vulnerabilities**:
573
- ```yaml
574
- security:
575
- script:
576
- - npm audit --audit-level=high
577
- - snyk test --severity-threshold=high
578
- ```
579
-
580
- ### Pattern 4: SBOM Generation
581
-
582
- **Generate Software Bill of Materials**:
583
- ```yaml
584
- sbom:
585
- script:
586
- - cyclonedx-bom -o sbom.json
587
- artifacts:
588
- paths: [sbom.json]
589
- ```
590
-
591
- ## Rollback Strategies
592
-
593
- ### Pattern 1: Blue-Green Deployment
594
-
595
- ```yaml
596
- deploy:
597
- script:
598
- # Deploy to green (inactive) environment
599
- - deploy.sh green
600
- # Run smoke tests
601
- - test-green.sh
602
- # Switch traffic to green
603
- - switch-traffic.sh green
604
- # Keep blue for rollback
605
- ```
606
-
607
- ### Pattern 2: Canary Deployment
608
-
609
- ```yaml
610
- deploy:
611
- script:
612
- # Deploy to 5% of servers
613
- - deploy.sh --canary 5
614
- # Monitor for 10 minutes
615
- - monitor.sh 600
616
- # If OK, deploy to 100%
617
- - deploy.sh --all
618
- ```
619
-
620
- ### Pattern 3: Feature Flags
621
-
622
- ```yaml
623
- deploy:
624
- script:
625
- # Deploy with new feature disabled
626
- - export FEATURE_ENABLED=false
627
- - deploy.sh
628
- # Enable for 10% of users
629
- - feature-flag.sh new-feature 10
630
- ```
631
-
632
- ## Common Pitfalls
633
-
634
- 1. **❌ No caching**: Slow pipelines
635
- 2. **❌ Sequential testing**: Wasted time
636
- 3. **❌ No fail-fast**: Long feedback loops
637
- 4. **❌ Rebuilding artifacts**: Inefficient
638
- 5. **❌ No quality gates**: Poor code quality
639
- 6. **❌ Manual deployments**: Slow releases
640
- 7. **❌ No rollback plan**: Risky deployments
641
-
642
- ## Integration with Rulebook
643
-
644
- If using `@hivehub/rulebook`, CI/CD patterns are enforced automatically:
645
-
646
- ```bash
647
- # Generate CI/CD workflows
648
- npx @hivehub/rulebook workflows
649
-
650
- # Validates against best practices:
651
- # - Caching enabled
652
- # - Parallel testing
653
- # - Quality gates configured
654
- ```
655
-
656
- ## Related Templates
657
-
658
- - See `/.rulebook/specs/GITHUB_ACTIONS.md` for GitHub Actions specifics
659
- - See `/.rulebook/specs/GITLAB_CI.md` for GitLab CI specifics
660
- - See `/.rulebook/specs/SECRETS_MANAGEMENT.md` for secrets handling
661
- - See `/.rulebook/specs/QUALITY_ENFORCEMENT.md` for quality standards
1
+ # CI/CD Patterns
2
+
3
+ This template provides common CI/CD patterns and best practices applicable across all CI/CD platforms (GitHub Actions, GitLab CI, CircleCI, Jenkins, etc.).
4
+
5
+ ## Purpose
6
+
7
+ CI/CD patterns ensure:
8
+ - Consistent build/test/deploy processes
9
+ - Fast feedback loops
10
+ - Reliable deployments
11
+ - Quality gates enforcement
12
+ - Automated release management
13
+
14
+ ## Core CI/CD Stages
15
+
16
+ ### 1. Validate Stage (Fastest - < 2 minutes)
17
+
18
+ **Purpose**: Catch syntax errors and basic issues quickly
19
+
20
+ **Includes**:
21
+ - Linting
22
+ - Code formatting check
23
+ - Type checking
24
+ - Basic syntax validation
25
+
26
+ **Example**:
27
+ ```yaml
28
+ validate:
29
+ script:
30
+ - npm run lint
31
+ - npm run format:check
32
+ - npm run type-check
33
+ ```
34
+
35
+ ### 2. Build Stage (Fast - < 5 minutes)
36
+
37
+ **Purpose**: Verify code compiles/builds successfully
38
+
39
+ **Includes**:
40
+ - Compilation
41
+ - Bundling
42
+ - Asset generation
43
+ - Build artifact creation
44
+
45
+ **Example**:
46
+ ```yaml
47
+ build:
48
+ script:
49
+ - npm run build
50
+ artifacts:
51
+ paths:
52
+ - dist/
53
+ expire_in: 7 days
54
+ ```
55
+
56
+ ### 3. Test Stage (Medium - < 15 minutes)
57
+
58
+ **Purpose**: Verify functionality and quality
59
+
60
+ **Includes**:
61
+ - Unit tests
62
+ - Integration tests
63
+ - Coverage reporting
64
+ - Security scanning
65
+
66
+ **Example**:
67
+ ```yaml
68
+ test:
69
+ parallel:
70
+ matrix:
71
+ - NODE_VERSION: ['18', '20', '22']
72
+ script:
73
+ - npm ci
74
+ - npm test
75
+ - npm run test:coverage
76
+ ```
77
+
78
+ ### 4. E2E Stage (Slow - < 30 minutes)
79
+
80
+ **Purpose**: Verify end-to-end functionality
81
+
82
+ **Includes**:
83
+ - E2E tests
84
+ - Visual regression tests
85
+ - Performance tests
86
+ - Smoke tests
87
+
88
+ **Example**:
89
+ ```yaml
90
+ e2e:
91
+ script:
92
+ - npm run test:e2e
93
+ artifacts:
94
+ when: on_failure
95
+ paths:
96
+ - test-results/
97
+ - screenshots/
98
+ ```
99
+
100
+ ### 5. Release Stage (Conditional)
101
+
102
+ **Purpose**: Publish packages and create releases
103
+
104
+ **Includes**:
105
+ - Version bumping
106
+ - Changelog generation
107
+ - Package publishing
108
+ - GitHub release creation
109
+
110
+ **Example**:
111
+ ```yaml
112
+ release:
113
+ only:
114
+ - tags
115
+ script:
116
+ - npm run build
117
+ - npm publish --access public
118
+ ```
119
+
120
+ ### 6. Deploy Stage (Conditional)
121
+
122
+ **Purpose**: Deploy to environments
123
+
124
+ **Includes**:
125
+ - Environment-specific deployments
126
+ - Database migrations
127
+ - Health checks
128
+ - Rollback capabilities
129
+
130
+ **Example**:
131
+ ```yaml
132
+ deploy:production:
133
+ only:
134
+ - main
135
+ environment:
136
+ name: production
137
+ url: https://example.com
138
+ script:
139
+ - deploy.sh production
140
+ when: manual # Require manual approval
141
+ ```
142
+
143
+ ## CI/CD Pipeline Patterns
144
+
145
+ ### Pattern 1: Linear Pipeline (Simple Projects)
146
+
147
+ ```
148
+ ┌─────────┐ ┌───────┐ ┌──────┐ ┌────────┐
149
+ │ Validate│───▶│ Build │───▶│ Test │───▶│ Deploy │
150
+ └─────────┘ └───────┘ └──────┘ └────────┘
151
+ ```
152
+
153
+ **When to use**: Small projects, single environment, simple workflows
154
+
155
+ **Example** (GitHub Actions):
156
+ ```yaml
157
+ jobs:
158
+ validate:
159
+ runs-on: ubuntu-latest
160
+ steps:
161
+ - run: npm run lint
162
+
163
+ build:
164
+ needs: validate
165
+ steps:
166
+ - run: npm run build
167
+
168
+ test:
169
+ needs: build
170
+ steps:
171
+ - run: npm test
172
+
173
+ deploy:
174
+ needs: test
175
+ if: github.ref == 'refs/heads/main'
176
+ steps:
177
+ - run: deploy.sh
178
+ ```
179
+
180
+ ### Pattern 2: Fan-Out/Fan-In (Parallel Testing)
181
+
182
+ ```
183
+ ┌──────────┐
184
+ │ Validate │
185
+ └────┬─────┘
186
+
187
+ ┌────────────┼────────────┐
188
+ ▼ ▼ ▼
189
+ ┌────────┐ ┌────────┐ ┌────────┐
190
+ │ Test 18│ │ Test 20│ │ Test 22│
191
+ └────┬───┘ └────┬───┘ └────┬───┘
192
+ └────────────┼────────────┘
193
+
194
+ ┌────────┐
195
+ │ Deploy │
196
+ └────────┘
197
+ ```
198
+
199
+ **When to use**: Multi-version testing, cross-platform builds
200
+
201
+ **Example**:
202
+ ```yaml
203
+ test:
204
+ strategy:
205
+ matrix:
206
+ node-version: ['18', '20', '22']
207
+ os: [ubuntu-latest, windows-latest, macos-latest]
208
+ steps:
209
+ - uses: actions/setup-node@v4
210
+ with:
211
+ node-version: ${{ matrix.node-version }}
212
+ - run: npm test
213
+
214
+ deploy:
215
+ needs: test # Waits for ALL test jobs
216
+ steps:
217
+ - run: deploy.sh
218
+ ```
219
+
220
+ ### Pattern 3: Multi-Environment Pipeline
221
+
222
+ ```
223
+ ┌──────┐ ┌────┐ ┌──────────┐ ┌────────────┐ ┌────────────┐
224
+ │ Test │──▶│Push│──▶│Deploy Dev│──▶│Deploy Stage│──▶│Deploy Prod │
225
+ └──────┘ └────┘ └──────────┘ └────────────┘ └────────────┘
226
+ (auto) (auto) (manual)
227
+ ```
228
+
229
+ **When to use**: Production applications, multiple environments
230
+
231
+ **Example**:
232
+ ```yaml
233
+ deploy:dev:
234
+ environment: development
235
+ only:
236
+ - develop
237
+ script:
238
+ - deploy.sh dev
239
+
240
+ deploy:staging:
241
+ environment: staging
242
+ only:
243
+ - main
244
+ script:
245
+ - deploy.sh staging
246
+
247
+ deploy:production:
248
+ environment: production
249
+ only:
250
+ - tags
251
+ when: manual # Manual approval required
252
+ script:
253
+ - deploy.sh production
254
+ ```
255
+
256
+ ### Pattern 4: Trunk-Based Deployment
257
+
258
+ ```
259
+ feature/123 ──▶ main ──▶ Deploy (with feature flags)
260
+
261
+ └──▶ Rollback if issues
262
+ ```
263
+
264
+ **When to use**: High-velocity teams, continuous deployment
265
+
266
+ **Key Principles**:
267
+ - Deploy to production on every merge to main
268
+ - Use feature flags for incomplete features
269
+ - Monitor and rollback quickly if issues
270
+ - Small, frequent deployments
271
+
272
+ **Example**:
273
+ ```yaml
274
+ deploy:
275
+ only:
276
+ - main
277
+ script:
278
+ # Deploy with feature flags
279
+ - export FEATURE_NEW_UI=false
280
+ - deploy.sh production
281
+ # Monitor for 5 minutes
282
+ - monitor.sh 300
283
+ # Rollback if errors detected
284
+ - rollback-if-errors.sh
285
+ ```
286
+
287
+ ## Quality Gates
288
+
289
+ ### Gate 1: Pre-Merge Checks (Required)
290
+
291
+ **Enforce on Pull Requests**:
292
+ - ✅ All tests pass
293
+ - ✅ Code coverage ≥ 95%
294
+ - ✅ Linting passes (no warnings)
295
+ - ✅ Build succeeds
296
+ - ✅ No security vulnerabilities
297
+
298
+ **Implementation**:
299
+ ```yaml
300
+ # GitHub Actions - Require status checks
301
+ # Settings → Branches → Branch protection rules
302
+ # ✓ Require status checks to pass before merging
303
+ # ✓ lint
304
+ # ✓ test
305
+ # ✓ build
306
+ ```
307
+
308
+ ### Gate 2: Pre-Deploy Checks (Production)
309
+
310
+ **Required Before Production Deploy**:
311
+ - ✅ All quality gates passed
312
+ - ✅ Manual approval obtained
313
+ - ✅ Staging tests passed
314
+ - ✅ Security scan completed
315
+ - ✅ Documentation updated
316
+
317
+ **Implementation**:
318
+ ```yaml
319
+ deploy:production:
320
+ needs: [test, security-scan, docs-check]
321
+ environment:
322
+ name: production
323
+ url: https://example.com
324
+ when: manual # Require manual approval
325
+ ```
326
+
327
+ ### Gate 3: Post-Deploy Validation
328
+
329
+ **After Deployment**:
330
+ - ✅ Health check passes
331
+ - ✅ Smoke tests pass
332
+ - ✅ Metrics within thresholds
333
+ - ✅ No error rate increase
334
+
335
+ **Implementation**:
336
+ ```yaml
337
+ deploy:production:
338
+ script:
339
+ - deploy.sh production
340
+ - |
341
+ # Wait for health check
342
+ for i in {1..30}; do
343
+ if curl -f https://example.com/health; then
344
+ echo "Health check passed"
345
+ exit 0
346
+ fi
347
+ sleep 10
348
+ done
349
+ echo "Health check failed"
350
+ rollback.sh
351
+ exit 1
352
+ ```
353
+
354
+ ## Caching Strategies
355
+
356
+ ### Dependency Caching (Essential)
357
+
358
+ **Pattern**: Cache dependencies based on lock file hash
359
+
360
+ ```yaml
361
+ # npm
362
+ cache:
363
+ key: ${{ hashFiles('package-lock.json') }}
364
+ paths:
365
+ - node_modules/
366
+
367
+ # pip
368
+ cache:
369
+ key: ${{ hashFiles('requirements.txt') }}
370
+ paths:
371
+ - .venv/
372
+
373
+ # cargo
374
+ cache:
375
+ key: ${{ hashFiles('Cargo.lock') }}
376
+ paths:
377
+ - target/
378
+ - ~/.cargo/
379
+ ```
380
+
381
+ ### Build Artifact Caching
382
+
383
+ **Pattern**: Cache build outputs to avoid rebuilding
384
+
385
+ ```yaml
386
+ cache:
387
+ key: build-${{ github.sha }}
388
+ paths:
389
+ - dist/
390
+ - .cache/
391
+ ```
392
+
393
+ ### Incremental Builds
394
+
395
+ **Pattern**: Cache intermediate build artifacts
396
+
397
+ ```yaml
398
+ # TypeScript incremental builds
399
+ cache:
400
+ key: tsbuildinfo-${{ hashFiles('**/*.ts') }}
401
+ paths:
402
+ - tsconfig.tsbuildinfo
403
+
404
+ # Rust incremental builds
405
+ cache:
406
+ key: rust-incremental-${{ hashFiles('**/*.rs') }}
407
+ paths:
408
+ - target/debug/incremental/
409
+ ```
410
+
411
+ ## Parallelization Strategies
412
+
413
+ ### 1. Job-Level Parallelization
414
+
415
+ **Run independent jobs simultaneously**:
416
+ ```yaml
417
+ jobs:
418
+ lint:
419
+ # Runs immediately
420
+ test:
421
+ # Runs immediately (parallel with lint)
422
+ build:
423
+ needs: [lint, test] # Waits for both
424
+ ```
425
+
426
+ ### 2. Matrix Parallelization
427
+
428
+ **Test multiple configurations in parallel**:
429
+ ```yaml
430
+ test:
431
+ strategy:
432
+ matrix:
433
+ node: ['18', '20', '22']
434
+ os: [ubuntu, windows, macos]
435
+ # Runs 9 jobs in parallel (3 × 3)
436
+ ```
437
+
438
+ ### 3. Test Sharding
439
+
440
+ **Split tests across multiple runners**:
441
+ ```yaml
442
+ test:
443
+ strategy:
444
+ matrix:
445
+ shard: [1, 2, 3, 4]
446
+ script:
447
+ - npm test -- --shard=${{ matrix.shard }}/4
448
+ ```
449
+
450
+ ### 4. Conditional Parallelization
451
+
452
+ **Only parallelize when needed**:
453
+ ```yaml
454
+ test:
455
+ strategy:
456
+ matrix:
457
+ # Only test multiple versions on main branch
458
+ node: ${{ github.ref == 'refs/heads/main' && ['18', '20', '22'] || ['20'] }}
459
+ ```
460
+
461
+ ## Optimization Patterns
462
+
463
+ ### Pattern 1: Fail Fast
464
+
465
+ **Stop pipeline immediately on critical failures**:
466
+ ```yaml
467
+ strategy:
468
+ matrix:
469
+ node: ['18', '20', '22']
470
+ fail-fast: true # Stop all jobs if one fails
471
+ ```
472
+
473
+ ### Pattern 2: Skip Redundant Builds
474
+
475
+ **Skip builds for docs-only changes**:
476
+ ```yaml
477
+ on:
478
+ push:
479
+ paths-ignore:
480
+ - '**.md'
481
+ - 'docs/**'
482
+ ```
483
+
484
+ ### Pattern 3: Smart Caching
485
+
486
+ **Multi-level cache fallback**:
487
+ ```yaml
488
+ cache:
489
+ key: ${{ runner.os }}-deps-${{ hashFiles('**/package-lock.json') }}
490
+ restore-keys: |
491
+ ${{ runner.os }}-deps-
492
+ ${{ runner.os }}-
493
+ ```
494
+
495
+ ### Pattern 4: Artifact Reuse
496
+
497
+ **Build once, test/deploy many times**:
498
+ ```yaml
499
+ build:
500
+ script:
501
+ - npm run build
502
+ artifacts:
503
+ paths: [dist/]
504
+
505
+ test:
506
+ needs: build
507
+ script:
508
+ - npm test # Uses dist/ from build
509
+
510
+ deploy:
511
+ needs: build
512
+ script:
513
+ - deploy dist/ # Uses same dist/
514
+ ```
515
+
516
+ ## Monitoring and Observability
517
+
518
+ ### Pipeline Metrics to Track
519
+
520
+ 1. **Pipeline Duration**
521
+ - Target: < 10 minutes for CI
522
+ - Track: P50, P95, P99
523
+
524
+ 2. **Failure Rate**
525
+ - Target: < 5% false positives
526
+ - Track: Flaky tests, infrastructure failures
527
+
528
+ 3. **Deploy Frequency**
529
+ - Target: Multiple times per day (high-velocity)
530
+ - Track: Deploys per day/week
531
+
532
+ 4. **Mean Time to Recovery (MTTR)**
533
+ - Target: < 1 hour
534
+ - Track: Time from incident to fix deployed
535
+
536
+ ### Notification Patterns
537
+
538
+ **Slack/Discord Notifications**:
539
+ ```yaml
540
+ notify:
541
+ script:
542
+ - |
543
+ curl -X POST $SLACK_WEBHOOK_URL \
544
+ -H 'Content-Type: application/json' \
545
+ -d '{
546
+ "text": "Pipeline failed: ${{ job.name }}",
547
+ "channel": "#ci-alerts"
548
+ }'
549
+ when: on_failure
550
+ ```
551
+
552
+ ## Security Patterns
553
+
554
+ ### Pattern 1: Secrets Rotation
555
+
556
+ **Rotate secrets regularly**:
557
+ - API keys: Every 90 days
558
+ - Deploy keys: Every 180 days
559
+ - Service account tokens: Every 90 days
560
+
561
+ ### Pattern 2: Least Privilege
562
+
563
+ **Grant minimal permissions**:
564
+ ```yaml
565
+ permissions:
566
+ contents: read # Read-only by default
567
+ pull-requests: write # Only if needed
568
+ ```
569
+
570
+ ### Pattern 3: Dependency Scanning
571
+
572
+ **Scan dependencies for vulnerabilities**:
573
+ ```yaml
574
+ security:
575
+ script:
576
+ - npm audit --audit-level=high
577
+ - snyk test --severity-threshold=high
578
+ ```
579
+
580
+ ### Pattern 4: SBOM Generation
581
+
582
+ **Generate Software Bill of Materials**:
583
+ ```yaml
584
+ sbom:
585
+ script:
586
+ - cyclonedx-bom -o sbom.json
587
+ artifacts:
588
+ paths: [sbom.json]
589
+ ```
590
+
591
+ ## Rollback Strategies
592
+
593
+ ### Pattern 1: Blue-Green Deployment
594
+
595
+ ```yaml
596
+ deploy:
597
+ script:
598
+ # Deploy to green (inactive) environment
599
+ - deploy.sh green
600
+ # Run smoke tests
601
+ - test-green.sh
602
+ # Switch traffic to green
603
+ - switch-traffic.sh green
604
+ # Keep blue for rollback
605
+ ```
606
+
607
+ ### Pattern 2: Canary Deployment
608
+
609
+ ```yaml
610
+ deploy:
611
+ script:
612
+ # Deploy to 5% of servers
613
+ - deploy.sh --canary 5
614
+ # Monitor for 10 minutes
615
+ - monitor.sh 600
616
+ # If OK, deploy to 100%
617
+ - deploy.sh --all
618
+ ```
619
+
620
+ ### Pattern 3: Feature Flags
621
+
622
+ ```yaml
623
+ deploy:
624
+ script:
625
+ # Deploy with new feature disabled
626
+ - export FEATURE_ENABLED=false
627
+ - deploy.sh
628
+ # Enable for 10% of users
629
+ - feature-flag.sh new-feature 10
630
+ ```
631
+
632
+ ## Common Pitfalls
633
+
634
+ 1. **❌ No caching**: Slow pipelines
635
+ 2. **❌ Sequential testing**: Wasted time
636
+ 3. **❌ No fail-fast**: Long feedback loops
637
+ 4. **❌ Rebuilding artifacts**: Inefficient
638
+ 5. **❌ No quality gates**: Poor code quality
639
+ 6. **❌ Manual deployments**: Slow releases
640
+ 7. **❌ No rollback plan**: Risky deployments
641
+
642
+ ## Integration with Rulebook
643
+
644
+ If using `@hivehub/rulebook`, CI/CD patterns are enforced automatically:
645
+
646
+ ```bash
647
+ # Generate CI/CD workflows
648
+ npx @hivehub/rulebook workflows
649
+
650
+ # Validates against best practices:
651
+ # - Caching enabled
652
+ # - Parallel testing
653
+ # - Quality gates configured
654
+ ```
655
+
656
+ ## Related Templates
657
+
658
+ - See `/.rulebook/specs/GITHUB_ACTIONS.md` for GitHub Actions specifics
659
+ - See `/.rulebook/specs/GITLAB_CI.md` for GitLab CI specifics
660
+ - See `/.rulebook/specs/SECRETS_MANAGEMENT.md` for secrets handling
661
+ - See `/.rulebook/specs/QUALITY_ENFORCEMENT.md` for quality standards