skillfullstack 0.0.0-stage → 1.0.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 (775) hide show
  1. package/.skillsRegistry/catalog.json +231 -0
  2. package/AGENTS.md +89 -0
  3. package/README.md +210 -2
  4. package/bin/index.js +508 -0
  5. package/package.json +57 -4
  6. package/skills/backend/apiEngineering/SKILL.md +102 -0
  7. package/skills/backend/apiEngineering/evals/evalApiEngineering.py +81 -0
  8. package/skills/backend/apiEngineering/evals/fixtures/invalid/sampleInvalidOpenApi.json +40 -0
  9. package/skills/backend/apiEngineering/evals/fixtures/valid/sampleValidOpenApi.json +47 -0
  10. package/skills/backend/apiEngineering/policies/compatibility.md +42 -0
  11. package/skills/backend/apiEngineering/policies/mandatory.md +48 -0
  12. package/skills/backend/apiEngineering/policies/performance.md +39 -0
  13. package/skills/backend/apiEngineering/policies/security.md +36 -0
  14. package/skills/backend/apiEngineering/references/apiObservability.md +39 -0
  15. package/skills/backend/apiEngineering/references/apiReference.md +3 -0
  16. package/skills/backend/apiEngineering/references/apiSecurityOwasp.md +47 -0
  17. package/skills/backend/apiEngineering/references/contractCompatibility.md +26 -0
  18. package/skills/backend/apiEngineering/references/databaseTransactions.md +40 -0
  19. package/skills/backend/apiEngineering/references/distributedReliability.md +26 -0
  20. package/skills/backend/apiEngineering/references/multiTenancy.md +27 -0
  21. package/skills/backend/apiEngineering/references/openApi32Standards.md +58 -0
  22. package/skills/backend/apiEngineering/references/paginationVersioning.md +57 -0
  23. package/skills/backend/apiEngineering/references/responseStandards.md +94 -0
  24. package/skills/backend/apiEngineering/scripts/auditApiContract.py +123 -0
  25. package/skills/backend/apiEngineering/scripts/checkBreakingChanges.py +77 -0
  26. package/skills/backend/apiEngineering/scripts/generateResponseEnvelope.py +88 -0
  27. package/skills/backend/apiEngineering/templates/apiChecklist.md +27 -0
  28. package/skills/backend/apiEngineering/templates/openapi.yaml +125 -0
  29. package/skills/backend/apiEngineering/templates/problemDetails.json +44 -0
  30. package/skills/backend/databaseArchitecture/SKILL.md +118 -0
  31. package/skills/backend/databaseArchitecture/evals/evalDatabaseArchitecture.py +85 -0
  32. package/skills/backend/databaseArchitecture/evals/fixtures/dangerousMigration.sql +4 -0
  33. package/skills/backend/databaseArchitecture/evals/fixtures/invalidSchema.sql +23 -0
  34. package/skills/backend/databaseArchitecture/evals/fixtures/safeMigration.sql +3 -0
  35. package/skills/backend/databaseArchitecture/evals/fixtures/validSchema.sql +37 -0
  36. package/skills/backend/databaseArchitecture/policies/integrity.md +25 -0
  37. package/skills/backend/databaseArchitecture/policies/mandatory.md +32 -0
  38. package/skills/backend/databaseArchitecture/policies/migration.md +22 -0
  39. package/skills/backend/databaseArchitecture/policies/normalization.md +25 -0
  40. package/skills/backend/databaseArchitecture/policies/performance.md +26 -0
  41. package/skills/backend/databaseArchitecture/policies/recovery.md +23 -0
  42. package/skills/backend/databaseArchitecture/policies/security.md +26 -0
  43. package/skills/backend/databaseArchitecture/policies/tableCreationChecklist.md +70 -0
  44. package/skills/backend/databaseArchitecture/references/analyticsWarehousing.md +32 -0
  45. package/skills/backend/databaseArchitecture/references/apiReference.md +3 -0
  46. package/skills/backend/databaseArchitecture/references/backupDisasterRecovery.md +27 -0
  47. package/skills/backend/databaseArchitecture/references/dataModelingLifecycle.md +30 -0
  48. package/skills/backend/databaseArchitecture/references/databaseTaxonomy.md +32 -0
  49. package/skills/backend/databaseArchitecture/references/indexingOptimization.md +32 -0
  50. package/skills/backend/databaseArchitecture/references/normalizationTheory.md +61 -0
  51. package/skills/backend/databaseArchitecture/references/scalabilitySharding.md +37 -0
  52. package/skills/backend/databaseArchitecture/references/transactionConcurrency.md +39 -0
  53. package/skills/backend/databaseArchitecture/scripts/analyzeMigration.py +99 -0
  54. package/skills/backend/databaseArchitecture/scripts/auditDatabaseSchema.py +177 -0
  55. package/skills/backend/databaseArchitecture/scripts/inspectDatabaseIndexes.py +149 -0
  56. package/skills/backend/databaseArchitecture/templates/adrTemplate.md +32 -0
  57. package/skills/backend/databaseArchitecture/templates/databaseChecklist.md +29 -0
  58. package/skills/backend/databaseArchitecture/templates/migrationPlan.md +40 -0
  59. package/skills/backend/durableBackgroundJobs/SKILL.md +112 -0
  60. package/skills/backend/durableBackgroundJobs/evals/durableJobVerification.json +14 -0
  61. package/skills/backend/durableBackgroundJobs/references/apiReference.md +3 -0
  62. package/skills/backend/durableBackgroundJobs/references/durableStepPatterns.md +6 -0
  63. package/skills/backend/durableBackgroundJobs/references/idempotencyKeys.md +5 -0
  64. package/skills/backend/durableBackgroundJobs/scripts/testWorkflowDispatch.py +24 -0
  65. package/skills/backend/golangStandard/SKILL.md +155 -0
  66. package/skills/backend/golangStandard/evals/goVerification.json +14 -0
  67. package/skills/backend/golangStandard/references/apiReference.md +3 -0
  68. package/skills/backend/golangStandard/references/layoutGuide.md +26 -0
  69. package/skills/backend/golangStandard/references/slogPatterns.md +26 -0
  70. package/skills/backend/golangStandard/scripts/scaffoldGoModule.py +105 -0
  71. package/skills/backend/pythonStandard/SKILL.md +138 -0
  72. package/skills/backend/pythonStandard/evals/pythonVerification.json +14 -0
  73. package/skills/backend/pythonStandard/references/apiReference.md +3 -0
  74. package/skills/backend/pythonStandard/references/pydanticPatterns.md +16 -0
  75. package/skills/backend/pythonStandard/references/pyprojectSpecs.md +37 -0
  76. package/skills/backend/pythonStandard/scripts/scaffoldUvProject.py +79 -0
  77. package/skills/backend/upstash/SKILL.md +98 -0
  78. package/skills/backend/upstash/evals/upstashVerification.json +14 -0
  79. package/skills/backend/upstash/references/apiReference.md +3 -0
  80. package/skills/backend/upstash/references/qstashFlowControl.md +34 -0
  81. package/skills/backend/upstash/references/ratelimitPatterns.md +53 -0
  82. package/skills/backend/upstash/references/workflowPatterns.md +35 -0
  83. package/skills/backend/upstash/scripts/testRedisConnection.py +36 -0
  84. package/skills/cicdDevops/cicdPipeline/SKILL.md +148 -0
  85. package/skills/cicdDevops/cicdPipeline/evals/evalCicd.py +37 -0
  86. package/skills/cicdDevops/cicdPipeline/references/apiReference.md +3 -0
  87. package/skills/cicdDevops/cicdPipeline/references/cicdDeploymentPatterns.md +27 -0
  88. package/skills/cicdDevops/cicdPipeline/scripts/auditDockerfileSecurity.py +56 -0
  89. package/skills/dataAi/mcpServerDevelopment/SKILL.md +123 -0
  90. package/skills/dataAi/mcpServerDevelopment/evals/mcpVerification.json +14 -0
  91. package/skills/dataAi/mcpServerDevelopment/references/apiReference.md +3 -0
  92. package/skills/dataAi/mcpServerDevelopment/references/mcpClientConfigs.md +38 -0
  93. package/skills/dataAi/mcpServerDevelopment/references/toolSchemaDesign.md +6 -0
  94. package/skills/dataAi/mcpServerDevelopment/scripts/runFastMcpBoilerplate.py +36 -0
  95. package/skills/dataAi/ragPipelineProduction/SKILL.md +113 -0
  96. package/skills/dataAi/ragPipelineProduction/evals/ragVerification.json +14 -0
  97. package/skills/dataAi/ragPipelineProduction/references/apiReference.md +3 -0
  98. package/skills/dataAi/ragPipelineProduction/references/chunkingStrategies.md +10 -0
  99. package/skills/dataAi/ragPipelineProduction/references/rrfAlgorithm.md +13 -0
  100. package/skills/dataAi/ragPipelineProduction/scripts/runHybridRrfSearch.py +33 -0
  101. package/skills/devopsCloud/cloudflare/SKILL.md +282 -0
  102. package/skills/devopsCloud/cloudflare/assets/README.md +48 -0
  103. package/skills/devopsCloud/cloudflare/assets/ai/agents-sdk.md +118 -0
  104. package/skills/devopsCloud/cloudflare/assets/ai/ai-gateway.md +105 -0
  105. package/skills/devopsCloud/cloudflare/assets/ai/ai-search.md +129 -0
  106. package/skills/devopsCloud/cloudflare/assets/ai/workers-ai.md +127 -0
  107. package/skills/devopsCloud/cloudflare/assets/cli/c3.md +292 -0
  108. package/skills/devopsCloud/cloudflare/assets/cli/cf-cli.md +90 -0
  109. package/skills/devopsCloud/cloudflare/assets/cli/wrangler.md +43 -0
  110. package/skills/devopsCloud/cloudflare/assets/compute/cron-triggers.md +486 -0
  111. package/skills/devopsCloud/cloudflare/assets/compute/service-bindings.md +251 -0
  112. package/skills/devopsCloud/cloudflare/assets/compute/smart-placement.md +435 -0
  113. package/skills/devopsCloud/cloudflare/assets/compute/static-assets.md +220 -0
  114. package/skills/devopsCloud/cloudflare/assets/compute/workers.md +129 -0
  115. package/skills/devopsCloud/cloudflare/assets/database-storage/d1.md +105 -0
  116. package/skills/devopsCloud/cloudflare/assets/database-storage/durable-objects.md +122 -0
  117. package/skills/devopsCloud/cloudflare/assets/database-storage/hyperdrive.md +210 -0
  118. package/skills/devopsCloud/cloudflare/assets/database-storage/kv.md +198 -0
  119. package/skills/devopsCloud/cloudflare/assets/database-storage/queues.md +105 -0
  120. package/skills/devopsCloud/cloudflare/assets/database-storage/r2.md +105 -0
  121. package/skills/devopsCloud/cloudflare/assets/database-storage/vectorize.md +97 -0
  122. package/skills/devopsCloud/cloudflare/assets/database-storage/workflows.md +141 -0
  123. package/skills/devopsCloud/cloudflare/assets/llms.txt +143 -0
  124. package/skills/devopsCloud/cloudflare/assets/networking-security/cache-cdn.md +109 -0
  125. package/skills/devopsCloud/cloudflare/assets/networking-security/dns.md +71 -0
  126. package/skills/devopsCloud/cloudflare/assets/networking-security/rate-limiting.md +130 -0
  127. package/skills/devopsCloud/cloudflare/assets/networking-security/tunnels.md +57 -0
  128. package/skills/devopsCloud/cloudflare/assets/networking-security/waf.md +143 -0
  129. package/skills/devopsCloud/cloudflare/assets/troubleshooting/1xxx-errors.md +209 -0
  130. package/skills/devopsCloud/cloudflare/assets/troubleshooting/5xx-errors.md +111 -0
  131. package/skills/devopsCloud/cloudflare/assets/troubleshooting/http-status-codes.md +38 -0
  132. package/skills/devopsCloud/cloudflare/evals/evals.json +75 -0
  133. package/skills/devopsCloud/cloudflare/references/ai-gateway/README.md +27 -0
  134. package/skills/devopsCloud/cloudflare/references/ai-gateway/configuration.md +18 -0
  135. package/skills/devopsCloud/cloudflare/references/ai-gateway/dynamic-routing.md +15 -0
  136. package/skills/devopsCloud/cloudflare/references/ai-gateway/features.md +22 -0
  137. package/skills/devopsCloud/cloudflare/references/ai-gateway/sdk-integration.md +19 -0
  138. package/skills/devopsCloud/cloudflare/references/ai-gateway/troubleshooting.md +16 -0
  139. package/skills/devopsCloud/cloudflare/references/ai-search/README.md +25 -0
  140. package/skills/devopsCloud/cloudflare/references/ai-search/api.md +13 -0
  141. package/skills/devopsCloud/cloudflare/references/ai-search/configuration.md +16 -0
  142. package/skills/devopsCloud/cloudflare/references/ai-search/gotchas.md +13 -0
  143. package/skills/devopsCloud/cloudflare/references/ai-search/patterns.md +15 -0
  144. package/skills/devopsCloud/cloudflare/references/bindings/README.md +16 -0
  145. package/skills/devopsCloud/cloudflare/references/bindings/api.md +19 -0
  146. package/skills/devopsCloud/cloudflare/references/bindings/configuration.md +20 -0
  147. package/skills/devopsCloud/cloudflare/references/bindings/gotchas.md +18 -0
  148. package/skills/devopsCloud/cloudflare/references/bindings/patterns.md +20 -0
  149. package/skills/devopsCloud/cloudflare/references/browser-rendering/README.md +18 -0
  150. package/skills/devopsCloud/cloudflare/references/browser-rendering/api.md +12 -0
  151. package/skills/devopsCloud/cloudflare/references/browser-rendering/configuration.md +12 -0
  152. package/skills/devopsCloud/cloudflare/references/browser-rendering/gotchas.md +15 -0
  153. package/skills/devopsCloud/cloudflare/references/browser-rendering/patterns.md +12 -0
  154. package/skills/devopsCloud/cloudflare/references/cliComparison.md +93 -0
  155. package/skills/devopsCloud/cloudflare/references/containers/README.md +23 -0
  156. package/skills/devopsCloud/cloudflare/references/containers/api.md +13 -0
  157. package/skills/devopsCloud/cloudflare/references/containers/configuration.md +15 -0
  158. package/skills/devopsCloud/cloudflare/references/containers/gotchas.md +16 -0
  159. package/skills/devopsCloud/cloudflare/references/containers/patterns.md +18 -0
  160. package/skills/devopsCloud/cloudflare/references/cron-triggers/README.md +20 -0
  161. package/skills/devopsCloud/cloudflare/references/cron-triggers/api.md +16 -0
  162. package/skills/devopsCloud/cloudflare/references/cron-triggers/configuration.md +16 -0
  163. package/skills/devopsCloud/cloudflare/references/cron-triggers/gotchas.md +17 -0
  164. package/skills/devopsCloud/cloudflare/references/cron-triggers/patterns.md +18 -0
  165. package/skills/devopsCloud/cloudflare/references/d1/README.md +15 -0
  166. package/skills/devopsCloud/cloudflare/references/d1/api.md +18 -0
  167. package/skills/devopsCloud/cloudflare/references/d1/configuration.md +18 -0
  168. package/skills/devopsCloud/cloudflare/references/d1/gotchas.md +18 -0
  169. package/skills/devopsCloud/cloudflare/references/d1/patterns.md +21 -0
  170. package/skills/devopsCloud/cloudflare/references/frameworkCompatibility.md +110 -0
  171. package/skills/devopsCloud/cloudflare/references/hyperdrive/README.md +28 -0
  172. package/skills/devopsCloud/cloudflare/references/hyperdrive/api.md +26 -0
  173. package/skills/devopsCloud/cloudflare/references/hyperdrive/configuration.md +34 -0
  174. package/skills/devopsCloud/cloudflare/references/hyperdrive/gotchas.md +20 -0
  175. package/skills/devopsCloud/cloudflare/references/hyperdrive/patterns.md +15 -0
  176. package/skills/devopsCloud/cloudflare/references/images/README.md +12 -0
  177. package/skills/devopsCloud/cloudflare/references/images/api.md +13 -0
  178. package/skills/devopsCloud/cloudflare/references/images/configuration.md +17 -0
  179. package/skills/devopsCloud/cloudflare/references/images/gotchas.md +16 -0
  180. package/skills/devopsCloud/cloudflare/references/images/patterns.md +16 -0
  181. package/skills/devopsCloud/cloudflare/references/kv/README.md +15 -0
  182. package/skills/devopsCloud/cloudflare/references/kv/api.md +18 -0
  183. package/skills/devopsCloud/cloudflare/references/kv/configuration.md +16 -0
  184. package/skills/devopsCloud/cloudflare/references/kv/gotchas.md +17 -0
  185. package/skills/devopsCloud/cloudflare/references/kv/patterns.md +21 -0
  186. package/skills/devopsCloud/cloudflare/references/miniflare/README.md +22 -0
  187. package/skills/devopsCloud/cloudflare/references/miniflare/api.md +16 -0
  188. package/skills/devopsCloud/cloudflare/references/miniflare/configuration.md +16 -0
  189. package/skills/devopsCloud/cloudflare/references/miniflare/gotchas.md +15 -0
  190. package/skills/devopsCloud/cloudflare/references/miniflare/patterns.md +19 -0
  191. package/skills/devopsCloud/cloudflare/references/observability/README.md +27 -0
  192. package/skills/devopsCloud/cloudflare/references/observability/api.md +20 -0
  193. package/skills/devopsCloud/cloudflare/references/observability/configuration.md +23 -0
  194. package/skills/devopsCloud/cloudflare/references/observability/gotchas.md +25 -0
  195. package/skills/devopsCloud/cloudflare/references/observability/patterns.md +14 -0
  196. package/skills/devopsCloud/cloudflare/references/pages/README.md +20 -0
  197. package/skills/devopsCloud/cloudflare/references/pages/api.md +13 -0
  198. package/skills/devopsCloud/cloudflare/references/pages/configuration.md +16 -0
  199. package/skills/devopsCloud/cloudflare/references/pages/gotchas.md +19 -0
  200. package/skills/devopsCloud/cloudflare/references/pages/patterns.md +15 -0
  201. package/skills/devopsCloud/cloudflare/references/pages-functions/README.md +20 -0
  202. package/skills/devopsCloud/cloudflare/references/pages-functions/api.md +13 -0
  203. package/skills/devopsCloud/cloudflare/references/pages-functions/configuration.md +14 -0
  204. package/skills/devopsCloud/cloudflare/references/pages-functions/gotchas.md +17 -0
  205. package/skills/devopsCloud/cloudflare/references/pages-functions/patterns.md +16 -0
  206. package/skills/devopsCloud/cloudflare/references/productSelectionMatrix.md +54 -0
  207. package/skills/devopsCloud/cloudflare/references/queues/README.md +24 -0
  208. package/skills/devopsCloud/cloudflare/references/queues/api.md +16 -0
  209. package/skills/devopsCloud/cloudflare/references/queues/configuration.md +20 -0
  210. package/skills/devopsCloud/cloudflare/references/queues/gotchas.md +18 -0
  211. package/skills/devopsCloud/cloudflare/references/queues/patterns.md +21 -0
  212. package/skills/devopsCloud/cloudflare/references/r2/README.md +26 -0
  213. package/skills/devopsCloud/cloudflare/references/r2/api.md +16 -0
  214. package/skills/devopsCloud/cloudflare/references/r2/configuration.md +19 -0
  215. package/skills/devopsCloud/cloudflare/references/r2/gotchas.md +17 -0
  216. package/skills/devopsCloud/cloudflare/references/r2/patterns.md +18 -0
  217. package/skills/devopsCloud/cloudflare/references/secrets-store/README.md +22 -0
  218. package/skills/devopsCloud/cloudflare/references/secrets-store/api.md +21 -0
  219. package/skills/devopsCloud/cloudflare/references/secrets-store/configuration.md +25 -0
  220. package/skills/devopsCloud/cloudflare/references/secrets-store/gotchas.md +19 -0
  221. package/skills/devopsCloud/cloudflare/references/secrets-store/patterns.md +27 -0
  222. package/skills/devopsCloud/cloudflare/references/skill-feedback.md +41 -0
  223. package/skills/devopsCloud/cloudflare/references/static-assets/README.md +21 -0
  224. package/skills/devopsCloud/cloudflare/references/static-assets/api.md +16 -0
  225. package/skills/devopsCloud/cloudflare/references/static-assets/configuration.md +16 -0
  226. package/skills/devopsCloud/cloudflare/references/static-assets/gotchas.md +18 -0
  227. package/skills/devopsCloud/cloudflare/references/static-assets/patterns.md +17 -0
  228. package/skills/devopsCloud/cloudflare/references/stream/README.md +22 -0
  229. package/skills/devopsCloud/cloudflare/references/stream/api-live.md +18 -0
  230. package/skills/devopsCloud/cloudflare/references/stream/api.md +21 -0
  231. package/skills/devopsCloud/cloudflare/references/stream/configuration.md +18 -0
  232. package/skills/devopsCloud/cloudflare/references/stream/gotchas.md +18 -0
  233. package/skills/devopsCloud/cloudflare/references/stream/patterns.md +22 -0
  234. package/skills/devopsCloud/cloudflare/references/tail-workers/README.md +21 -0
  235. package/skills/devopsCloud/cloudflare/references/tail-workers/api.md +13 -0
  236. package/skills/devopsCloud/cloudflare/references/tail-workers/configuration.md +15 -0
  237. package/skills/devopsCloud/cloudflare/references/tail-workers/gotchas.md +16 -0
  238. package/skills/devopsCloud/cloudflare/references/tail-workers/patterns.md +15 -0
  239. package/skills/devopsCloud/cloudflare/references/tunnel/README.md +20 -0
  240. package/skills/devopsCloud/cloudflare/references/tunnel/api.md +14 -0
  241. package/skills/devopsCloud/cloudflare/references/tunnel/configuration.md +14 -0
  242. package/skills/devopsCloud/cloudflare/references/tunnel/gotchas.md +15 -0
  243. package/skills/devopsCloud/cloudflare/references/tunnel/networking.md +14 -0
  244. package/skills/devopsCloud/cloudflare/references/tunnel/patterns.md +15 -0
  245. package/skills/devopsCloud/cloudflare/references/vectorize/README.md +22 -0
  246. package/skills/devopsCloud/cloudflare/references/vectorize/api.md +18 -0
  247. package/skills/devopsCloud/cloudflare/references/vectorize/configuration.md +19 -0
  248. package/skills/devopsCloud/cloudflare/references/vectorize/gotchas.md +15 -0
  249. package/skills/devopsCloud/cloudflare/references/vectorize/patterns.md +24 -0
  250. package/skills/devopsCloud/cloudflare/references/waf/README.md +21 -0
  251. package/skills/devopsCloud/cloudflare/references/waf/api.md +17 -0
  252. package/skills/devopsCloud/cloudflare/references/waf/configuration.md +18 -0
  253. package/skills/devopsCloud/cloudflare/references/waf/gotchas.md +19 -0
  254. package/skills/devopsCloud/cloudflare/references/waf/patterns.md +17 -0
  255. package/skills/devopsCloud/cloudflare/references/workers-ai/README.md +24 -0
  256. package/skills/devopsCloud/cloudflare/references/workers-ai/api.md +13 -0
  257. package/skills/devopsCloud/cloudflare/references/workers-ai/configuration.md +16 -0
  258. package/skills/devopsCloud/cloudflare/references/workers-ai/gotchas.md +15 -0
  259. package/skills/devopsCloud/cloudflare/references/workers-ai/patterns.md +14 -0
  260. package/skills/devopsCloud/cloudflare/references/workflows/README.md +23 -0
  261. package/skills/devopsCloud/cloudflare/references/workflows/api.md +17 -0
  262. package/skills/devopsCloud/cloudflare/references/workflows/configuration.md +18 -0
  263. package/skills/devopsCloud/cloudflare/references/workflows/gotchas.md +19 -0
  264. package/skills/devopsCloud/cloudflare/references/workflows/patterns.md +30 -0
  265. package/skills/devopsCloud/cloudflare/scripts/auditCloudflareProduction.py +95 -0
  266. package/skills/foundation/promptEvalTesting/SKILL.md +114 -0
  267. package/skills/foundation/promptEvalTesting/evals/promptEvalVerification.json +14 -0
  268. package/skills/foundation/promptEvalTesting/references/apiReference.md +3 -0
  269. package/skills/foundation/promptEvalTesting/references/evalMetricsCatalog.md +7 -0
  270. package/skills/foundation/promptEvalTesting/references/promptfooConfigSpecs.md +16 -0
  271. package/skills/foundation/promptEvalTesting/scripts/runPromptEvalSuite.py +29 -0
  272. package/skills/frontend/astro/SKILL.md +327 -0
  273. package/skills/frontend/astro/assets/README.md +71 -0
  274. package/skills/frontend/astro/assets/add-content-to-your-site/content-collections.md +1061 -0
  275. package/skills/frontend/astro/assets/add-content-to-your-site/data-fetching.md +109 -0
  276. package/skills/frontend/astro/assets/add-content-to-your-site/images.md +719 -0
  277. package/skills/frontend/astro/assets/add-content-to-your-site/markdown.md +725 -0
  278. package/skills/frontend/astro/assets/build-your-ui/components.md +402 -0
  279. package/skills/frontend/astro/assets/build-your-ui/fonts.md +437 -0
  280. package/skills/frontend/astro/assets/build-your-ui/front-end-frameworks.md +245 -0
  281. package/skills/frontend/astro/assets/build-your-ui/layouts.md +267 -0
  282. package/skills/frontend/astro/assets/build-your-ui/scripts-and-event-handling.md +229 -0
  283. package/skills/frontend/astro/assets/build-your-ui/styles-and-css.md +782 -0
  284. package/skills/frontend/astro/assets/build-your-ui/syntax-highlighting.md +269 -0
  285. package/skills/frontend/astro/assets/configuration/build-with-ai.md +389 -0
  286. package/skills/frontend/astro/assets/configuration/configuration-overview.md +122 -0
  287. package/skills/frontend/astro/assets/configuration/dev-toolbar.md +86 -0
  288. package/skills/frontend/astro/assets/configuration/editor-setup.md +166 -0
  289. package/skills/frontend/astro/assets/configuration/environment-variables.md +352 -0
  290. package/skills/frontend/astro/assets/configuration/typescript.md +379 -0
  291. package/skills/frontend/astro/assets/configuration/working-with-integrations.md +606 -0
  292. package/skills/frontend/astro/assets/reference/adapter-reference.md +1242 -0
  293. package/skills/frontend/astro/assets/reference/cli-reference.md +575 -0
  294. package/skills/frontend/astro/assets/reference/configuration-reference.md +3144 -0
  295. package/skills/frontend/astro/assets/reference/content-loader-reference.md +1682 -0
  296. package/skills/frontend/astro/assets/reference/directives-reference.md +324 -0
  297. package/skills/frontend/astro/assets/reference/image-service-reference.md +346 -0
  298. package/skills/frontend/astro/assets/reference/integrations-reference.md +2813 -0
  299. package/skills/frontend/astro/assets/reference/modules/astro-actions.md +604 -0
  300. package/skills/frontend/astro/assets/reference/modules/astro-app.md +460 -0
  301. package/skills/frontend/astro/assets/reference/modules/astro-assets.md +1657 -0
  302. package/skills/frontend/astro/assets/reference/modules/astro-config.md +395 -0
  303. package/skills/frontend/astro/assets/reference/modules/astro-content.md +720 -0
  304. package/skills/frontend/astro/assets/reference/modules/astro-env.md +46 -0
  305. package/skills/frontend/astro/assets/reference/modules/astro-fetch.md +346 -0
  306. package/skills/frontend/astro/assets/reference/modules/astro-hono.md +37 -0
  307. package/skills/frontend/astro/assets/reference/modules/astro-i18n.md +462 -0
  308. package/skills/frontend/astro/assets/reference/modules/astro-middleware.md +292 -0
  309. package/skills/frontend/astro/assets/reference/modules/astro-static-paths.md +74 -0
  310. package/skills/frontend/astro/assets/reference/modules/astro-transitions.md +595 -0
  311. package/skills/frontend/astro/assets/reference/modules/astro-zod.md +120 -0
  312. package/skills/frontend/astro/assets/reference/session-driver-reference.md +205 -0
  313. package/skills/frontend/astro/assets/routing-and-navigation/endpoints.md +251 -0
  314. package/skills/frontend/astro/assets/routing-and-navigation/internationalization.md +374 -0
  315. package/skills/frontend/astro/assets/routing-and-navigation/middleware.md +288 -0
  316. package/skills/frontend/astro/assets/routing-and-navigation/pages.md +205 -0
  317. package/skills/frontend/astro/assets/routing-and-navigation/prefetch.md +273 -0
  318. package/skills/frontend/astro/assets/routing-and-navigation/routing.md +760 -0
  319. package/skills/frontend/astro/assets/routing-and-navigation/view-transitions.md +792 -0
  320. package/skills/frontend/astro/assets/server-rendering/actions.md +770 -0
  321. package/skills/frontend/astro/assets/server-rendering/caching.md +255 -0
  322. package/skills/frontend/astro/assets/server-rendering/on-demand-rendering.md +289 -0
  323. package/skills/frontend/astro/assets/server-rendering/server-islands.md +126 -0
  324. package/skills/frontend/astro/assets/server-rendering/sessions.md +270 -0
  325. package/skills/frontend/astro/assets/start-a-new-project/develop-and-build.md +147 -0
  326. package/skills/frontend/astro/assets/start-a-new-project/installation.md +342 -0
  327. package/skills/frontend/astro/assets/start-a-new-project/project-structure.md +137 -0
  328. package/skills/frontend/astro/assets/upgrade-and-troubleshooting/testing.md +412 -0
  329. package/skills/frontend/astro/assets/upgrade-and-troubleshooting/troubleshooting.md +229 -0
  330. package/skills/frontend/astro/assets/upgrade-and-troubleshooting/upgrade-astro.md +205 -0
  331. package/skills/frontend/astro/assets/welcome/courses.md +46 -0
  332. package/skills/frontend/astro/assets/welcome/islands-architecture.md +135 -0
  333. package/skills/frontend/astro/assets/welcome/why-astro.md +90 -0
  334. package/skills/frontend/astro/evals/evals.json +66 -0
  335. package/skills/frontend/astro/references/contentCollections.md +164 -0
  336. package/skills/frontend/astro/references/islandsArchitecture.md +128 -0
  337. package/skills/frontend/astro/references/serverIslandsAndActions.md +187 -0
  338. package/skills/frontend/astro/scripts/auditAstroProduction.py +78 -0
  339. package/skills/frontend/generativeUi/SKILL.md +128 -0
  340. package/skills/frontend/generativeUi/evals/generativeUiVerification.json +14 -0
  341. package/skills/frontend/generativeUi/references/apiReference.md +3 -0
  342. package/skills/frontend/generativeUi/references/clientToolComponentMapping.md +8 -0
  343. package/skills/frontend/generativeUi/references/dataStreamProtocol.md +10 -0
  344. package/skills/frontend/generativeUi/scripts/generateUiComponentStub.py +46 -0
  345. package/skills/frontend/nextjs/SKILL.md +138 -0
  346. package/skills/frontend/nextjs/assets/README.md +67 -0
  347. package/skills/frontend/nextjs/assets/api-reference/cli/create-next-app.md +210 -0
  348. package/skills/frontend/nextjs/assets/api-reference/cli/next.md +484 -0
  349. package/skills/frontend/nextjs/assets/api-reference/components/font.md +952 -0
  350. package/skills/frontend/nextjs/assets/api-reference/components/form.md +387 -0
  351. package/skills/frontend/nextjs/assets/api-reference/components/image.md +1372 -0
  352. package/skills/frontend/nextjs/assets/api-reference/components/link.md +954 -0
  353. package/skills/frontend/nextjs/assets/api-reference/components/script.md +421 -0
  354. package/skills/frontend/nextjs/assets/api-reference/directives/use-cache-private.md +211 -0
  355. package/skills/frontend/nextjs/assets/api-reference/directives/use-cache-remote.md +652 -0
  356. package/skills/frontend/nextjs/assets/api-reference/directives/use-cache.md +848 -0
  357. package/skills/frontend/nextjs/assets/api-reference/directives/use-client.md +149 -0
  358. package/skills/frontend/nextjs/assets/api-reference/directives/use-server.md +234 -0
  359. package/skills/frontend/nextjs/assets/api-reference/edge-runtime.md +188 -0
  360. package/skills/frontend/nextjs/assets/api-reference/file-conventions/default.md +80 -0
  361. package/skills/frontend/nextjs/assets/api-reference/file-conventions/dynamic-routes.md +417 -0
  362. package/skills/frontend/nextjs/assets/api-reference/file-conventions/error.md +361 -0
  363. package/skills/frontend/nextjs/assets/api-reference/file-conventions/forbidden.md +75 -0
  364. package/skills/frontend/nextjs/assets/api-reference/file-conventions/instrumentation-client.md +308 -0
  365. package/skills/frontend/nextjs/assets/api-reference/file-conventions/instrumentation.md +177 -0
  366. package/skills/frontend/nextjs/assets/api-reference/file-conventions/intercepting-routes.md +78 -0
  367. package/skills/frontend/nextjs/assets/api-reference/file-conventions/layout.md +803 -0
  368. package/skills/frontend/nextjs/assets/api-reference/file-conventions/loading.md +209 -0
  369. package/skills/frontend/nextjs/assets/api-reference/file-conventions/mdx-components.md +84 -0
  370. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/app-icons.md +302 -0
  371. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/manifest.md +90 -0
  372. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/opengraph-image.md +580 -0
  373. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/robots.md +234 -0
  374. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/sitemap.md +459 -0
  375. package/skills/frontend/nextjs/assets/api-reference/file-conventions/not-found.md +278 -0
  376. package/skills/frontend/nextjs/assets/api-reference/file-conventions/page.md +283 -0
  377. package/skills/frontend/nextjs/assets/api-reference/file-conventions/parallel-routes.md +517 -0
  378. package/skills/frontend/nextjs/assets/api-reference/file-conventions/proxy.md +857 -0
  379. package/skills/frontend/nextjs/assets/api-reference/file-conventions/public-folder.md +47 -0
  380. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-groups.md +40 -0
  381. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/dynamicParams.md +40 -0
  382. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/ensureStatic.md +195 -0
  383. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/instant.md +204 -0
  384. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/maxDuration.md +42 -0
  385. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/preferredRegion.md +55 -0
  386. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/prefetch.md +113 -0
  387. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/runtime.md +43 -0
  388. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route.md +772 -0
  389. package/skills/frontend/nextjs/assets/api-reference/file-conventions/src-folder.md +42 -0
  390. package/skills/frontend/nextjs/assets/api-reference/file-conventions/template.md +174 -0
  391. package/skills/frontend/nextjs/assets/api-reference/file-conventions/unauthorized.md +143 -0
  392. package/skills/frontend/nextjs/assets/api-reference/functions/after.md +332 -0
  393. package/skills/frontend/nextjs/assets/api-reference/functions/cacheLife.md +642 -0
  394. package/skills/frontend/nextjs/assets/api-reference/functions/cacheTag.md +272 -0
  395. package/skills/frontend/nextjs/assets/api-reference/functions/catchError.md +267 -0
  396. package/skills/frontend/nextjs/assets/api-reference/functions/connection.md +114 -0
  397. package/skills/frontend/nextjs/assets/api-reference/functions/cookies.md +349 -0
  398. package/skills/frontend/nextjs/assets/api-reference/functions/draft-mode.md +173 -0
  399. package/skills/frontend/nextjs/assets/api-reference/functions/fetch.md +141 -0
  400. package/skills/frontend/nextjs/assets/api-reference/functions/forbidden.md +327 -0
  401. package/skills/frontend/nextjs/assets/api-reference/functions/generate-image-metadata.md +311 -0
  402. package/skills/frontend/nextjs/assets/api-reference/functions/generate-metadata.md +1510 -0
  403. package/skills/frontend/nextjs/assets/api-reference/functions/generate-sitemaps.md +102 -0
  404. package/skills/frontend/nextjs/assets/api-reference/functions/generate-static-params.md +606 -0
  405. package/skills/frontend/nextjs/assets/api-reference/functions/generate-viewport.md +347 -0
  406. package/skills/frontend/nextjs/assets/api-reference/functions/headers.md +92 -0
  407. package/skills/frontend/nextjs/assets/api-reference/functions/image-response.md +225 -0
  408. package/skills/frontend/nextjs/assets/api-reference/functions/io.md +131 -0
  409. package/skills/frontend/nextjs/assets/api-reference/functions/navigation.md +220 -0
  410. package/skills/frontend/nextjs/assets/api-reference/functions/next-request.md +116 -0
  411. package/skills/frontend/nextjs/assets/api-reference/functions/next-response.md +219 -0
  412. package/skills/frontend/nextjs/assets/api-reference/functions/next-root-params.md +479 -0
  413. package/skills/frontend/nextjs/assets/api-reference/functions/not-found.md +269 -0
  414. package/skills/frontend/nextjs/assets/api-reference/functions/permanentRedirect.md +92 -0
  415. package/skills/frontend/nextjs/assets/api-reference/functions/prefetch.md +202 -0
  416. package/skills/frontend/nextjs/assets/api-reference/functions/redirect.md +255 -0
  417. package/skills/frontend/nextjs/assets/api-reference/functions/refresh.md +91 -0
  418. package/skills/frontend/nextjs/assets/api-reference/functions/revalidatePath.md +248 -0
  419. package/skills/frontend/nextjs/assets/api-reference/functions/revalidateTag.md +175 -0
  420. package/skills/frontend/nextjs/assets/api-reference/functions/unauthorized.md +389 -0
  421. package/skills/frontend/nextjs/assets/api-reference/functions/unstable_cache.md +131 -0
  422. package/skills/frontend/nextjs/assets/api-reference/functions/unstable_noStore.md +61 -0
  423. package/skills/frontend/nextjs/assets/api-reference/functions/unstable_rethrow.md +79 -0
  424. package/skills/frontend/nextjs/assets/api-reference/functions/updateTag.md +173 -0
  425. package/skills/frontend/nextjs/assets/api-reference/functions/use-link-status.md +268 -0
  426. package/skills/frontend/nextjs/assets/api-reference/functions/use-offline.md +222 -0
  427. package/skills/frontend/nextjs/assets/api-reference/functions/use-params.md +102 -0
  428. package/skills/frontend/nextjs/assets/api-reference/functions/use-pathname.md +189 -0
  429. package/skills/frontend/nextjs/assets/api-reference/functions/use-report-web-vitals.md +175 -0
  430. package/skills/frontend/nextjs/assets/api-reference/functions/use-router.md +214 -0
  431. package/skills/frontend/nextjs/assets/api-reference/functions/use-search-params.md +416 -0
  432. package/skills/frontend/nextjs/assets/api-reference/functions/use-selected-layout-segment.md +214 -0
  433. package/skills/frontend/nextjs/assets/api-reference/functions/use-selected-layout-segments.md +116 -0
  434. package/skills/frontend/nextjs/assets/api-reference/functions/use-server-inserted-html.md +145 -0
  435. package/skills/frontend/nextjs/assets/api-reference/functions/userAgent.md +95 -0
  436. package/skills/frontend/nextjs/assets/api-reference/turbopack.md +552 -0
  437. package/skills/frontend/nextjs/assets/architecture/accessibility.md +47 -0
  438. package/skills/frontend/nextjs/assets/architecture/fast-refresh.md +122 -0
  439. package/skills/frontend/nextjs/assets/architecture/nextjs-compiler.md +376 -0
  440. package/skills/frontend/nextjs/assets/architecture/supported-browsers.md +146 -0
  441. package/skills/frontend/nextjs/assets/community/contribution-guide.md +459 -0
  442. package/skills/frontend/nextjs/assets/community/rspack.md +25 -0
  443. package/skills/frontend/nextjs/assets/getting-started/caching.md +626 -0
  444. package/skills/frontend/nextjs/assets/getting-started/css.md +336 -0
  445. package/skills/frontend/nextjs/assets/getting-started/deploying.md +115 -0
  446. package/skills/frontend/nextjs/assets/getting-started/error-handling.md +485 -0
  447. package/skills/frontend/nextjs/assets/getting-started/fetching-data.md +743 -0
  448. package/skills/frontend/nextjs/assets/getting-started/fonts.md +232 -0
  449. package/skills/frontend/nextjs/assets/getting-started/images.md +272 -0
  450. package/skills/frontend/nextjs/assets/getting-started/installation.md +446 -0
  451. package/skills/frontend/nextjs/assets/getting-started/layouts-and-pages.md +386 -0
  452. package/skills/frontend/nextjs/assets/getting-started/linking-and-navigating.md +475 -0
  453. package/skills/frontend/nextjs/assets/getting-started/metadata-and-og-images.md +370 -0
  454. package/skills/frontend/nextjs/assets/getting-started/mutating-data.md +679 -0
  455. package/skills/frontend/nextjs/assets/getting-started/project-structure.md +290 -0
  456. package/skills/frontend/nextjs/assets/getting-started/proxy.md +107 -0
  457. package/skills/frontend/nextjs/assets/getting-started/revalidating.md +241 -0
  458. package/skills/frontend/nextjs/assets/getting-started/route-handlers.md +233 -0
  459. package/skills/frontend/nextjs/assets/getting-started/server-and-client-components.md +683 -0
  460. package/skills/frontend/nextjs/assets/getting-started/upgrading.md +137 -0
  461. package/skills/frontend/nextjs/assets/glossary.md +315 -0
  462. package/skills/frontend/nextjs/evals/nextjsVerification.json +14 -0
  463. package/skills/frontend/nextjs/references/apiReference.md +3 -0
  464. package/skills/frontend/nextjs/references/dataAccessLayer.md +39 -0
  465. package/skills/frontend/nextjs/references/nextjsFeatureMap.md +276 -0
  466. package/skills/frontend/nextjs/references/productionChecklist.md +49 -0
  467. package/skills/frontend/nextjs/references/securityHeadersCsp.md +44 -0
  468. package/skills/frontend/nextjs/scripts/auditProductionReadiness.py +85 -0
  469. package/skills/frontend/shadcn-ui/SKILL.md +102 -0
  470. package/skills/frontend/shadcn-ui/assets/README.md +82 -0
  471. package/skills/frontend/shadcn-ui/assets/advanced/javascript.md +44 -0
  472. package/skills/frontend/shadcn-ui/assets/advanced/monorepo.md +254 -0
  473. package/skills/frontend/shadcn-ui/assets/advanced/react-19.md +166 -0
  474. package/skills/frontend/shadcn-ui/assets/advanced/tailwind-v4.md +333 -0
  475. package/skills/frontend/shadcn-ui/assets/ai-elements/chain-of-thought.md +519 -0
  476. package/skills/frontend/shadcn-ui/assets/ai-elements/chat.md +581 -0
  477. package/skills/frontend/shadcn-ui/assets/ai-elements/checkpoint.md +243 -0
  478. package/skills/frontend/shadcn-ui/assets/ai-elements/confirmation.md +382 -0
  479. package/skills/frontend/shadcn-ui/assets/ai-elements/context.md +188 -0
  480. package/skills/frontend/shadcn-ui/assets/ai-elements/file-tree.md +248 -0
  481. package/skills/frontend/shadcn-ui/assets/ai-elements/index.md +307 -0
  482. package/skills/frontend/shadcn-ui/assets/ai-elements/inline-citation.md +219 -0
  483. package/skills/frontend/shadcn-ui/assets/ai-elements/message.md +298 -0
  484. package/skills/frontend/shadcn-ui/assets/ai-elements/model-selector.md +368 -0
  485. package/skills/frontend/shadcn-ui/assets/ai-elements/plan.md +398 -0
  486. package/skills/frontend/shadcn-ui/assets/ai-elements/prompt-input.md +403 -0
  487. package/skills/frontend/shadcn-ui/assets/ai-elements/queue.md +517 -0
  488. package/skills/frontend/shadcn-ui/assets/ai-elements/reasoning.md +349 -0
  489. package/skills/frontend/shadcn-ui/assets/ai-elements/sources.md +303 -0
  490. package/skills/frontend/shadcn-ui/assets/ai-elements/stack-trace.md +514 -0
  491. package/skills/frontend/shadcn-ui/assets/ai-elements/subagent.md +551 -0
  492. package/skills/frontend/shadcn-ui/assets/ai-elements/suggestion.md +246 -0
  493. package/skills/frontend/shadcn-ui/assets/ai-elements/task.md +380 -0
  494. package/skills/frontend/shadcn-ui/assets/ai-elements/terminal.md +463 -0
  495. package/skills/frontend/shadcn-ui/assets/ai-elements/test-results.md +641 -0
  496. package/skills/frontend/shadcn-ui/assets/ai-elements/tool.md +915 -0
  497. package/skills/frontend/shadcn-ui/assets/components/accordion.md +490 -0
  498. package/skills/frontend/shadcn-ui/assets/components/alert-dialog.md +520 -0
  499. package/skills/frontend/shadcn-ui/assets/components/alert.md +351 -0
  500. package/skills/frontend/shadcn-ui/assets/components/aspect-ratio.md +206 -0
  501. package/skills/frontend/shadcn-ui/assets/components/attachment.md +715 -0
  502. package/skills/frontend/shadcn-ui/assets/components/avatar.md +581 -0
  503. package/skills/frontend/shadcn-ui/assets/components/badge.md +276 -0
  504. package/skills/frontend/shadcn-ui/assets/components/breadcrumb.md +556 -0
  505. package/skills/frontend/shadcn-ui/assets/components/bubble.md +706 -0
  506. package/skills/frontend/shadcn-ui/assets/components/button-group.md +969 -0
  507. package/skills/frontend/shadcn-ui/assets/components/button.md +523 -0
  508. package/skills/frontend/shadcn-ui/assets/components/calendar.md +959 -0
  509. package/skills/frontend/shadcn-ui/assets/components/card.md +684 -0
  510. package/skills/frontend/shadcn-ui/assets/components/carousel.md +643 -0
  511. package/skills/frontend/shadcn-ui/assets/components/chart.md +1295 -0
  512. package/skills/frontend/shadcn-ui/assets/components/checkbox.md +553 -0
  513. package/skills/frontend/shadcn-ui/assets/components/code-block.md +2041 -0
  514. package/skills/frontend/shadcn-ui/assets/components/collapsible.md +504 -0
  515. package/skills/frontend/shadcn-ui/assets/components/combobox.md +1102 -0
  516. package/skills/frontend/shadcn-ui/assets/components/command.md +682 -0
  517. package/skills/frontend/shadcn-ui/assets/components/context-menu.md +949 -0
  518. package/skills/frontend/shadcn-ui/assets/components/data-table.md +1667 -0
  519. package/skills/frontend/shadcn-ui/assets/components/date-picker.md +698 -0
  520. package/skills/frontend/shadcn-ui/assets/components/dialog.md +454 -0
  521. package/skills/frontend/shadcn-ui/assets/components/direction.md +205 -0
  522. package/skills/frontend/shadcn-ui/assets/components/drawer.md +806 -0
  523. package/skills/frontend/shadcn-ui/assets/components/dropdown-menu.md +1315 -0
  524. package/skills/frontend/shadcn-ui/assets/components/empty.md +562 -0
  525. package/skills/frontend/shadcn-ui/assets/components/field.md +1321 -0
  526. package/skills/frontend/shadcn-ui/assets/components/hover-card.md +342 -0
  527. package/skills/frontend/shadcn-ui/assets/components/index.md +82 -0
  528. package/skills/frontend/shadcn-ui/assets/components/input-group.md +980 -0
  529. package/skills/frontend/shadcn-ui/assets/components/input-otp.md +551 -0
  530. package/skills/frontend/shadcn-ui/assets/components/input.md +555 -0
  531. package/skills/frontend/shadcn-ui/assets/components/item.md +937 -0
  532. package/skills/frontend/shadcn-ui/assets/components/kbd.md +290 -0
  533. package/skills/frontend/shadcn-ui/assets/components/label.md +327 -0
  534. package/skills/frontend/shadcn-ui/assets/components/marker.md +445 -0
  535. package/skills/frontend/shadcn-ui/assets/components/menubar.md +804 -0
  536. package/skills/frontend/shadcn-ui/assets/components/message-scroller.md +2770 -0
  537. package/skills/frontend/shadcn-ui/assets/components/message.md +618 -0
  538. package/skills/frontend/shadcn-ui/assets/components/native-select.md +321 -0
  539. package/skills/frontend/shadcn-ui/assets/components/navigation-menu.md +568 -0
  540. package/skills/frontend/shadcn-ui/assets/components/pagination.md +425 -0
  541. package/skills/frontend/shadcn-ui/assets/components/popover.md +402 -0
  542. package/skills/frontend/shadcn-ui/assets/components/progress.md +240 -0
  543. package/skills/frontend/shadcn-ui/assets/components/questionnaire.md +2055 -0
  544. package/skills/frontend/shadcn-ui/assets/components/radio-group.md +440 -0
  545. package/skills/frontend/shadcn-ui/assets/components/resizable.md +302 -0
  546. package/skills/frontend/shadcn-ui/assets/components/scroll-area.md +226 -0
  547. package/skills/frontend/shadcn-ui/assets/components/select.md +647 -0
  548. package/skills/frontend/shadcn-ui/assets/components/separator.md +235 -0
  549. package/skills/frontend/shadcn-ui/assets/components/sheet.md +354 -0
  550. package/skills/frontend/shadcn-ui/assets/components/sidebar.md +1156 -0
  551. package/skills/frontend/shadcn-ui/assets/components/skeleton.md +217 -0
  552. package/skills/frontend/shadcn-ui/assets/components/slider.md +253 -0
  553. package/skills/frontend/shadcn-ui/assets/components/spinner.md +352 -0
  554. package/skills/frontend/shadcn-ui/assets/components/switch.md +296 -0
  555. package/skills/frontend/shadcn-ui/assets/components/table.md +572 -0
  556. package/skills/frontend/shadcn-ui/assets/components/tabs.md +425 -0
  557. package/skills/frontend/shadcn-ui/assets/components/textarea.md +218 -0
  558. package/skills/frontend/shadcn-ui/assets/components/toast.md +260 -0
  559. package/skills/frontend/shadcn-ui/assets/components/toggle-group.md +419 -0
  560. package/skills/frontend/shadcn-ui/assets/components/toggle.md +220 -0
  561. package/skills/frontend/shadcn-ui/assets/components/tooltip.md +332 -0
  562. package/skills/frontend/shadcn-ui/assets/components/trace.md +1890 -0
  563. package/skills/frontend/shadcn-ui/assets/components/typography.md +561 -0
  564. package/skills/frontend/shadcn-ui/assets/dark-mode/next.md +108 -0
  565. package/skills/frontend/shadcn-ui/assets/dark-mode/overview.md +75 -0
  566. package/skills/frontend/shadcn-ui/assets/dark-mode/vite.md +144 -0
  567. package/skills/frontend/shadcn-ui/assets/forms/next.md +716 -0
  568. package/skills/frontend/shadcn-ui/assets/forms/overview.md +60 -0
  569. package/skills/frontend/shadcn-ui/assets/forms/react-hook-form.md +2055 -0
  570. package/skills/frontend/shadcn-ui/assets/forms/tanstack-form.md +2236 -0
  571. package/skills/frontend/shadcn-ui/assets/installation/astro.md +252 -0
  572. package/skills/frontend/shadcn-ui/assets/installation/manual.md +255 -0
  573. package/skills/frontend/shadcn-ui/assets/installation/next.md +256 -0
  574. package/skills/frontend/shadcn-ui/assets/installation/react-router.md +226 -0
  575. package/skills/frontend/shadcn-ui/assets/installation/remix.md +52 -0
  576. package/skills/frontend/shadcn-ui/assets/installation/vite.md +314 -0
  577. package/skills/frontend/shadcn-ui/assets/mcp/mcp.md +338 -0
  578. package/skills/frontend/shadcn-ui/assets/overview/changelog.md +6 -0
  579. package/skills/frontend/shadcn-ui/assets/overview/cli.md +738 -0
  580. package/skills/frontend/shadcn-ui/assets/overview/components-json.md +379 -0
  581. package/skills/frontend/shadcn-ui/assets/overview/directory.md +74 -0
  582. package/skills/frontend/shadcn-ui/assets/overview/introduction.md +77 -0
  583. package/skills/frontend/shadcn-ui/assets/overview/skills.md +71 -0
  584. package/skills/frontend/shadcn-ui/assets/overview/theming.md +304 -0
  585. package/skills/frontend/shadcn-ui/assets/overview/typeset.md +242 -0
  586. package/skills/frontend/shadcn-ui/assets/registry/getting-started.md +648 -0
  587. package/skills/frontend/shadcn-ui/assets/registry/overview.md +90 -0
  588. package/skills/frontend/shadcn-ui/assets/registry/registry-item-json.md +483 -0
  589. package/skills/frontend/shadcn-ui/assets/registry/registry-json.md +178 -0
  590. package/skills/frontend/shadcn-ui/evals/componentVerification.json +19 -0
  591. package/skills/frontend/shadcn-ui/references/aiComponentsCatalog.md +51 -0
  592. package/skills/frontend/shadcn-ui/references/apiReference.md +3 -0
  593. package/skills/frontend/shadcn-ui/references/blocksCatalog.md +32 -0
  594. package/skills/frontend/shadcn-ui/references/cliCommands.md +47 -0
  595. package/skills/frontend/shadcn-ui/references/componentMarkdownSources.md +48 -0
  596. package/skills/frontend/shadcn-ui/scripts/fetchComponentDocs.py +43 -0
  597. package/skills/frontend/tsxReactStandard/SKILL.md +150 -0
  598. package/skills/frontend/tsxReactStandard/evals/tsxVerification.json +14 -0
  599. package/skills/frontend/tsxReactStandard/references/apiReference.md +3 -0
  600. package/skills/frontend/tsxReactStandard/references/discriminatedUnions.md +31 -0
  601. package/skills/frontend/tsxReactStandard/references/tsconfigStrict.md +36 -0
  602. package/skills/frontend/tsxReactStandard/scripts/validateTsxTypes.py +44 -0
  603. package/skills/gitVersionControl/gitWorkflow/SKILL.md +128 -0
  604. package/skills/gitVersionControl/gitWorkflow/assets/README.md +23 -0
  605. package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-environment.md +87 -0
  606. package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-formatting.md +156 -0
  607. package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-reference.md +2363 -0
  608. package/skills/gitVersionControl/gitWorkflow/assets/using-git/about-git.md +156 -0
  609. package/skills/gitVersionControl/gitWorkflow/assets/using-git/about-remote-repositories.md +65 -0
  610. package/skills/gitVersionControl/gitWorkflow/assets/using-git/associating-text-editors-with-git.md +93 -0
  611. package/skills/gitVersionControl/gitWorkflow/assets/using-git/caching-your-github-credentials.md +115 -0
  612. package/skills/gitVersionControl/gitWorkflow/assets/using-git/getting-changes-from-a-remote-repository.md +76 -0
  613. package/skills/gitVersionControl/gitWorkflow/assets/using-git/ignoring-files.md +51 -0
  614. package/skills/gitVersionControl/gitWorkflow/assets/using-git/managing-remote-repositories.md +231 -0
  615. package/skills/gitVersionControl/gitWorkflow/assets/using-git/pushing-commits-to-a-remote-repository.md +119 -0
  616. package/skills/gitVersionControl/gitWorkflow/evals/evalGitWorkflow.py +43 -0
  617. package/skills/gitVersionControl/gitWorkflow/references/apiReference.md +3 -0
  618. package/skills/gitVersionControl/gitWorkflow/references/branchingModels.md +32 -0
  619. package/skills/gitVersionControl/gitWorkflow/scripts/diagnoseGitGraph.py +68 -0
  620. package/skills/github/assets/README.md +39 -0
  621. package/skills/github/assets/cli/gh-environment.md +87 -0
  622. package/skills/github/assets/cli/gh-formatting.md +156 -0
  623. package/skills/github/assets/cli/gh-reference.md +2363 -0
  624. package/skills/github/assets/docs-api/github-docs-api.md +60 -0
  625. package/skills/github/assets/rest-api/actions-secrets.md +1272 -0
  626. package/skills/github/assets/rest-api/actions-variables.md +1247 -0
  627. package/skills/github/assets/rest-api/actions-workflow-runs.md +1697 -0
  628. package/skills/github/assets/rest-api/actions-workflows.md +348 -0
  629. package/skills/github/assets/rest-api/authenticating.md +174 -0
  630. package/skills/github/assets/rest-api/branches.md +727 -0
  631. package/skills/github/assets/rest-api/checks-runs.md +1013 -0
  632. package/skills/github/assets/rest-api/checks-suites.md +1142 -0
  633. package/skills/github/assets/rest-api/code-scanning.md +2957 -0
  634. package/skills/github/assets/rest-api/collaborators.md +547 -0
  635. package/skills/github/assets/rest-api/commits.md +957 -0
  636. package/skills/github/assets/rest-api/dependabot-alerts.md +895 -0
  637. package/skills/github/assets/rest-api/orgs.md +1172 -0
  638. package/skills/github/assets/rest-api/overview.md +875 -0
  639. package/skills/github/assets/rest-api/pull-reviews.md +722 -0
  640. package/skills/github/assets/rest-api/pulls.md +1605 -0
  641. package/skills/github/assets/rest-api/quickstart.md +344 -0
  642. package/skills/github/assets/rest-api/releases.md +650 -0
  643. package/skills/github/assets/rest-api/repos.md +2957 -0
  644. package/skills/github/assets/rest-api/rules.md +1507 -0
  645. package/skills/github/assets/rest-api/secret-scanning.md +947 -0
  646. package/skills/github/assets/rest-api/teams.md +1690 -0
  647. package/skills/github/githubAction/SKILL.md +159 -0
  648. package/skills/github/githubAction/assets/README.md +38 -0
  649. package/skills/github/githubAction/assets/reference/contexts.md +918 -0
  650. package/skills/github/githubAction/assets/reference/dependency-caching.md +393 -0
  651. package/skills/github/githubAction/assets/reference/events-that-trigger-workflows.md +1348 -0
  652. package/skills/github/githubAction/assets/reference/expressions.md +441 -0
  653. package/skills/github/githubAction/assets/reference/metadata-syntax.md +803 -0
  654. package/skills/github/githubAction/assets/reference/variables.md +149 -0
  655. package/skills/github/githubAction/assets/reference/workflow-cancellation.md +22 -0
  656. package/skills/github/githubAction/assets/reference/workflow-commands.md +1056 -0
  657. package/skills/github/githubAction/assets/reference/workflow-syntax.md +1721 -0
  658. package/skills/github/githubAction/assets/rest-api/secrets.md +1272 -0
  659. package/skills/github/githubAction/assets/rest-api/workflow-runs.md +1697 -0
  660. package/skills/github/githubAction/assets/rest-api/workflows.md +348 -0
  661. package/skills/github/githubAction/assets/starter-workflows/automation/stale.yml +27 -0
  662. package/skills/github/githubAction/assets/starter-workflows/ci/blank.yml +36 -0
  663. package/skills/github/githubAction/assets/starter-workflows/ci/docker-image.yml +18 -0
  664. package/skills/github/githubAction/assets/starter-workflows/ci/go.yml +28 -0
  665. package/skills/github/githubAction/assets/starter-workflows/ci/maven.yml +35 -0
  666. package/skills/github/githubAction/assets/starter-workflows/ci/node.js.yml +31 -0
  667. package/skills/github/githubAction/assets/starter-workflows/ci/python-app.yml +39 -0
  668. package/skills/github/githubAction/assets/starter-workflows/ci/rust.yml +22 -0
  669. package/skills/github/githubAction/assets/starter-workflows/code-scanning/codeql.yml +97 -0
  670. package/skills/github/githubAction/evals/actionVerification.json +14 -0
  671. package/skills/github/githubAction/references/apiReference.md +3 -0
  672. package/skills/github/githubAction/references/workflowPatterns.md +81 -0
  673. package/skills/github/githubAction/scripts/validateWorkflowYaml.py +53 -0
  674. package/skills/github/githubQuality/SKILL.md +136 -0
  675. package/skills/github/githubQuality/assets/README.md +24 -0
  676. package/skills/github/githubQuality/assets/pull-requests/about-code-owners.md +178 -0
  677. package/skills/github/githubQuality/assets/pull-requests/about-merge-methods.md +48 -0
  678. package/skills/github/githubQuality/assets/pull-requests/creating-a-pull-request.md +170 -0
  679. package/skills/github/githubQuality/assets/pull-requests/giving-reviews.md +48 -0
  680. package/skills/github/githubQuality/assets/pull-requests/managing-a-merge-queue.md +134 -0
  681. package/skills/github/githubQuality/assets/pull-requests/merging-a-pull-request.md +101 -0
  682. package/skills/github/githubQuality/assets/pull-requests/resolving-reviews.md +59 -0
  683. package/skills/github/githubQuality/assets/pull-requests/status-checks.md +135 -0
  684. package/skills/github/githubQuality/assets/rest-api/checks-runs.md +1013 -0
  685. package/skills/github/githubQuality/assets/rest-api/checks-suites.md +1142 -0
  686. package/skills/github/githubQuality/assets/rest-api/commits.md +957 -0
  687. package/skills/github/githubQuality/assets/rest-api/pulls.md +1605 -0
  688. package/skills/github/githubQuality/assets/rest-api/reviews.md +722 -0
  689. package/skills/github/githubQuality/evals/qualityVerification.json +14 -0
  690. package/skills/github/githubQuality/references/apiReference.md +3 -0
  691. package/skills/github/githubQuality/references/codeownersExample.md +26 -0
  692. package/skills/github/githubQuality/references/prTemplate.md +20 -0
  693. package/skills/github/githubQuality/scripts/auditPrQuality.py +52 -0
  694. package/skills/github/githubSecurity/SKILL.md +170 -0
  695. package/skills/github/githubSecurity/assets/README.md +32 -0
  696. package/skills/github/githubSecurity/assets/code-scanning/code-scanning-alerts.md +133 -0
  697. package/skills/github/githubSecurity/assets/code-scanning/code-scanning.md +67 -0
  698. package/skills/github/githubSecurity/assets/code-scanning/codeql-code-scanning.md +79 -0
  699. package/skills/github/githubSecurity/assets/code-scanning/configure-code-scanning.md +121 -0
  700. package/skills/github/githubSecurity/assets/dependabot/about-the-dependabot-yml-file.md +74 -0
  701. package/skills/github/githubSecurity/assets/dependabot/dependabot-alerts.md +133 -0
  702. package/skills/github/githubSecurity/assets/dependabot/dependabot-security-updates.md +95 -0
  703. package/skills/github/githubSecurity/assets/dependabot/dependabot-version-updates.md +80 -0
  704. package/skills/github/githubSecurity/assets/rest-api/code-scanning.md +2957 -0
  705. package/skills/github/githubSecurity/assets/rest-api/dependabot-alerts.md +895 -0
  706. package/skills/github/githubSecurity/assets/rest-api/secret-scanning.md +947 -0
  707. package/skills/github/githubSecurity/assets/secret-scanning/enable-secret-scanning.md +59 -0
  708. package/skills/github/githubSecurity/assets/secret-scanning/secret-scanning.md +105 -0
  709. package/skills/github/githubSecurity/assets/security-advisories/github-advisory-database.md +148 -0
  710. package/skills/github/githubSecurity/evals/securityVerification.json +14 -0
  711. package/skills/github/githubSecurity/references/apiReference.md +3 -0
  712. package/skills/github/githubSecurity/references/codeqlAnalysis.yml +42 -0
  713. package/skills/github/githubSecurity/references/dependabotConfig.yml +27 -0
  714. package/skills/github/githubSecurity/scripts/auditRepoSecurity.py +47 -0
  715. package/skills/github/githubSetup/SKILL.md +137 -0
  716. package/skills/github/githubSetup/assets/README.md +40 -0
  717. package/skills/github/githubSetup/assets/branches/about-protected-branches.md +198 -0
  718. package/skills/github/githubSetup/assets/branches/changing-the-default-branch.md +49 -0
  719. package/skills/github/githubSetup/assets/branches/deleting-and-restoring-branches.md +44 -0
  720. package/skills/github/githubSetup/assets/branches/managing-a-branch-protection-rule.md +115 -0
  721. package/skills/github/githubSetup/assets/branches/renaming-a-branch.md +74 -0
  722. package/skills/github/githubSetup/assets/branches/viewing-branches-in-your-repository.md +30 -0
  723. package/skills/github/githubSetup/assets/repositories/about-repositories.md +127 -0
  724. package/skills/github/githubSetup/assets/repositories/cloning-a-repository.md +114 -0
  725. package/skills/github/githubSetup/assets/repositories/creating-a-new-repository.md +82 -0
  726. package/skills/github/githubSetup/assets/repositories/creating-a-repository-from-a-template.md +51 -0
  727. package/skills/github/githubSetup/assets/repositories/deleting-a-repository.md +34 -0
  728. package/skills/github/githubSetup/assets/repositories/managing-teams-and-people-with-access.md +69 -0
  729. package/skills/github/githubSetup/assets/repositories/renaming-a-repository.md +47 -0
  730. package/skills/github/githubSetup/assets/repositories/restoring-a-deleted-repository.md +61 -0
  731. package/skills/github/githubSetup/assets/repositories/setting-repository-visibility.md +137 -0
  732. package/skills/github/githubSetup/assets/rest-api/branches.md +727 -0
  733. package/skills/github/githubSetup/assets/rest-api/quickstart.md +344 -0
  734. package/skills/github/githubSetup/assets/rest-api/repos.md +2957 -0
  735. package/skills/github/githubSetup/assets/rulesets/about-rulesets.md +72 -0
  736. package/skills/github/githubSetup/assets/rulesets/available-rules-for-rulesets.md +383 -0
  737. package/skills/github/githubSetup/assets/rulesets/converting-branch-protections-to-rulesets.md +92 -0
  738. package/skills/github/githubSetup/assets/rulesets/creating-rulesets-for-a-repository.md +108 -0
  739. package/skills/github/githubSetup/assets/rulesets/managing-rulesets-for-a-repository.md +149 -0
  740. package/skills/github/githubSetup/assets/rulesets/troubleshooting-rules.md +122 -0
  741. package/skills/github/githubSetup/evals/setupVerification.json +14 -0
  742. package/skills/github/githubSetup/references/apiReference.md +3 -0
  743. package/skills/github/githubSetup/references/repoSettingsBlueprint.md +13 -0
  744. package/skills/github/githubSetup/references/rulesetTemplates.json +42 -0
  745. package/skills/github/githubSetup/scripts/configureRepoBaseline.py +46 -0
  746. package/skills/github/githubTeam/SKILL.md +115 -0
  747. package/skills/github/githubTeam/assets/README.md +21 -0
  748. package/skills/github/githubTeam/assets/organizations/about-organizations.md +69 -0
  749. package/skills/github/githubTeam/assets/organizations/repository-roles-for-an-organization.md +94 -0
  750. package/skills/github/githubTeam/assets/rest-api/collaborators.md +547 -0
  751. package/skills/github/githubTeam/assets/rest-api/orgs.md +1172 -0
  752. package/skills/github/githubTeam/assets/rest-api/teams.md +1690 -0
  753. package/skills/github/githubTeam/assets/teams/about-teams.md +82 -0
  754. package/skills/github/githubTeam/assets/teams/adding-members-to-a-team.md +55 -0
  755. package/skills/github/githubTeam/evals/teamVerification.json +14 -0
  756. package/skills/github/githubTeam/references/apiReference.md +3 -0
  757. package/skills/github/githubTeam/references/permissionMatrix.md +17 -0
  758. package/skills/github/githubTeam/references/reviewAssignment.md +17 -0
  759. package/skills/github/githubTeam/scripts/manageTeamSync.py +31 -0
  760. package/skills/securityQa/llmSecurityRedteaming/SKILL.md +86 -0
  761. package/skills/securityQa/llmSecurityRedteaming/evals/securityRedteamVerification.json +14 -0
  762. package/skills/securityQa/llmSecurityRedteaming/references/apiReference.md +3 -0
  763. package/skills/securityQa/llmSecurityRedteaming/references/jailbreakTaxonomy.md +6 -0
  764. package/skills/securityQa/llmSecurityRedteaming/references/owaspLlmTopTen.md +12 -0
  765. package/skills/securityQa/llmSecurityRedteaming/scripts/testPromptInjection.py +34 -0
  766. package/skills/softwareDevelopment/requirementsEngineering/SKILL.md +110 -0
  767. package/skills/softwareDevelopment/requirementsEngineering/evals/evalRequirements.py +33 -0
  768. package/skills/softwareDevelopment/requirementsEngineering/references/apiReference.md +3 -0
  769. package/skills/softwareDevelopment/requirementsEngineering/references/requirementsAnalysisModels.md +34 -0
  770. package/skills/softwareDevelopment/requirementsEngineering/scripts/validateUserStories.py +49 -0
  771. package/skills/testing/testDrivenDevelopment/SKILL.md +122 -0
  772. package/skills/testing/testDrivenDevelopment/evals/evalTdd.py +25 -0
  773. package/skills/testing/testDrivenDevelopment/references/apiReference.md +3 -0
  774. package/skills/testing/testDrivenDevelopment/references/testPyramidDoubles.md +35 -0
  775. package/skills/testing/testDrivenDevelopment/scripts/auditTestPyramid.py +58 -0
@@ -0,0 +1,1507 @@
1
+ # REST API endpoints for rules
2
+
3
+ Use the REST API to manage rulesets for repositories. Rulesets control how people can interact with selected branches and tags in a repository.
4
+
5
+ > [!NOTE]
6
+ > Most endpoints use `Authorization: Bearer <YOUR-TOKEN>` and `Accept: application/vnd.github+json` headers, plus `X-GitHub-Api-Version: 2026-03-10`. Curl examples below omit these standard headers for brevity.
7
+
8
+ ## Get rules for a branch
9
+
10
+ ```
11
+ GET /repos/{owner}/{repo}/rules/branches/{branch}
12
+ ```
13
+
14
+ Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
15
+ to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
16
+ at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
17
+ enforcement statuses are not returned.
18
+
19
+ ### Parameters
20
+
21
+ #### Headers
22
+
23
+ - **`accept`** (string)
24
+ Setting to `application/vnd.github+json` is recommended.
25
+
26
+ #### Path and query parameters
27
+
28
+ - **`owner`** (string) (required)
29
+ The account owner of the repository. The name is not case sensitive.
30
+
31
+ - **`repo`** (string) (required)
32
+ The name of the repository without the .git extension. The name is not case sensitive.
33
+
34
+ - **`branch`** (string) (required)
35
+ The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
36
+
37
+ - **`per_page`** (integer)
38
+ The number of results per page (max 100). For more information, see "Using pagination in the REST API."
39
+ Default: `30`
40
+
41
+ - **`page`** (integer)
42
+ The page number of the results to fetch. For more information, see "Using pagination in the REST API."
43
+ Default: `1`
44
+
45
+ ### HTTP response status codes
46
+
47
+ - **200** - OK
48
+
49
+ ### Code examples
50
+
51
+ #### Example
52
+
53
+ **Request:**
54
+
55
+ ```curl
56
+ curl -L \
57
+ -X GET \
58
+ https://api.github.com/repos/OWNER/REPO/rules/branches/BRANCH
59
+ ```
60
+
61
+ **Response schema (Status: 200):**
62
+
63
+ Array of `Repository Rule` objects: one of:
64
+ * **object**
65
+ * **object**
66
+ * **object**
67
+ * **object**
68
+ * **object**
69
+ * **object**
70
+ * **object**
71
+ * **object**
72
+ * **object**
73
+ * **object**
74
+ * **object**
75
+ * **object**
76
+ * **object**
77
+ * **object**
78
+ * **object**
79
+ * **object**
80
+ * **object**
81
+ * **object**
82
+ * **object**
83
+ * **object**
84
+ * **object**
85
+ * **object**
86
+ * **object**
87
+ * **object**
88
+ * **object**
89
+
90
+ ## Get all repository rulesets
91
+
92
+ ```
93
+ GET /repos/{owner}/{repo}/rulesets
94
+ ```
95
+
96
+ Get all the rulesets for a repository.
97
+
98
+ ### Parameters
99
+
100
+ #### Headers
101
+
102
+ - **`accept`** (string)
103
+ Setting to `application/vnd.github+json` is recommended.
104
+
105
+ #### Path and query parameters
106
+
107
+ - **`owner`** (string) (required)
108
+ The account owner of the repository. The name is not case sensitive.
109
+
110
+ - **`repo`** (string) (required)
111
+ The name of the repository without the .git extension. The name is not case sensitive.
112
+
113
+ - **`per_page`** (integer)
114
+ The number of results per page (max 100). For more information, see "Using pagination in the REST API."
115
+ Default: `30`
116
+
117
+ - **`page`** (integer)
118
+ The page number of the results to fetch. For more information, see "Using pagination in the REST API."
119
+ Default: `1`
120
+
121
+ - **`includes_parents`** (boolean)
122
+ Include rulesets configured at higher levels that apply to this repository
123
+ Default: `true`
124
+
125
+ - **`targets`** (string)
126
+ A comma-separated list of rule targets to filter by.
127
+ If provided, only rulesets that apply to the specified targets will be returned.
128
+ For example, branch,tag,push.
129
+
130
+ ### HTTP response status codes
131
+
132
+ - **200** - OK
133
+
134
+ - **404** - Resource not found
135
+
136
+ - **500** - Internal Error
137
+
138
+ ### Code examples
139
+
140
+ #### Example
141
+
142
+ **Request:**
143
+
144
+ ```curl
145
+ curl -L \
146
+ -X GET \
147
+ https://api.github.com/repos/OWNER/REPO/rulesets
148
+ ```
149
+
150
+ **Response schema (Status: 200):**
151
+
152
+ Array of `Repository ruleset`:
153
+ * `id`: required, integer
154
+ * `name`: required, string
155
+ * `target`: string, enum: `branch`, `tag`, `push`, `repository`
156
+ * `source_type`: string, enum: `Repository`, `Organization`, `Enterprise`
157
+ * `source`: required, string
158
+ * `enforcement`: required, string, enum: `disabled`, `active`, `evaluate`
159
+ * `bypass_actors`: array of `Repository Ruleset Bypass Actor`:
160
+ * `actor_id`: integer or null
161
+ * `actor_type`: required, string, enum: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, `DeployKey`, `User`
162
+ * `bypass_mode`: string, enum: `always`, `pull_request`, `exempt`, default: `"always"`
163
+ * `current_user_can_bypass`: string, enum: `always`, `pull_requests_only`, `never`, `exempt`
164
+ * `node_id`: string
165
+ * `_links`: object:
166
+ * `self`: object:
167
+ * `href`: string
168
+ * `html`: object or null:
169
+ * `href`: string
170
+ * `conditions`: any of:
171
+ * **Repository ruleset conditions for ref names**
172
+ * `ref_name`: object:
173
+ * `include`: array of string
174
+ * `exclude`: array of string
175
+ * **Organization ruleset conditions**
176
+ * `rules`: array of `Repository Rule`:
177
+ * one of:
178
+ * **creation**
179
+ * `type`: required, string, enum: `creation`
180
+ * **update**
181
+ * `type`: required, string, enum: `update`
182
+ * `parameters`: object:
183
+ * `update_allows_fetch_and_merge`: required, boolean
184
+ * **deletion**
185
+ * `type`: required, string, enum: `deletion`
186
+ * **required_linear_history**
187
+ * `type`: required, string, enum: `required_linear_history`
188
+ * **merge_queue**
189
+ * `type`: required, string, enum: `merge_queue`
190
+ * `parameters`: object:
191
+ * `check_response_timeout_minutes`: required, integer, minimum: 1, maximum: 360
192
+ * `grouping_strategy`: required, string, enum: `ALLGREEN`, `HEADGREEN`
193
+ * `max_entries_to_build`: required, integer, minimum: 0, maximum: 100
194
+ * `max_entries_to_merge`: required, integer, minimum: 0, maximum: 100
195
+ * `merge_method`: required, string, enum: `MERGE`, `SQUASH`, `REBASE`
196
+ * `min_entries_to_merge`: required, integer, minimum: 0, maximum: 100
197
+ * `min_entries_to_merge_wait_minutes`: required, integer, minimum: 0, maximum: 360
198
+ * **required_deployments**
199
+ * `type`: required, string, enum: `required_deployments`
200
+ * `parameters`: object:
201
+ * `required_deployment_environments`: required, array of string
202
+ * **required_signatures**
203
+ * `type`: required, string, enum: `required_signatures`
204
+ * **pull_request**
205
+ * `type`: required, string, enum: `pull_request`
206
+ * `parameters`: object:
207
+ * `allowed_merge_methods`: array of string, enum: `merge`, `squash`, `rebase`
208
+ * `dismiss_stale_reviews_on_push`: required, boolean
209
+ * `dismissal_restriction`: `DismissalRestriction`:
210
+ * `allowed_actors`: array of object
211
+ * `enabled`: required, boolean
212
+ * `require_code_owner_review`: required, boolean
213
+ * `require_extra_approval_for_unattributed_changes`: boolean
214
+ * `require_last_push_approval`: required, boolean
215
+ * `required_approving_review_count`: required, integer, minimum: 0, maximum: 10
216
+ * `required_review_thread_resolution`: required, boolean
217
+ * `required_reviewers`: array of `RequiredReviewerConfiguration`:
218
+ * `file_patterns`: required, array of string
219
+ * `minimum_approvals`: required, integer
220
+ * `reviewer`: required, object
221
+ * **required_status_checks**
222
+ * `type`: required, string, enum: `required_status_checks`
223
+ * `parameters`: object:
224
+ * `do_not_enforce_on_create`: boolean
225
+ * `required_status_checks`: required, array of `StatusCheckConfiguration`:
226
+ * `context`: required, string
227
+ * `integration_id`: integer
228
+ * `strict_required_status_checks_policy`: required, boolean
229
+ * **non_fast_forward**
230
+ * `type`: required, string, enum: `non_fast_forward`
231
+ * **commit_message_pattern**
232
+ * `type`: required, string, enum: `commit_message_pattern`
233
+ * `parameters`: object:
234
+ * `name`: string
235
+ * `negate`: boolean
236
+ * `operator`: required, string, enum: `starts_with`, `ends_with`, `contains`, `regex`
237
+ * `pattern`: required, string
238
+ * **commit_author_email_pattern**
239
+ * `type`: required, string, enum: `commit_author_email_pattern`
240
+ * `parameters`: object:
241
+ * `name`: string
242
+ * `negate`: boolean
243
+ * `operator`: required, string, enum: `starts_with`, `ends_with`, `contains`, `regex`
244
+ * `pattern`: required, string
245
+ * **committer_email_pattern**
246
+ * `type`: required, string, enum: `committer_email_pattern`
247
+ * `parameters`: object:
248
+ * `name`: string
249
+ * `negate`: boolean
250
+ * `operator`: required, string, enum: `starts_with`, `ends_with`, `contains`, `regex`
251
+ * `pattern`: required, string
252
+ * **branch_name_pattern**
253
+ * `type`: required, string, enum: `branch_name_pattern`
254
+ * `parameters`: object:
255
+ * `name`: string
256
+ * `negate`: boolean
257
+ * `operator`: required, string, enum: `starts_with`, `ends_with`, `contains`, `regex`
258
+ * `pattern`: required, string
259
+ * **tag_name_pattern**
260
+ * `type`: required, string, enum: `tag_name_pattern`
261
+ * `parameters`: object:
262
+ * `name`: string
263
+ * `negate`: boolean
264
+ * `operator`: required, string, enum: `starts_with`, `ends_with`, `contains`, `regex`
265
+ * `pattern`: required, string
266
+ * **workflows**
267
+ * `type`: required, string, enum: `workflows`
268
+ * `parameters`: object:
269
+ * `do_not_enforce_on_create`: boolean
270
+ * `workflows`: required, array of `WorkflowFileReference`:
271
+ * `path`: required, string
272
+ * `ref`: string
273
+ * `repository_id`: required, integer
274
+ * `sha`: string
275
+ * **code_scanning**
276
+ * `type`: required, string, enum: `code_scanning`
277
+ * `parameters`: object:
278
+ * `code_scanning_tools`: required, array of `CodeScanningTool`:
279
+ * `alerts_threshold`: required, string, enum: `none`, `errors`, `errors_and_warnings`, `all`
280
+ * `security_alerts_threshold`: required, string, enum: `none`, `critical`, `high_or_higher`, `medium_or_higher`, `all`
281
+ * `tool`: required, string
282
+ * **code_quality**
283
+ * `type`: required, string, enum: `code_quality`
284
+ * `parameters`: object:
285
+ * `severity`: required, string, enum: `errors`, `warnings`, `notes`, `all`
286
+ * **code_coverage**
287
+ * `type`: required, string, enum: `code_coverage`
288
+ * `parameters`: object:
289
+ * `max_coverage_drop`: number, format: float, minimum: 0, maximum: 100
290
+ * `minimum_coverage`: number, format: float, minimum: 0, maximum: 100
291
+ * **copilot_code_review**
292
+ * `type`: required, string, enum: `copilot_code_review`
293
+ * `parameters`: object:
294
+ * `review_draft_pull_requests`: boolean
295
+ * `review_on_push`: boolean
296
+ * **license_compliance_scanning**
297
+ * `type`: required, string, enum: `license_compliance_scanning`
298
+ * **file_path_restriction**
299
+ * `type`: required, string, enum: `file_path_restriction`
300
+ * `parameters`: object:
301
+ * `ignored_file_paths`: array of string
302
+ * `restricted_file_paths`: required, array of string
303
+ * **max_file_path_length**
304
+ * `type`: required, string, enum: `max_file_path_length`
305
+ * `parameters`: object:
306
+ * `max_file_path_length`: required, integer, minimum: 1, maximum: 32767
307
+ * **file_extension_restriction**
308
+ * `type`: required, string, enum: `file_extension_restriction`
309
+ * `parameters`: object:
310
+ * `restricted_file_extensions`: required, array of string
311
+ * **max_file_size**
312
+ * `type`: required, string, enum: `max_file_size`
313
+ * `parameters`: object:
314
+ * `ignored_file_paths`: array of string
315
+ * `max_file_size`: required, integer, minimum: 1, maximum: 100
316
+ * `created_at`: string, format: date-time
317
+ * `updated_at`: string, format: date-time
318
+
319
+ ## Create a repository ruleset
320
+
321
+ ```
322
+ POST /repos/{owner}/{repo}/rulesets
323
+ ```
324
+
325
+ Create a ruleset for a repository.
326
+
327
+ ### Parameters
328
+
329
+ #### Headers
330
+
331
+ - **`accept`** (string)
332
+ Setting to `application/vnd.github+json` is recommended.
333
+
334
+ #### Path and query parameters
335
+
336
+ - **`owner`** (string) (required)
337
+ The account owner of the repository. The name is not case sensitive.
338
+
339
+ - **`repo`** (string) (required)
340
+ The name of the repository without the .git extension. The name is not case sensitive.
341
+
342
+ #### Body parameters
343
+
344
+ - **`name`** (string) (required)
345
+ The name of the ruleset.
346
+
347
+ - **`target`** (string)
348
+ The target of the ruleset
349
+ Default: `branch`
350
+ Can be one of: `branch`, `tag`, `push`
351
+
352
+ - **`enforcement`** (string) (required)
353
+ The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (evaluate is only available with GitHub Enterprise).
354
+ Can be one of: `disabled`, `active`, `evaluate`
355
+
356
+ - **`bypass_actors`** (array of objects)
357
+ The actors that can bypass the rules in this ruleset
358
+ - **`actor_id`** (integer or null)
359
+ The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, Team, and User actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. OrganizationAdmin is not applicable for personal repositories.
360
+ - **`actor_type`** (string) (required)
361
+ The type of actor that can bypass a ruleset.
362
+ Can be one of: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, `DeployKey`, `User`
363
+ - **`bypass_mode`** (string)
364
+ When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets. When bypass_mode is exempt, rules will not be run for that actor and a bypass audit entry will not be created.
365
+ Default: `always`
366
+ Can be one of: `always`, `pull_request`, `exempt`
367
+
368
+ - **`conditions`** (object)
369
+ Parameters for a repository ruleset ref name condition
370
+ - **`ref_name`** (object)
371
+ - **`include`** (array of strings)
372
+ Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.
373
+ - **`exclude`** (array of strings)
374
+ Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
375
+
376
+ - **`rules`** (array of objects)
377
+ An array of rules within the ruleset.
378
+ - **`creation`** (object)
379
+ Only allow users with bypass permission to create matching refs.
380
+ - **`type`** (string) (required)
381
+ Can be one of: `creation`
382
+ - **`update`** (object)
383
+ Only allow users with bypass permission to update matching refs.
384
+ - **`type`** (string) (required)
385
+ Can be one of: `update`
386
+ - **`parameters`** (object)
387
+ - **`update_allows_fetch_and_merge`** (boolean) (required)
388
+ Branch can pull changes from its upstream repository
389
+ - **`deletion`** (object)
390
+ Only allow users with bypass permissions to delete matching refs.
391
+ - **`type`** (string) (required)
392
+ Can be one of: `deletion`
393
+ - **`required_linear_history`** (object)
394
+ Prevent merge commits from being pushed to matching refs.
395
+ - **`type`** (string) (required)
396
+ Can be one of: `required_linear_history`
397
+ - **`merge_queue`** (object)
398
+ Merges must be performed via a merge queue.
399
+ - **`type`** (string) (required)
400
+ Can be one of: `merge_queue`
401
+ - **`parameters`** (object)
402
+ - **`check_response_timeout_minutes`** (integer) (required)
403
+ Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
404
+ - **`grouping_strategy`** (string) (required)
405
+ When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
406
+ Can be one of: `ALLGREEN`, `HEADGREEN`
407
+ - **`max_entries_to_build`** (integer) (required)
408
+ Limit the number of queued pull requests requesting checks and workflow runs at the same time.
409
+ - **`max_entries_to_merge`** (integer) (required)
410
+ The maximum number of PRs that will be merged together in a group.
411
+ - **`merge_method`** (string) (required)
412
+ Method to use when merging changes from queued pull requests.
413
+ Can be one of: `MERGE`, `SQUASH`, `REBASE`
414
+ - **`min_entries_to_merge`** (integer) (required)
415
+ The minimum number of PRs that will be merged together in a group.
416
+ - **`min_entries_to_merge_wait_minutes`** (integer) (required)
417
+ The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
418
+ - **`required_deployments`** (object)
419
+ Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
420
+ - **`type`** (string) (required)
421
+ Can be one of: `required_deployments`
422
+ - **`parameters`** (object)
423
+ - **`required_deployment_environments`** (array of strings) (required)
424
+ The environments that must be successfully deployed to before branches can be merged.
425
+ - **`required_signatures`** (object)
426
+ Commits pushed to matching refs must have verified signatures.
427
+ - **`type`** (string) (required)
428
+ Can be one of: `required_signatures`
429
+ - **`pull_request`** (object)
430
+ Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
431
+ - **`type`** (string) (required)
432
+ Can be one of: `pull_request`
433
+ - **`parameters`** (object)
434
+ - **`allowed_merge_methods`** (array of strings)
435
+ Array of allowed merge methods. Allowed values include merge, squash, and rebase. At least one option must be enabled.
436
+ Supported values are: merge, squash, rebase
437
+ - **`dismiss_stale_reviews_on_push`** (boolean) (required)
438
+ New, reviewable commits pushed will dismiss previous pull request review approvals.
439
+ - **`dismissal_restriction`** (object)
440
+ Specify people, teams, or apps allowed to dismiss pull request reviews.
441
+ - **`allowed_actors`** (array of objects)
442
+ Specify people, teams, or apps allowed to dismiss pull request reviews.
443
+ - **`id`** (integer) (required)
444
+ ID of the actor that can dismiss reviews.
445
+ - **`type`** (string) (required)
446
+ The type of the actor
447
+ Can be one of: `User`, `Team`, `IntegrationInstallation`, `RepositoryRole`
448
+ - **`enabled`** (boolean) (required)
449
+ Whether to restrict review dismissal to specific actors.
450
+ - **`require_code_owner_review`** (boolean) (required)
451
+ Require an approving review in pull requests that modify files that have a designated code owner.
452
+ - **`require_extra_approval_for_unattributed_changes`** (boolean)
453
+ When Copilot opens a pull request without a human collaborator, require one more approving review if a non-zero approval count is required.
454
+ - **`require_last_push_approval`** (boolean) (required)
455
+ Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
456
+ - **`required_approving_review_count`** (integer) (required)
457
+ The number of approving reviews that are required before a pull request can be merged.
458
+ - **`required_review_thread_resolution`** (boolean) (required)
459
+ All conversations on code must be resolved before a pull request can be merged.
460
+ - **`required_reviewers`** (array of objects)
461
+ A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
462
+ - **`file_patterns`** (array of strings) (required)
463
+ Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
464
+ - **`minimum_approvals`** (integer) (required)
465
+ Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
466
+ - **`reviewer`** (object) (required)
467
+ A required reviewing team
468
+ - **`id`** (integer) (required)
469
+ ID of the reviewer which must review changes to matching files.
470
+ - **`type`** (string) (required)
471
+ The type of the reviewer
472
+ Can be one of: `Team`
473
+ - **`required_status_checks`** (object)
474
+ Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
475
+ - **`type`** (string) (required)
476
+ Can be one of: `required_status_checks`
477
+ - **`parameters`** (object)
478
+ - **`do_not_enforce_on_create`** (boolean)
479
+ Allow repositories and branches to be created if a check would otherwise prohibit it.
480
+ - **`required_status_checks`** (array of objects) (required)
481
+ Status checks that are required.
482
+ - **`context`** (string) (required)
483
+ The status check context name that must be present on the commit.
484
+ - **`integration_id`** (integer)
485
+ The optional integration ID that this status check must originate from.
486
+ - **`strict_required_status_checks_policy`** (boolean) (required)
487
+ Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.
488
+ - **`non_fast_forward`** (object)
489
+ Prevent users with push access from force pushing to refs.
490
+ - **`type`** (string) (required)
491
+ Can be one of: `non_fast_forward`
492
+ - **`commit_message_pattern`** (object)
493
+ Parameters to be used for the commit_message_pattern rule
494
+ - **`type`** (string) (required)
495
+ Can be one of: `commit_message_pattern`
496
+ - **`parameters`** (object)
497
+ - **`name`** (string)
498
+ How this rule appears when configuring it.
499
+ - **`negate`** (boolean)
500
+ If true, the rule will fail if the pattern matches.
501
+ - **`operator`** (string) (required)
502
+ The operator to use for matching.
503
+ Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
504
+ - **`pattern`** (string) (required)
505
+ The pattern to match with.
506
+ - **`commit_author_email_pattern`** (object)
507
+ Parameters to be used for the commit_author_email_pattern rule
508
+ - **`type`** (string) (required)
509
+ Can be one of: `commit_author_email_pattern`
510
+ - **`parameters`** (object)
511
+ - **`name`** (string)
512
+ How this rule appears when configuring it.
513
+ - **`negate`** (boolean)
514
+ If true, the rule will fail if the pattern matches.
515
+ - **`operator`** (string) (required)
516
+ The operator to use for matching.
517
+ Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
518
+ - **`pattern`** (string) (required)
519
+ The pattern to match with.
520
+ - **`committer_email_pattern`** (object)
521
+ Parameters to be used for the committer_email_pattern rule
522
+ - **`type`** (string) (required)
523
+ Can be one of: `committer_email_pattern`
524
+ - **`parameters`** (object)
525
+ - **`name`** (string)
526
+ How this rule appears when configuring it.
527
+ - **`negate`** (boolean)
528
+ If true, the rule will fail if the pattern matches.
529
+ - **`operator`** (string) (required)
530
+ The operator to use for matching.
531
+ Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
532
+ - **`pattern`** (string) (required)
533
+ The pattern to match with.
534
+ - **`branch_name_pattern`** (object)
535
+ Parameters to be used for the branch_name_pattern rule
536
+ - **`type`** (string) (required)
537
+ Can be one of: `branch_name_pattern`
538
+ - **`parameters`** (object)
539
+ - **`name`** (string)
540
+ How this rule appears when configuring it.
541
+ - **`negate`** (boolean)
542
+ If true, the rule will fail if the pattern matches.
543
+ - **`operator`** (string) (required)
544
+ The operator to use for matching.
545
+ Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
546
+ - **`pattern`** (string) (required)
547
+ The pattern to match with.
548
+ - **`tag_name_pattern`** (object)
549
+ Parameters to be used for the tag_name_pattern rule
550
+ - **`type`** (string) (required)
551
+ Can be one of: `tag_name_pattern`
552
+ - **`parameters`** (object)
553
+ - **`name`** (string)
554
+ How this rule appears when configuring it.
555
+ - **`negate`** (boolean)
556
+ If true, the rule will fail if the pattern matches.
557
+ - **`operator`** (string) (required)
558
+ The operator to use for matching.
559
+ Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
560
+ - **`pattern`** (string) (required)
561
+ The pattern to match with.
562
+ - **`workflows`** (object)
563
+ Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
564
+ - **`type`** (string) (required)
565
+ Can be one of: `workflows`
566
+ - **`parameters`** (object)
567
+ - **`do_not_enforce_on_create`** (boolean)
568
+ Allow repositories and branches to be created if a check would otherwise prohibit it.
569
+ - **`workflows`** (array of objects) (required)
570
+ Workflows that must pass for this rule to pass.
571
+ - **`path`** (string) (required)
572
+ The path to the workflow file
573
+ - **`ref`** (string)
574
+ The ref (branch or tag) of the workflow file to use
575
+ - **`repository_id`** (integer) (required)
576
+ The ID of the repository where the workflow is defined
577
+ - **`sha`** (string)
578
+ The commit SHA of the workflow file to use
579
+ - **`code_scanning`** (object)
580
+ Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
581
+ - **`type`** (string) (required)
582
+ Can be one of: `code_scanning`
583
+ - **`parameters`** (object)
584
+ - **`code_scanning_tools`** (array of objects) (required)
585
+ Tools that must provide code scanning results for this rule to pass.
586
+ - **`alerts_threshold`** (string) (required)
587
+ The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts."
588
+ Can be one of: `none`, `errors`, `errors_and_warnings`, `all`
589
+ - **`security_alerts_threshold`** (string) (required)
590
+ The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts."
591
+ Can be one of: `none`, `critical`, `high_or_higher`, `medium_or_higher`, `all`
592
+ - **`tool`** (string) (required)
593
+ The name of a code scanning tool
594
+ - **`code_quality`** (object)
595
+ Choose which severity levels of code quality results should block pull request merges. When configured, a code quality analysis must be done on the pull request before the changes can be merged.
596
+ - **`type`** (string) (required)
597
+ Can be one of: `code_quality`
598
+ - **`parameters`** (object)
599
+ - **`severity`** (string) (required)
600
+ The lowest severity level at which code quality reviews need to be resolved before commits can be merged.
601
+ Can be one of: `errors`, `warnings`, `notes`, `all`
602
+ - **`code_coverage`** (object)
603
+ Enforce minimum line coverage thresholds on pull requests. This rule evaluates uploaded coverage data but does not wait for coverage uploads. To ensure coverage is evaluated before merging, make each status check associated with a coverage upload a required status check.
604
+ - **`type`** (string) (required)
605
+ Can be one of: `code_coverage`
606
+ - **`parameters`** (object)
607
+ - **`max_coverage_drop`** (number)
608
+ The maximum percentage points that line coverage may drop relative to the default branch. Pull requests that reduce line coverage by more than this amount will be blocked.
609
+ - **`minimum_coverage`** (number)
610
+ The absolute minimum line coverage percentage required. Pull requests with line coverage below this threshold will be blocked.
611
+ - **`copilot_code_review`** (object)
612
+ Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and AI credits.
613
+ - **`type`** (string) (required)
614
+ Can be one of: `copilot_code_review`
615
+ - **`parameters`** (object)
616
+ - **`review_draft_pull_requests`** (boolean)
617
+ Copilot automatically reviews draft pull requests before they are marked as ready for review.
618
+ - **`review_on_push`** (boolean)
619
+ Copilot automatically reviews each new push to the pull request.
620
+ - **`license_compliance_scanning`** (object)
621
+ Enforce any added or changed dependencies to comply with the organization's license policy.
622
+ - **`type`** (string) (required)
623
+ Can be one of: `license_compliance_scanning`
624
+ - **`file_path_restriction`** (object)
625
+ Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.
626
+ - **`type`** (string) (required)
627
+ Can be one of: `file_path_restriction`
628
+ - **`parameters`** (object)
629
+ - **`ignored_file_paths`** (array of strings)
630
+ Files matching these patterns are allowed even when they also match a restricted path.
631
+ - **`restricted_file_paths`** (array of strings) (required)
632
+ The file paths that are restricted from being pushed to the commit graph.
633
+ - **`max_file_path_length`** (object)
634
+ Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.
635
+ - **`type`** (string) (required)
636
+ Can be one of: `max_file_path_length`
637
+ - **`parameters`** (object)
638
+ - **`max_file_path_length`** (integer) (required)
639
+ The maximum amount of characters allowed in file paths.
640
+ - **`file_extension_restriction`** (object)
641
+ Prevent commits that include files with specified file extensions from being pushed to the commit graph.
642
+ - **`type`** (string) (required)
643
+ Can be one of: `file_extension_restriction`
644
+ - **`parameters`** (object)
645
+ - **`restricted_file_extensions`** (array of strings) (required)
646
+ The file extensions that are restricted from being pushed to the commit graph.
647
+ - **`max_file_size`** (object)
648
+ Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.
649
+ - **`type`** (string) (required)
650
+ Can be one of: `max_file_size`
651
+ - **`parameters`** (object)
652
+ - **`ignored_file_paths`** (array of strings)
653
+ Files matching these patterns may exceed the maximum size.
654
+ - **`max_file_size`** (integer) (required)
655
+ The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).
656
+
657
+ ### HTTP response status codes
658
+
659
+ - **201** - Created
660
+
661
+ - **404** - Resource not found
662
+
663
+ - **422** - Validation failed, or the endpoint has been spammed.
664
+
665
+ - **500** - Internal Error
666
+
667
+ ### Code examples
668
+
669
+ #### Example
670
+
671
+ **Request:**
672
+
673
+ ```curl
674
+ curl -L \
675
+ -X POST \
676
+ https://api.github.com/repos/OWNER/REPO/rulesets \
677
+ -d '{
678
+ "name": "super cool ruleset",
679
+ "target": "branch",
680
+ "enforcement": "active",
681
+ "bypass_actors": [
682
+ {
683
+ "actor_id": 234,
684
+ "actor_type": "Team",
685
+ "bypass_mode": "always"
686
+ }
687
+ ],
688
+ "conditions": {
689
+ "ref_name": {
690
+ "include": [
691
+ "refs/heads/main",
692
+ "refs/heads/master"
693
+ ],
694
+ "exclude": [
695
+ "refs/heads/dev*"
696
+ ]
697
+ }
698
+ },
699
+ "rules": [
700
+ {
701
+ "type": "commit_author_email_pattern",
702
+ "parameters": {
703
+ "operator": "contains",
704
+ "pattern": "github"
705
+ }
706
+ }
707
+ ]
708
+ }'
709
+ ```
710
+
711
+ **Response schema (Status: 201):**
712
+
713
+ * `id`: required, integer
714
+ * `name`: required, string
715
+ * `target`: string, enum: `branch`, `tag`, `push`, `repository`
716
+ * `source_type`: string, enum: `Repository`, `Organization`, `Enterprise`
717
+ * `source`: required, string
718
+ * `enforcement`: required, string, enum: `disabled`, `active`, `evaluate`
719
+ * `bypass_actors`: array of `Repository Ruleset Bypass Actor`:
720
+ * `actor_id`: integer or null
721
+ * `actor_type`: required, string, enum: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, `DeployKey`, `User`
722
+ * `bypass_mode`: string, enum: `always`, `pull_request`, `exempt`, default: `"always"`
723
+ * `current_user_can_bypass`: string, enum: `always`, `pull_requests_only`, `never`, `exempt`
724
+ * `node_id`: string
725
+ * `_links`: object:
726
+ * `self`: object:
727
+ * `href`: string
728
+ * `html`: object or null:
729
+ * `href`: string
730
+ * `conditions`: any of:
731
+ * **Repository ruleset conditions for ref names**
732
+ * `ref_name`: object:
733
+ * `include`: array of string
734
+ * `exclude`: array of string
735
+ * **Organization ruleset conditions**
736
+ * `rules`: array of `Repository Rule`:
737
+ * one of:
738
+ * **creation**
739
+ * `type`: required, string, enum: `creation`
740
+ * **update**
741
+ * `type`: required, string, enum: `update`
742
+ * `parameters`: object:
743
+ * `update_allows_fetch_and_merge`: required, boolean
744
+ * **deletion**
745
+ * `type`: required, string, enum: `deletion`
746
+ * **required_linear_history**
747
+ * `type`: required, string, enum: `required_linear_history`
748
+ * **merge_queue**
749
+ * `type`: required, string, enum: `merge_queue`
750
+ * `parameters`: object:
751
+ * `check_response_timeout_minutes`: required, integer, minimum: 1, maximum: 360
752
+ * `grouping_strategy`: required, string, enum: `ALLGREEN`, `HEADGREEN`
753
+ * `max_entries_to_build`: required, integer, minimum: 0, maximum: 100
754
+ * `max_entries_to_merge`: required, integer, minimum: 0, maximum: 100
755
+ * `merge_method`: required, string, enum: `MERGE`, `SQUASH`, `REBASE`
756
+ * `min_entries_to_merge`: required, integer, minimum: 0, maximum: 100
757
+ * `min_entries_to_merge_wait_minutes`: required, integer, minimum: 0, maximum: 360
758
+ * **required_deployments**
759
+ * `type`: required, string, enum: `required_deployments`
760
+ * `parameters`: object:
761
+ * `required_deployment_environments`: required, array of string
762
+ * **required_signatures**
763
+ * `type`: required, string, enum: `required_signatures`
764
+ * **pull_request**
765
+ * `type`: required, string, enum: `pull_request`
766
+ * `parameters`: object:
767
+ * `allowed_merge_methods`: array of string, enum: `merge`, `squash`, `rebase`
768
+ * `dismiss_stale_reviews_on_push`: required, boolean
769
+ * `dismissal_restriction`: `DismissalRestriction`:
770
+ * `allowed_actors`: array of `Actor`:
771
+ * `id`: required, integer
772
+ * `type`: required, string, enum: `User`, `Team`, `IntegrationInstallation`, `RepositoryRole`
773
+ * `enabled`: required, boolean
774
+ * `require_code_owner_review`: required, boolean
775
+ * `require_extra_approval_for_unattributed_changes`: boolean
776
+ * `require_last_push_approval`: required, boolean
777
+ * `required_approving_review_count`: required, integer, minimum: 0, maximum: 10
778
+ * `required_review_thread_resolution`: required, boolean
779
+ * `required_reviewers`: array of `RequiredReviewerConfiguration`:
780
+ * `file_patterns`: required, array of string
781
+ * `minimum_approvals`: required, integer
782
+ * `reviewer`: required, `Reviewer`:
783
+ * `id`: required, integer
784
+ * `type`: required, string, enum: `Team`
785
+ * **required_status_checks**
786
+ * `type`: required, string, enum: `required_status_checks`
787
+ * `parameters`: object:
788
+ * `do_not_enforce_on_create`: boolean
789
+ * `required_status_checks`: required, array of `StatusCheckConfiguration`:
790
+ * `context`: required, string
791
+ * `integration_id`: integer
792
+ * `strict_required_status_checks_policy`: required, boolean
793
+ * **non_fast_forward**
794
+ * `type`: required, string, enum: `non_fast_forward`
795
+ * **commit_message_pattern**
796
+ * `type`: required, string, enum: `commit_message_pattern`
797
+ * `parameters`: object:
798
+ * `name`: string
799
+ * `negate`: boolean
800
+ * `operator`: required, string, enum: `starts_with`, `ends_with`, `contains`, `regex`
801
+ * `pattern`: required, string
802
+ * **commit_author_email_pattern**
803
+ * `type`: required, string, enum: `commit_author_email_pattern`
804
+ * `parameters`: object:
805
+ * `name`: string
806
+ * `negate`: boolean
807
+ * `operator`: required, string, enum: `starts_with`, `ends_with`, `contains`, `regex`
808
+ * `pattern`: required, string
809
+ * **committer_email_pattern**
810
+ * `type`: required, string, enum: `committer_email_pattern`
811
+ * `parameters`: object:
812
+ * `name`: string
813
+ * `negate`: boolean
814
+ * `operator`: required, string, enum: `starts_with`, `ends_with`, `contains`, `regex`
815
+ * `pattern`: required, string
816
+ * **branch_name_pattern**
817
+ * `type`: required, string, enum: `branch_name_pattern`
818
+ * `parameters`: object:
819
+ * `name`: string
820
+ * `negate`: boolean
821
+ * `operator`: required, string, enum: `starts_with`, `ends_with`, `contains`, `regex`
822
+ * `pattern`: required, string
823
+ * **tag_name_pattern**
824
+ * `type`: required, string, enum: `tag_name_pattern`
825
+ * `parameters`: object:
826
+ * `name`: string
827
+ * `negate`: boolean
828
+ * `operator`: required, string, enum: `starts_with`, `ends_with`, `contains`, `regex`
829
+ * `pattern`: required, string
830
+ * **workflows**
831
+ * `type`: required, string, enum: `workflows`
832
+ * `parameters`: object:
833
+ * `do_not_enforce_on_create`: boolean
834
+ * `workflows`: required, array of `WorkflowFileReference`:
835
+ * `path`: required, string
836
+ * `ref`: string
837
+ * `repository_id`: required, integer
838
+ * `sha`: string
839
+ * **code_scanning**
840
+ * `type`: required, string, enum: `code_scanning`
841
+ * `parameters`: object:
842
+ * `code_scanning_tools`: required, array of `CodeScanningTool`:
843
+ * `alerts_threshold`: required, string, enum: `none`, `errors`, `errors_and_warnings`, `all`
844
+ * `security_alerts_threshold`: required, string, enum: `none`, `critical`, `high_or_higher`, `medium_or_higher`, `all`
845
+ * `tool`: required, string
846
+ * **code_quality**
847
+ * `type`: required, string, enum: `code_quality`
848
+ * `parameters`: object:
849
+ * `severity`: required, string, enum: `errors`, `warnings`, `notes`, `all`
850
+ * **code_coverage**
851
+ * `type`: required, string, enum: `code_coverage`
852
+ * `parameters`: object:
853
+ * `max_coverage_drop`: number, format: float, minimum: 0, maximum: 100
854
+ * `minimum_coverage`: number, format: float, minimum: 0, maximum: 100
855
+ * **copilot_code_review**
856
+ * `type`: required, string, enum: `copilot_code_review`
857
+ * `parameters`: object:
858
+ * `review_draft_pull_requests`: boolean
859
+ * `review_on_push`: boolean
860
+ * **license_compliance_scanning**
861
+ * `type`: required, string, enum: `license_compliance_scanning`
862
+ * **file_path_restriction**
863
+ * `type`: required, string, enum: `file_path_restriction`
864
+ * `parameters`: object:
865
+ * `ignored_file_paths`: array of string
866
+ * `restricted_file_paths`: required, array of string
867
+ * **max_file_path_length**
868
+ * `type`: required, string, enum: `max_file_path_length`
869
+ * `parameters`: object:
870
+ * `max_file_path_length`: required, integer, minimum: 1, maximum: 32767
871
+ * **file_extension_restriction**
872
+ * `type`: required, string, enum: `file_extension_restriction`
873
+ * `parameters`: object:
874
+ * `restricted_file_extensions`: required, array of string
875
+ * **max_file_size**
876
+ * `type`: required, string, enum: `max_file_size`
877
+ * `parameters`: object:
878
+ * `ignored_file_paths`: array of string
879
+ * `max_file_size`: required, integer, minimum: 1, maximum: 100
880
+ * `created_at`: string, format: date-time
881
+ * `updated_at`: string, format: date-time
882
+
883
+ ## Get a repository ruleset
884
+
885
+ ```
886
+ GET /repos/{owner}/{repo}/rulesets/{ruleset_id}
887
+ ```
888
+
889
+ Get a ruleset for a repository.
890
+ Note: To prevent leaking sensitive information, the bypass_actors property is only returned if the user
891
+ making the API request has write access to the ruleset.
892
+
893
+ ### Parameters
894
+
895
+ #### Headers
896
+
897
+ - **`accept`** (string)
898
+ Setting to `application/vnd.github+json` is recommended.
899
+
900
+ #### Path and query parameters
901
+
902
+ - **`owner`** (string) (required)
903
+ The account owner of the repository. The name is not case sensitive.
904
+
905
+ - **`repo`** (string) (required)
906
+ The name of the repository without the .git extension. The name is not case sensitive.
907
+
908
+ - **`ruleset_id`** (integer) (required)
909
+ The ID of the ruleset.
910
+
911
+ - **`includes_parents`** (boolean)
912
+ Include rulesets configured at higher levels that apply to this repository
913
+ Default: `true`
914
+
915
+ ### HTTP response status codes
916
+
917
+ - **200** - OK
918
+
919
+ - **404** - Resource not found
920
+
921
+ - **500** - Internal Error
922
+
923
+ ### Code examples
924
+
925
+ #### Example
926
+
927
+ **Request:**
928
+
929
+ ```curl
930
+ curl -L \
931
+ -X GET \
932
+ https://api.github.com/repos/OWNER/REPO/rulesets/RULESET_ID
933
+ ```
934
+
935
+ **Response schema (Status: 200):**
936
+
937
+ Same response schema as [Create a repository ruleset](#create-a-repository-ruleset).
938
+
939
+ ## Update a repository ruleset
940
+
941
+ ```
942
+ PUT /repos/{owner}/{repo}/rulesets/{ruleset_id}
943
+ ```
944
+
945
+ Update a ruleset for a repository.
946
+
947
+ ### Parameters
948
+
949
+ #### Headers
950
+
951
+ - **`accept`** (string)
952
+ Setting to `application/vnd.github+json` is recommended.
953
+
954
+ #### Path and query parameters
955
+
956
+ - **`owner`** (string) (required)
957
+ The account owner of the repository. The name is not case sensitive.
958
+
959
+ - **`repo`** (string) (required)
960
+ The name of the repository without the .git extension. The name is not case sensitive.
961
+
962
+ - **`ruleset_id`** (integer) (required)
963
+ The ID of the ruleset.
964
+
965
+ #### Body parameters
966
+
967
+ - **`name`** (string)
968
+ The name of the ruleset.
969
+
970
+ - **`target`** (string)
971
+ The target of the ruleset
972
+ Can be one of: `branch`, `tag`, `push`
973
+
974
+ - **`enforcement`** (string)
975
+ The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (evaluate is only available with GitHub Enterprise).
976
+ Can be one of: `disabled`, `active`, `evaluate`
977
+
978
+ - **`bypass_actors`** (array of objects)
979
+ The actors that can bypass the rules in this ruleset
980
+ - **`actor_id`** (integer or null)
981
+ The ID of the actor that can bypass a ruleset. Required for Integration, RepositoryRole, Team, and User actor types. If actor_type is OrganizationAdmin, actor_id is ignored. If actor_type is DeployKey, this should be null. OrganizationAdmin is not applicable for personal repositories.
982
+ - **`actor_type`** (string) (required)
983
+ The type of actor that can bypass a ruleset.
984
+ Can be one of: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, `DeployKey`, `User`
985
+ - **`bypass_mode`** (string)
986
+ When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type. Also, pull_request is only applicable to branch rulesets. When bypass_mode is exempt, rules will not be run for that actor and a bypass audit entry will not be created.
987
+ Default: `always`
988
+ Can be one of: `always`, `pull_request`, `exempt`
989
+
990
+ - **`conditions`** (object)
991
+ Parameters for a repository ruleset ref name condition
992
+ - **`ref_name`** (object)
993
+ - **`include`** (array of strings)
994
+ Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.
995
+ - **`exclude`** (array of strings)
996
+ Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
997
+
998
+ - **`rules`** (array of objects)
999
+ An array of rules within the ruleset.
1000
+ - **`creation`** (object)
1001
+ Only allow users with bypass permission to create matching refs.
1002
+ - **`type`** (string) (required)
1003
+ Can be one of: `creation`
1004
+ - **`update`** (object)
1005
+ Only allow users with bypass permission to update matching refs.
1006
+ - **`type`** (string) (required)
1007
+ Can be one of: `update`
1008
+ - **`parameters`** (object)
1009
+ - **`update_allows_fetch_and_merge`** (boolean) (required)
1010
+ Branch can pull changes from its upstream repository
1011
+ - **`deletion`** (object)
1012
+ Only allow users with bypass permissions to delete matching refs.
1013
+ - **`type`** (string) (required)
1014
+ Can be one of: `deletion`
1015
+ - **`required_linear_history`** (object)
1016
+ Prevent merge commits from being pushed to matching refs.
1017
+ - **`type`** (string) (required)
1018
+ Can be one of: `required_linear_history`
1019
+ - **`merge_queue`** (object)
1020
+ Merges must be performed via a merge queue.
1021
+ - **`type`** (string) (required)
1022
+ Can be one of: `merge_queue`
1023
+ - **`parameters`** (object)
1024
+ - **`check_response_timeout_minutes`** (integer) (required)
1025
+ Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
1026
+ - **`grouping_strategy`** (string) (required)
1027
+ When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.
1028
+ Can be one of: `ALLGREEN`, `HEADGREEN`
1029
+ - **`max_entries_to_build`** (integer) (required)
1030
+ Limit the number of queued pull requests requesting checks and workflow runs at the same time.
1031
+ - **`max_entries_to_merge`** (integer) (required)
1032
+ The maximum number of PRs that will be merged together in a group.
1033
+ - **`merge_method`** (string) (required)
1034
+ Method to use when merging changes from queued pull requests.
1035
+ Can be one of: `MERGE`, `SQUASH`, `REBASE`
1036
+ - **`min_entries_to_merge`** (integer) (required)
1037
+ The minimum number of PRs that will be merged together in a group.
1038
+ - **`min_entries_to_merge_wait_minutes`** (integer) (required)
1039
+ The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
1040
+ - **`required_deployments`** (object)
1041
+ Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
1042
+ - **`type`** (string) (required)
1043
+ Can be one of: `required_deployments`
1044
+ - **`parameters`** (object)
1045
+ - **`required_deployment_environments`** (array of strings) (required)
1046
+ The environments that must be successfully deployed to before branches can be merged.
1047
+ - **`required_signatures`** (object)
1048
+ Commits pushed to matching refs must have verified signatures.
1049
+ - **`type`** (string) (required)
1050
+ Can be one of: `required_signatures`
1051
+ - **`pull_request`** (object)
1052
+ Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
1053
+ - **`type`** (string) (required)
1054
+ Can be one of: `pull_request`
1055
+ - **`parameters`** (object)
1056
+ - **`allowed_merge_methods`** (array of strings)
1057
+ Array of allowed merge methods. Allowed values include merge, squash, and rebase. At least one option must be enabled.
1058
+ Supported values are: merge, squash, rebase
1059
+ - **`dismiss_stale_reviews_on_push`** (boolean) (required)
1060
+ New, reviewable commits pushed will dismiss previous pull request review approvals.
1061
+ - **`dismissal_restriction`** (object)
1062
+ Specify people, teams, or apps allowed to dismiss pull request reviews.
1063
+ - **`allowed_actors`** (array of objects)
1064
+ Specify people, teams, or apps allowed to dismiss pull request reviews.
1065
+ - **`id`** (integer) (required)
1066
+ ID of the actor that can dismiss reviews.
1067
+ - **`type`** (string) (required)
1068
+ The type of the actor
1069
+ Can be one of: `User`, `Team`, `IntegrationInstallation`, `RepositoryRole`
1070
+ - **`enabled`** (boolean) (required)
1071
+ Whether to restrict review dismissal to specific actors.
1072
+ - **`require_code_owner_review`** (boolean) (required)
1073
+ Require an approving review in pull requests that modify files that have a designated code owner.
1074
+ - **`require_extra_approval_for_unattributed_changes`** (boolean)
1075
+ When Copilot opens a pull request without a human collaborator, require one more approving review if a non-zero approval count is required.
1076
+ - **`require_last_push_approval`** (boolean) (required)
1077
+ Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
1078
+ - **`required_approving_review_count`** (integer) (required)
1079
+ The number of approving reviews that are required before a pull request can be merged.
1080
+ - **`required_review_thread_resolution`** (boolean) (required)
1081
+ All conversations on code must be resolved before a pull request can be merged.
1082
+ - **`required_reviewers`** (array of objects)
1083
+ A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
1084
+ - **`file_patterns`** (array of strings) (required)
1085
+ Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
1086
+ - **`minimum_approvals`** (integer) (required)
1087
+ Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
1088
+ - **`reviewer`** (object) (required)
1089
+ A required reviewing team
1090
+ - **`id`** (integer) (required)
1091
+ ID of the reviewer which must review changes to matching files.
1092
+ - **`type`** (string) (required)
1093
+ The type of the reviewer
1094
+ Can be one of: `Team`
1095
+ - **`required_status_checks`** (object)
1096
+ Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
1097
+ - **`type`** (string) (required)
1098
+ Can be one of: `required_status_checks`
1099
+ - **`parameters`** (object)
1100
+ - **`do_not_enforce_on_create`** (boolean)
1101
+ Allow repositories and branches to be created if a check would otherwise prohibit it.
1102
+ - **`required_status_checks`** (array of objects) (required)
1103
+ Status checks that are required.
1104
+ - **`context`** (string) (required)
1105
+ The status check context name that must be present on the commit.
1106
+ - **`integration_id`** (integer)
1107
+ The optional integration ID that this status check must originate from.
1108
+ - **`strict_required_status_checks_policy`** (boolean) (required)
1109
+ Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.
1110
+ - **`non_fast_forward`** (object)
1111
+ Prevent users with push access from force pushing to refs.
1112
+ - **`type`** (string) (required)
1113
+ Can be one of: `non_fast_forward`
1114
+ - **`commit_message_pattern`** (object)
1115
+ Parameters to be used for the commit_message_pattern rule
1116
+ - **`type`** (string) (required)
1117
+ Can be one of: `commit_message_pattern`
1118
+ - **`parameters`** (object)
1119
+ - **`name`** (string)
1120
+ How this rule appears when configuring it.
1121
+ - **`negate`** (boolean)
1122
+ If true, the rule will fail if the pattern matches.
1123
+ - **`operator`** (string) (required)
1124
+ The operator to use for matching.
1125
+ Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
1126
+ - **`pattern`** (string) (required)
1127
+ The pattern to match with.
1128
+ - **`commit_author_email_pattern`** (object)
1129
+ Parameters to be used for the commit_author_email_pattern rule
1130
+ - **`type`** (string) (required)
1131
+ Can be one of: `commit_author_email_pattern`
1132
+ - **`parameters`** (object)
1133
+ - **`name`** (string)
1134
+ How this rule appears when configuring it.
1135
+ - **`negate`** (boolean)
1136
+ If true, the rule will fail if the pattern matches.
1137
+ - **`operator`** (string) (required)
1138
+ The operator to use for matching.
1139
+ Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
1140
+ - **`pattern`** (string) (required)
1141
+ The pattern to match with.
1142
+ - **`committer_email_pattern`** (object)
1143
+ Parameters to be used for the committer_email_pattern rule
1144
+ - **`type`** (string) (required)
1145
+ Can be one of: `committer_email_pattern`
1146
+ - **`parameters`** (object)
1147
+ - **`name`** (string)
1148
+ How this rule appears when configuring it.
1149
+ - **`negate`** (boolean)
1150
+ If true, the rule will fail if the pattern matches.
1151
+ - **`operator`** (string) (required)
1152
+ The operator to use for matching.
1153
+ Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
1154
+ - **`pattern`** (string) (required)
1155
+ The pattern to match with.
1156
+ - **`branch_name_pattern`** (object)
1157
+ Parameters to be used for the branch_name_pattern rule
1158
+ - **`type`** (string) (required)
1159
+ Can be one of: `branch_name_pattern`
1160
+ - **`parameters`** (object)
1161
+ - **`name`** (string)
1162
+ How this rule appears when configuring it.
1163
+ - **`negate`** (boolean)
1164
+ If true, the rule will fail if the pattern matches.
1165
+ - **`operator`** (string) (required)
1166
+ The operator to use for matching.
1167
+ Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
1168
+ - **`pattern`** (string) (required)
1169
+ The pattern to match with.
1170
+ - **`tag_name_pattern`** (object)
1171
+ Parameters to be used for the tag_name_pattern rule
1172
+ - **`type`** (string) (required)
1173
+ Can be one of: `tag_name_pattern`
1174
+ - **`parameters`** (object)
1175
+ - **`name`** (string)
1176
+ How this rule appears when configuring it.
1177
+ - **`negate`** (boolean)
1178
+ If true, the rule will fail if the pattern matches.
1179
+ - **`operator`** (string) (required)
1180
+ The operator to use for matching.
1181
+ Can be one of: `starts_with`, `ends_with`, `contains`, `regex`
1182
+ - **`pattern`** (string) (required)
1183
+ The pattern to match with.
1184
+ - **`workflows`** (object)
1185
+ Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
1186
+ - **`type`** (string) (required)
1187
+ Can be one of: `workflows`
1188
+ - **`parameters`** (object)
1189
+ - **`do_not_enforce_on_create`** (boolean)
1190
+ Allow repositories and branches to be created if a check would otherwise prohibit it.
1191
+ - **`workflows`** (array of objects) (required)
1192
+ Workflows that must pass for this rule to pass.
1193
+ - **`path`** (string) (required)
1194
+ The path to the workflow file
1195
+ - **`ref`** (string)
1196
+ The ref (branch or tag) of the workflow file to use
1197
+ - **`repository_id`** (integer) (required)
1198
+ The ID of the repository where the workflow is defined
1199
+ - **`sha`** (string)
1200
+ The commit SHA of the workflow file to use
1201
+ - **`code_scanning`** (object)
1202
+ Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
1203
+ - **`type`** (string) (required)
1204
+ Can be one of: `code_scanning`
1205
+ - **`parameters`** (object)
1206
+ - **`code_scanning_tools`** (array of objects) (required)
1207
+ Tools that must provide code scanning results for this rule to pass.
1208
+ - **`alerts_threshold`** (string) (required)
1209
+ The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts."
1210
+ Can be one of: `none`, `errors`, `errors_and_warnings`, `all`
1211
+ - **`security_alerts_threshold`** (string) (required)
1212
+ The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts."
1213
+ Can be one of: `none`, `critical`, `high_or_higher`, `medium_or_higher`, `all`
1214
+ - **`tool`** (string) (required)
1215
+ The name of a code scanning tool
1216
+ - **`code_quality`** (object)
1217
+ Choose which severity levels of code quality results should block pull request merges. When configured, a code quality analysis must be done on the pull request before the changes can be merged.
1218
+ - **`type`** (string) (required)
1219
+ Can be one of: `code_quality`
1220
+ - **`parameters`** (object)
1221
+ - **`severity`** (string) (required)
1222
+ The lowest severity level at which code quality reviews need to be resolved before commits can be merged.
1223
+ Can be one of: `errors`, `warnings`, `notes`, `all`
1224
+ - **`code_coverage`** (object)
1225
+ Enforce minimum line coverage thresholds on pull requests. This rule evaluates uploaded coverage data but does not wait for coverage uploads. To ensure coverage is evaluated before merging, make each status check associated with a coverage upload a required status check.
1226
+ - **`type`** (string) (required)
1227
+ Can be one of: `code_coverage`
1228
+ - **`parameters`** (object)
1229
+ - **`max_coverage_drop`** (number)
1230
+ The maximum percentage points that line coverage may drop relative to the default branch. Pull requests that reduce line coverage by more than this amount will be blocked.
1231
+ - **`minimum_coverage`** (number)
1232
+ The absolute minimum line coverage percentage required. Pull requests with line coverage below this threshold will be blocked.
1233
+ - **`copilot_code_review`** (object)
1234
+ Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and AI credits.
1235
+ - **`type`** (string) (required)
1236
+ Can be one of: `copilot_code_review`
1237
+ - **`parameters`** (object)
1238
+ - **`review_draft_pull_requests`** (boolean)
1239
+ Copilot automatically reviews draft pull requests before they are marked as ready for review.
1240
+ - **`review_on_push`** (boolean)
1241
+ Copilot automatically reviews each new push to the pull request.
1242
+ - **`license_compliance_scanning`** (object)
1243
+ Enforce any added or changed dependencies to comply with the organization's license policy.
1244
+ - **`type`** (string) (required)
1245
+ Can be one of: `license_compliance_scanning`
1246
+ - **`file_path_restriction`** (object)
1247
+ Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.
1248
+ - **`type`** (string) (required)
1249
+ Can be one of: `file_path_restriction`
1250
+ - **`parameters`** (object)
1251
+ - **`ignored_file_paths`** (array of strings)
1252
+ Files matching these patterns are allowed even when they also match a restricted path.
1253
+ - **`restricted_file_paths`** (array of strings) (required)
1254
+ The file paths that are restricted from being pushed to the commit graph.
1255
+ - **`max_file_path_length`** (object)
1256
+ Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.
1257
+ - **`type`** (string) (required)
1258
+ Can be one of: `max_file_path_length`
1259
+ - **`parameters`** (object)
1260
+ - **`max_file_path_length`** (integer) (required)
1261
+ The maximum amount of characters allowed in file paths.
1262
+ - **`file_extension_restriction`** (object)
1263
+ Prevent commits that include files with specified file extensions from being pushed to the commit graph.
1264
+ - **`type`** (string) (required)
1265
+ Can be one of: `file_extension_restriction`
1266
+ - **`parameters`** (object)
1267
+ - **`restricted_file_extensions`** (array of strings) (required)
1268
+ The file extensions that are restricted from being pushed to the commit graph.
1269
+ - **`max_file_size`** (object)
1270
+ Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.
1271
+ - **`type`** (string) (required)
1272
+ Can be one of: `max_file_size`
1273
+ - **`parameters`** (object)
1274
+ - **`ignored_file_paths`** (array of strings)
1275
+ Files matching these patterns may exceed the maximum size.
1276
+ - **`max_file_size`** (integer) (required)
1277
+ The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).
1278
+
1279
+ ### HTTP response status codes
1280
+
1281
+ - **200** - OK
1282
+
1283
+ - **404** - Resource not found
1284
+
1285
+ - **422** - Validation failed, or the endpoint has been spammed.
1286
+
1287
+ - **500** - Internal Error
1288
+
1289
+ ### Code examples
1290
+
1291
+ #### Example
1292
+
1293
+ **Request:**
1294
+
1295
+ ```curl
1296
+ curl -L \
1297
+ -X PUT \
1298
+ https://api.github.com/repos/OWNER/REPO/rulesets/RULESET_ID \
1299
+ -d '{
1300
+ "name": "super cool ruleset",
1301
+ "target": "branch",
1302
+ "enforcement": "active",
1303
+ "bypass_actors": [
1304
+ {
1305
+ "actor_id": 234,
1306
+ "actor_type": "Team",
1307
+ "bypass_mode": "always"
1308
+ }
1309
+ ],
1310
+ "conditions": {
1311
+ "ref_name": {
1312
+ "include": [
1313
+ "refs/heads/main",
1314
+ "refs/heads/master"
1315
+ ],
1316
+ "exclude": [
1317
+ "refs/heads/dev*"
1318
+ ]
1319
+ }
1320
+ },
1321
+ "rules": [
1322
+ {
1323
+ "type": "commit_author_email_pattern",
1324
+ "parameters": {
1325
+ "operator": "contains",
1326
+ "pattern": "github"
1327
+ }
1328
+ }
1329
+ ]
1330
+ }'
1331
+ ```
1332
+
1333
+ **Response schema (Status: 200):**
1334
+
1335
+ Same response schema as [Create a repository ruleset](#create-a-repository-ruleset).
1336
+
1337
+ ## Delete a repository ruleset
1338
+
1339
+ ```
1340
+ DELETE /repos/{owner}/{repo}/rulesets/{ruleset_id}
1341
+ ```
1342
+
1343
+ Delete a ruleset for a repository.
1344
+
1345
+ ### Parameters
1346
+
1347
+ #### Headers
1348
+
1349
+ - **`accept`** (string)
1350
+ Setting to `application/vnd.github+json` is recommended.
1351
+
1352
+ #### Path and query parameters
1353
+
1354
+ - **`owner`** (string) (required)
1355
+ The account owner of the repository. The name is not case sensitive.
1356
+
1357
+ - **`repo`** (string) (required)
1358
+ The name of the repository without the .git extension. The name is not case sensitive.
1359
+
1360
+ - **`ruleset_id`** (integer) (required)
1361
+ The ID of the ruleset.
1362
+
1363
+ ### HTTP response status codes
1364
+
1365
+ - **204** - No Content
1366
+
1367
+ - **404** - Resource not found
1368
+
1369
+ - **500** - Internal Error
1370
+
1371
+ ### Code examples
1372
+
1373
+ #### Example
1374
+
1375
+ **Request:**
1376
+
1377
+ ```curl
1378
+ curl -L \
1379
+ -X DELETE \
1380
+ https://api.github.com/repos/OWNER/REPO/rulesets/RULESET_ID
1381
+ ```
1382
+
1383
+ **Response schema (Status: 204):**
1384
+
1385
+ ## Get repository ruleset history
1386
+
1387
+ ```
1388
+ GET /repos/{owner}/{repo}/rulesets/{ruleset_id}/history
1389
+ ```
1390
+
1391
+ Get the history of a repository ruleset.
1392
+
1393
+ ### Parameters
1394
+
1395
+ #### Headers
1396
+
1397
+ - **`accept`** (string)
1398
+ Setting to `application/vnd.github+json` is recommended.
1399
+
1400
+ #### Path and query parameters
1401
+
1402
+ - **`owner`** (string) (required)
1403
+ The account owner of the repository. The name is not case sensitive.
1404
+
1405
+ - **`repo`** (string) (required)
1406
+ The name of the repository without the .git extension. The name is not case sensitive.
1407
+
1408
+ - **`per_page`** (integer)
1409
+ The number of results per page (max 100). For more information, see "Using pagination in the REST API."
1410
+ Default: `30`
1411
+
1412
+ - **`page`** (integer)
1413
+ The page number of the results to fetch. For more information, see "Using pagination in the REST API."
1414
+ Default: `1`
1415
+
1416
+ - **`ruleset_id`** (integer) (required)
1417
+ The ID of the ruleset.
1418
+
1419
+ ### HTTP response status codes
1420
+
1421
+ - **200** - OK
1422
+
1423
+ - **404** - Resource not found
1424
+
1425
+ - **500** - Internal Error
1426
+
1427
+ ### Code examples
1428
+
1429
+ #### Example
1430
+
1431
+ **Request:**
1432
+
1433
+ ```curl
1434
+ curl -L \
1435
+ -X GET \
1436
+ https://api.github.com/repos/OWNER/REPO/rulesets/RULESET_ID/history
1437
+ ```
1438
+
1439
+ **Response schema (Status: 200):**
1440
+
1441
+ Array of `Ruleset version`:
1442
+ * `version_id`: required, integer
1443
+ * `actor`: required, object:
1444
+ * `id`: integer
1445
+ * `type`: string
1446
+ * `updated_at`: required, string, format: date-time
1447
+
1448
+ ## Get repository ruleset version
1449
+
1450
+ ```
1451
+ GET /repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}
1452
+ ```
1453
+
1454
+ Get a version of a repository ruleset.
1455
+
1456
+ ### Parameters
1457
+
1458
+ #### Headers
1459
+
1460
+ - **`accept`** (string)
1461
+ Setting to `application/vnd.github+json` is recommended.
1462
+
1463
+ #### Path and query parameters
1464
+
1465
+ - **`owner`** (string) (required)
1466
+ The account owner of the repository. The name is not case sensitive.
1467
+
1468
+ - **`repo`** (string) (required)
1469
+ The name of the repository without the .git extension. The name is not case sensitive.
1470
+
1471
+ - **`ruleset_id`** (integer) (required)
1472
+ The ID of the ruleset.
1473
+
1474
+ - **`version_id`** (integer) (required)
1475
+ The ID of the version
1476
+
1477
+ ### HTTP response status codes
1478
+
1479
+ - **200** - OK
1480
+
1481
+ - **404** - Resource not found
1482
+
1483
+ - **500** - Internal Error
1484
+
1485
+ ### Code examples
1486
+
1487
+ #### Example
1488
+
1489
+ **Request:**
1490
+
1491
+ ```curl
1492
+ curl -L \
1493
+ -X GET \
1494
+ https://api.github.com/repos/OWNER/REPO/rulesets/RULESET_ID/history/VERSION_ID
1495
+ ```
1496
+
1497
+ **Response schema (Status: 200):**
1498
+
1499
+ * all of:
1500
+ * **Ruleset version**
1501
+ * `version_id`: required, integer
1502
+ * `actor`: required, object:
1503
+ * `id`: integer
1504
+ * `type`: string
1505
+ * `updated_at`: required, string, format: date-time
1506
+ * **object**
1507
+ * `state`: required, object