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,1721 @@
1
+ ---
2
+ title: Workflow syntax for GitHub Actions
3
+ shortTitle: Workflow syntax
4
+ intro: A workflow is a configurable automated process made up of one or more jobs. You must create a YAML file to define your workflow configuration.
5
+ redirect_from:
6
+ - /articles/workflow-syntax-for-github-actions
7
+ - /github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
8
+ - /actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
9
+ - /actions/learn-github-actions/workflow-syntax-for-github-actions
10
+ - /actions/using-workflows/workflow-syntax-for-github-actions
11
+ - /actions/writing-workflows/workflow-syntax-for-github-actions
12
+ - /actions/reference/github_token-reference
13
+ - /actions/reference/workflow-syntax-for-github-actions
14
+ versions:
15
+ fpt: '*'
16
+ ghes: '*'
17
+ ghec: '*'
18
+ category:
19
+ - Write workflows
20
+ contentType: reference
21
+ ---
22
+
23
+ {% data reusables.actions.enterprise-github-hosted-runners %}
24
+
25
+ ## About YAML syntax for workflows
26
+
27
+ Workflow files use YAML syntax, and must have either a `.yml` or `.yaml` file extension. {% data reusables.actions.learn-more-about-yaml %}
28
+
29
+ You must store workflow files in the `.github/workflows` directory of your repository.
30
+
31
+ {% ifversion copilot %}
32
+
33
+ > [!TIP]
34
+ > Unlike traditional {% data variables.product.prodname_actions %} workflows that require you to script every decision as YAML job steps, {% data variables.copilot.github_agentic_workflows %} use YAML frontmatter for triggers and configuration, but let you describe what you want in natural-language Markdown—so you don't need to anticipate and encode every scenario in advance. For more information, see [AUTOTITLE](/copilot/how-tos/github-agentic-workflows/creating-github-agentic-workflows).
35
+
36
+ {% endif %}
37
+ ## `name`
38
+
39
+ {% data reusables.actions.workflows.workflow-syntax-name %}
40
+
41
+ ## `run-name`
42
+
43
+ The name for workflow runs generated from the workflow. {% data variables.product.prodname_dotcom %} displays the workflow run name in the list of workflow runs on your repository's "Actions" tab. If `run-name` is omitted or is only whitespace, then the run name is set to event-specific information for the workflow run. For example, for a workflow triggered by a `push` or `pull_request` event, it is set as the commit message or the title of the pull request.
44
+
45
+ This value can include expressions and can reference the [`github`](/actions/reference/workflows-and-actions/contexts#github-context) and [`inputs`](/actions/reference/workflows-and-actions/contexts#inputs-context) contexts.
46
+
47
+ ### Example of `run-name`
48
+
49
+ {% raw %}
50
+
51
+ ```yaml
52
+ run-name: Deploy to ${{ inputs.deploy_target }} by @${{ github.actor }}
53
+ ```
54
+
55
+ {% endraw %}
56
+
57
+ ## `on`
58
+
59
+ {% data reusables.actions.workflows.section-triggering-a-workflow %}
60
+
61
+ ## `on.<event_name>.types`
62
+
63
+ {% data reusables.actions.workflows.section-triggering-a-workflow-types %}
64
+
65
+ ## `on.<pull_request|pull_request_target>.<branches|branches-ignore>`
66
+
67
+ {% data reusables.actions.workflows.triggering-workflow-branches1 %}
68
+
69
+ ### Example: Including branches
70
+
71
+ {% data reusables.actions.workflows.triggering-workflow-branches2 %}
72
+
73
+ ### Example: Excluding branches
74
+
75
+ {% data reusables.actions.workflows.triggering-workflow-branches3 %}
76
+
77
+ ### Example: Including and excluding branches
78
+
79
+ {% data reusables.actions.workflows.triggering-workflow-branches4 %}
80
+
81
+ ## `on.merge_group.<branches|branches-ignore>`
82
+
83
+ When using the `merge_group` event, you can configure a workflow to run only for merge groups that target specific branches.
84
+
85
+ Use the `branches` filter when you want to include branch name patterns or when you want to both include and exclude branch name patterns. Use `branches-ignore` when you only want to exclude branch name patterns. You cannot use both `branches` and `branches-ignore` for the same event in a workflow.
86
+
87
+ The `branches` and `branches-ignore` filters accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch name. If a name contains any of these characters and you want a literal match, you need to escape each of these special characters with `\`. For more information about glob patterns, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet).
88
+
89
+ ### Example: Including branches
90
+
91
+ The patterns defined in `branches` are evaluated against the target branch's name. For example, the following workflow will run whenever there is a `merge_group` event for a merge group that targets:
92
+
93
+ * A branch named `main`
94
+ * A branch whose name starts with `releases/`
95
+
96
+ ```yaml
97
+ on:
98
+ merge_group:
99
+ types: [checks_requested]
100
+ branches:
101
+ - main
102
+ - 'releases/**'
103
+ ```
104
+
105
+ ### Example: Excluding branches
106
+
107
+ When a pattern matches the `branches-ignore` pattern, the workflow will not run. The patterns defined in `branches-ignore` are evaluated against the target branch's name. For example, the following workflow will run whenever there is a `merge_group` event unless the merge group targets:
108
+
109
+ * A branch named `canary`
110
+ * A branch whose name matches `releases/**-alpha`, like `releases/beta/3-alpha` <!-- markdownlint-disable-line outdated-release-phase-terminology -->
111
+
112
+ ```yaml
113
+ on:
114
+ merge_group:
115
+ types: [checks_requested]
116
+ branches-ignore:
117
+ - canary
118
+ - 'releases/**-alpha'
119
+ ```
120
+
121
+ ### Example: Including and excluding branches
122
+
123
+ You cannot use `branches` and `branches-ignore` to filter the same event in a single workflow. If you want to both include and exclude branch patterns for a single event, use the `branches` filter along with the `!` character to indicate which branches should be excluded.
124
+
125
+ If you define a branch with the `!` character, you must also define at least one branch without the `!` character. If you only want to exclude branches, use `branches-ignore` instead.
126
+
127
+ The order that you define patterns matters.
128
+
129
+ * A matching negative pattern (prefixed with `!`) after a positive match will exclude the branch.
130
+ * A matching positive pattern after a negative match will include the branch again.
131
+
132
+ The following workflow will run on `merge_group` events for merge groups that target `releases/10` or `releases/beta/mona`, but not for merge groups that target `releases/10-alpha` or `releases/beta/3-alpha` because the negative pattern `!releases/**-alpha` follows the positive pattern. <!-- markdownlint-disable-line outdated-release-phase-terminology -->
133
+
134
+ ```yaml
135
+ on:
136
+ merge_group:
137
+ types: [checks_requested]
138
+ branches:
139
+ - 'releases/**'
140
+ - '!releases/**-alpha'
141
+ ```
142
+
143
+ ## `on.push.<branches|tags|branches-ignore|tags-ignore>`
144
+
145
+ {% data reusables.actions.workflows.run-on-specific-branches-or-tags1 %}
146
+
147
+ ### Example: Including branches and tags
148
+
149
+ {% data reusables.actions.workflows.run-on-specific-branches-or-tags2 %}
150
+
151
+ ### Example: Excluding branches and tags
152
+
153
+ {% data reusables.actions.workflows.run-on-specific-branches-or-tags3 %}
154
+
155
+ ### Example: Including and excluding branches and tags
156
+
157
+ {% data reusables.actions.workflows.run-on-specific-branches-or-tags4 %}
158
+
159
+ ## `on.<push|pull_request|pull_request_target>.<paths|paths-ignore>`
160
+
161
+ {% data reusables.actions.workflows.triggering-a-workflow-paths1 %}
162
+
163
+ ### Example: Including paths
164
+
165
+ {% data reusables.actions.workflows.triggering-a-workflow-paths2 %}
166
+
167
+ ### Example: Excluding paths
168
+
169
+ {% data reusables.actions.workflows.triggering-a-workflow-paths3 %}
170
+
171
+ ### Example: Including and excluding paths
172
+
173
+ {% data reusables.actions.workflows.triggering-a-workflow-paths4 %}
174
+
175
+ ### Git diff comparisons
176
+
177
+ {% data reusables.actions.workflows.triggering-a-workflow-paths5 %}
178
+
179
+ ## `on.schedule`
180
+
181
+ You can use `on.schedule` to define a time schedule for your workflows.
182
+
183
+ {% data reusables.repositories.actions-scheduled-workflow-example %}
184
+
185
+ For more information about `schedule` events, see [AUTOTITLE](/actions/reference/workflows-and-actions/events-that-trigger-workflows#schedule).
186
+
187
+ ## `on.workflow_call`
188
+
189
+ Use `on.workflow_call` to define the inputs and outputs for a reusable workflow. You can also map the secrets that are available to the called workflow. For more information on reusable workflows, see [AUTOTITLE](/actions/how-tos/reuse-automations/reuse-workflows).
190
+
191
+ ## `on.workflow_call.inputs`
192
+
193
+ When using the `workflow_call` keyword, you can optionally specify inputs that are passed to the called workflow from the caller workflow. For more information about the `workflow_call` keyword, see [AUTOTITLE](/actions/reference/workflows-and-actions/events-that-trigger-workflows#workflow_call).
194
+
195
+ In addition to the standard input parameters that are available, `on.workflow_call.inputs` requires a `type` parameter. For more information, see [`on.workflow_call.inputs.<input_id>.type`](#onworkflow_callinputsinput_idtype).
196
+
197
+ If a `default` parameter is not set, the default value of the input is `false` for a boolean, `0` for a number, and `""` for a string.
198
+
199
+ Within the called workflow, you can use the `inputs` context to refer to an input. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/contexts#inputs-context).
200
+
201
+ If a caller workflow passes an input that is not specified in the called workflow, this results in an error.
202
+
203
+ ### Example of `on.workflow_call.inputs`
204
+
205
+ {% raw %}
206
+
207
+ ```yaml
208
+ on:
209
+ workflow_call:
210
+ inputs:
211
+ username:
212
+ description: 'A username passed from the caller workflow'
213
+ default: 'john-doe'
214
+ required: false
215
+ type: string
216
+
217
+ jobs:
218
+ print-username:
219
+ runs-on: ubuntu-latest
220
+
221
+ steps:
222
+ - name: Print the input name to STDOUT
223
+ run: echo The username is ${{ inputs.username }}
224
+ ```
225
+
226
+ {% endraw %}
227
+
228
+ For more information, see [AUTOTITLE](/actions/how-tos/reuse-automations/reuse-workflows).
229
+
230
+ ## `on.workflow_call.inputs.<input_id>.type`
231
+
232
+ Required if input is defined for the `on.workflow_call` keyword. The value of this parameter is a string specifying the data type of the input. This must be one of: `boolean`, `number`, or `string`.
233
+
234
+ ## `on.workflow_call.outputs`
235
+
236
+ A map of outputs for a called workflow. Called workflow outputs are available to all downstream jobs in the caller workflow. Each output has an identifier, an optional `description,` and a `value.` The `value` must be set to the value of an output from a job within the called workflow.
237
+
238
+ In the example below, two outputs are defined for this reusable workflow: `workflow_output1` and `workflow_output2`. These are mapped to outputs called `job_output1` and `job_output2`, both from a job called `my_job`.
239
+
240
+ ### Example of `on.workflow_call.outputs`
241
+
242
+ {% raw %}
243
+
244
+ ```yaml
245
+ on:
246
+ workflow_call:
247
+ # Map the workflow outputs to job outputs
248
+ outputs:
249
+ workflow_output1:
250
+ description: "The first job output"
251
+ value: ${{ jobs.my_job.outputs.job_output1 }}
252
+ workflow_output2:
253
+ description: "The second job output"
254
+ value: ${{ jobs.my_job.outputs.job_output2 }}
255
+ ```
256
+
257
+ {% endraw %}
258
+
259
+ For information on how to reference a job output, see [`jobs.<job_id>.outputs`](#jobsjob_idoutputs). For more information, see [AUTOTITLE](/actions/how-tos/reuse-automations/reuse-workflows).
260
+
261
+ ## `on.workflow_call.secrets`
262
+
263
+ A map of the secrets that can be used in the called workflow.
264
+
265
+ Within the called workflow, you can use the `secrets` context to refer to a secret.
266
+
267
+ > [!NOTE]
268
+ > If you are passing the secret to a nested reusable workflow, then you must use [`jobs.<job_id>.secrets`](#jobsjob_idsecrets) again to pass the secret. For more information, see [AUTOTITLE](/actions/how-tos/reuse-automations/reuse-workflows#passing-secrets-to-nested-workflows).
269
+
270
+ If a caller workflow passes a secret that is not specified in the called workflow, this results in an error.
271
+
272
+ ### Example of `on.workflow_call.secrets`
273
+
274
+ {% raw %}
275
+
276
+ ```yaml
277
+ on:
278
+ workflow_call:
279
+ secrets:
280
+ access-token:
281
+ description: 'A token passed from the caller workflow'
282
+ required: false
283
+
284
+ jobs:
285
+
286
+ pass-secret-to-action:
287
+ runs-on: ubuntu-latest
288
+ steps:
289
+ # passing the secret to an action
290
+ - name: Pass the received secret to an action
291
+ uses: ./.github/actions/my-action
292
+ with:
293
+ token: ${{ secrets.access-token }}
294
+
295
+ # passing the secret to a nested reusable workflow
296
+ pass-secret-to-workflow:
297
+ uses: ./.github/workflows/my-workflow
298
+ secrets:
299
+ token: ${{ secrets.access-token }}
300
+ ```
301
+
302
+ {% endraw %}
303
+
304
+ ## `on.workflow_call.secrets.<secret_id>`
305
+
306
+ A string identifier to associate with the secret.
307
+
308
+ ## `on.workflow_call.secrets.<secret_id>.required`
309
+
310
+ A boolean specifying whether the secret must be supplied.
311
+
312
+ ## `on.workflow_run.<branches|branches-ignore>`
313
+
314
+ {% data reusables.actions.workflows.section-specifying-branches %}
315
+
316
+ ## `on.workflow_run.workflows`
317
+
318
+ {% data reusables.actions.workflows.section-specifying-workflows %}
319
+
320
+ ## `on.workflow_dispatch`
321
+
322
+ {% data reusables.actions.workflow-dispatch %}
323
+
324
+ ## `on.workflow_dispatch.inputs`
325
+
326
+ {% data reusables.actions.workflow-dispatch-inputs %}
327
+
328
+ ### Example of `on.workflow_dispatch.inputs`
329
+
330
+ {% data reusables.actions.workflow-dispatch-inputs-example %}
331
+
332
+ ## `on.workflow_dispatch.inputs.<input_id>.required`
333
+
334
+ A boolean specifying whether the input must be supplied.
335
+
336
+ ## `on.workflow_dispatch.inputs.<input_id>.type`
337
+
338
+ The value of this parameter is a string specifying the data type of the input. This must be one of: `boolean`, `choice`, `number`, `environment` or `string`.
339
+
340
+ ## `on.workflow_dispatch.inputs.<input_id>.description`
341
+
342
+ A string description of the input parameter.
343
+
344
+ ## `on.workflow_dispatch.inputs.<input_id>.default`
345
+
346
+ The default value used when the input is not specified when the workflow is triggered manually. For inputs with `type: choice`, the default must be one of the values listed in `options`.
347
+
348
+ ## `on.workflow_dispatch.inputs.<input_id>.options`
349
+
350
+ A sequence of strings that sets the options of the dropdown list for an input with `type: choice`. `options` is valid only for `choice` inputs: a workflow that defines `options` on an input of any other type is invalid and fails to run.
351
+
352
+ ## `permissions`
353
+
354
+ {% data reusables.actions.jobs.section-assigning-permissions-to-jobs %}
355
+
356
+ ### Defining access for the `GITHUB_TOKEN` scopes
357
+
358
+ {% data reusables.actions.github-token-available-permissions %}
359
+
360
+ #### Changing the permissions in a forked repository
361
+
362
+ {% data reusables.actions.forked-write-permission %}
363
+
364
+ ### How permissions are calculated for a workflow job
365
+
366
+ The permissions for the `GITHUB_TOKEN` are initially set to the default setting for the enterprise, organization, or repository. If the default is set to the restricted permissions at any of these levels then this will apply to the relevant repositories. For example, if you choose the restricted default at the organization level then all repositories in that organization will use the restricted permissions as the default. The permissions are then adjusted based on any configuration within the workflow file, first at the workflow level and then at the job level. Finally, if the workflow was triggered by a pull request event other than `pull_request_target` from a forked repository, and the **Send write tokens to workflows from pull requests** setting is not selected, the permissions are adjusted to change any write permissions to read only.
367
+
368
+ ### Setting the `GITHUB_TOKEN` permissions for all jobs in a workflow
369
+
370
+ You can specify `permissions` at the top level of a workflow, so that the setting applies to all jobs in the workflow.
371
+
372
+ #### Example: Setting the `GITHUB_TOKEN` permissions for an entire workflow
373
+
374
+ {% data reusables.actions.jobs.setting-permissions-all-jobs-example %}
375
+
376
+ ### Using the `permissions` key for forked repositories
377
+
378
+ You can use the `permissions` key to add and remove `read` permissions for forked repositories, but typically you can't grant `write` access. The exception to this behavior is where an admin user has selected the **Send write tokens to workflows from pull requests** option in the {% data variables.product.prodname_actions %} settings. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-forks-of-private-repositories).
379
+
380
+ ### Permissions for workflow runs triggered by {% data variables.product.prodname_dependabot %}
381
+
382
+ {% data reusables.actions.workflow-runs-dependabot-note %}
383
+
384
+ ## `env`
385
+
386
+ A `map` of variables that are available to the steps of all jobs in the workflow. You can also set variables that are only available to the steps of a single job or to a single step. For more information, see [`jobs.<job_id>.env`](#jobsjob_idenv) and [`jobs.<job_id>.steps[*].env`](#jobsjob_idstepsenv).
387
+
388
+ Variables in the `env` map cannot be defined in terms of other variables in the map.
389
+
390
+ {% data reusables.repositories.actions-env-var-note %}
391
+
392
+ ### Example of `env`
393
+
394
+ ```yaml
395
+ env:
396
+ SERVER: production
397
+ ```
398
+
399
+ ## `defaults`
400
+
401
+ {% data reusables.actions.jobs.setting-default-values-for-jobs-defaults %}
402
+
403
+ ## `defaults.run`
404
+
405
+ {% data reusables.actions.jobs.setting-default-values-for-jobs-defaults-run %}
406
+
407
+ ## `defaults.run.shell`
408
+
409
+ {% data reusables.actions.jobs.setting-default-values-for-jobs-defaults-run-shell %}
410
+
411
+ ## `defaults.run.working-directory`
412
+
413
+ {% data reusables.actions.jobs.setting-default-values-for-jobs-defaults-run-working-directory %}
414
+
415
+ ## `concurrency`
416
+
417
+ {% data reusables.actions.jobs.section-using-concurrency %}
418
+
419
+ {% ifversion actions-cache-mode %}
420
+
421
+ ## `cache-mode`
422
+
423
+ Use `cache-mode` to control the level of {% data variables.product.prodname_actions %} cache access that jobs in the workflow are granted. Setting `cache-mode` at the top level applies to every job in the workflow, unless a job overrides it with [`jobs.<job_id>.cache-mode`](#jobsjob_idcache-mode).
424
+
425
+ Access is enforced with scoped cache tokens, so a job cannot restore or save caches beyond the mode it is granted. `cache-mode` accepts the following values.
426
+
427
+ | Value | Restore caches | Save caches |
428
+ | ----- | -------------- | ----------- |
429
+ | `read` | Yes | No |
430
+ | `write` | Yes | Yes |
431
+ | `write-only` | No | Yes |
432
+ | `none` | No | No |
433
+
434
+ If you omit `cache-mode`, a `read` or `write` default is used based on the trigger type. For trigger-dependent effective defaults, see [AUTOTITLE](/actions/reference/workflows-and-actions/dependency-caching#defaults).
435
+
436
+ > [!WARNING]
437
+ > Explicitly declaring `cache-mode: write` or `cache-mode: write-only` on low-trust triggers can bypass the secure default read-only cache restriction and reintroduce cache-poisoning risk. For guidance and mitigations, see [AUTOTITLE](/actions/reference/workflows-and-actions/dependency-caching#bypassing-the-default-untrusted-trigger-cache-restriction).
438
+
439
+ When a cache operation is not permitted by the effective mode, the cache step logs an informational message and continues. The job and workflow do not fail. A skipped restore is treated as a cache miss; a skipped save is simply not performed. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/dependency-caching#controlling-cache-access-with-cache-mode).
440
+
441
+ ### Example of `cache-mode`
442
+
443
+ ```yaml
444
+ cache-mode: read
445
+
446
+ jobs:
447
+ build:
448
+ runs-on: ubuntu-latest
449
+ steps:
450
+ - uses: {% data reusables.actions.action-checkout %}
451
+ - uses: {% data reusables.actions.action-cache %}
452
+ with:
453
+ path: ~/.npm
454
+ key: {% raw %}npm-${{ hashFiles('**/package-lock.json') }}{% endraw %}
455
+ ```
456
+
457
+ {% endif %}
458
+
459
+ ## `jobs`
460
+
461
+ {% data reusables.actions.jobs.section-using-jobs-in-a-workflow %}
462
+
463
+ ## `jobs.<job_id>`
464
+
465
+ {% data reusables.actions.jobs.section-using-jobs-in-a-workflow-id %}
466
+
467
+ ## `jobs.<job_id>.name`
468
+
469
+ {% data reusables.actions.jobs.section-using-jobs-in-a-workflow-name %}
470
+
471
+ ## `jobs.<job_id>.permissions`
472
+
473
+ {% data reusables.actions.jobs.section-assigning-permissions-to-jobs-specific %}
474
+
475
+ {% data reusables.actions.github-token-scope-descriptions %}
476
+
477
+ ### Defining access for the `GITHUB_TOKEN` scopes
478
+
479
+ {% data reusables.actions.github-token-available-permissions %}
480
+
481
+ #### Changing the permissions in a forked repository
482
+
483
+ {% data reusables.actions.forked-write-permission %}
484
+
485
+ #### Example: Setting the `GITHUB_TOKEN` permissions for one job in a workflow
486
+
487
+ {% data reusables.actions.jobs.setting-permissions-specific-jobs-example %}
488
+
489
+ ## `jobs.<job_id>.needs`
490
+
491
+ {% data reusables.actions.jobs.section-using-jobs-in-a-workflow-needs %}
492
+
493
+ ## `jobs.<job_id>.if`
494
+
495
+ {% data reusables.actions.jobs.section-using-conditions-to-control-job-execution %}
496
+
497
+ ## `jobs.<job_id>.runs-on`
498
+
499
+ {% data reusables.actions.jobs.choosing-runner-overview %}
500
+
501
+ ### Choosing {% data variables.product.prodname_dotcom %}-hosted runners
502
+
503
+ {% data reusables.actions.jobs.choosing-runner-github-hosted %}
504
+
505
+ ### Choosing self-hosted runners
506
+
507
+ {% data reusables.actions.jobs.choosing-runner-self-hosted %}
508
+
509
+ ### Choosing runners in a group
510
+
511
+ {% data reusables.actions.jobs.choosing-runner-group %}
512
+
513
+ {% ifversion not ghes %}
514
+
515
+ ## `jobs.<job_id>.snapshot`
516
+
517
+ {% data reusables.actions.jobs.choosing-runner-custom-images %}
518
+
519
+ {% endif %}
520
+
521
+ ## `jobs.<job_id>.environment`
522
+
523
+ {% data reusables.actions.jobs.section-using-environments-for-jobs %}
524
+
525
+ ## `jobs.<job_id>.concurrency`
526
+
527
+ {% data reusables.actions.jobs.section-using-concurrency-jobs %}
528
+
529
+ {% ifversion actions-cache-mode %}
530
+
531
+ ## `jobs.<job_id>.cache-mode`
532
+
533
+ Use `jobs.<job_id>.cache-mode` to set the level of {% data variables.product.prodname_actions %} cache access for a single job. A value set here overrides any workflow-level [`cache-mode`](#cache-mode) for this job only.
534
+
535
+ The accepted values are `read`, `write`, `write-only`, and `none`, with the same meanings as the top-level key. If neither the job nor the workflow sets `cache-mode`, a trigger-based default applies. For more information about each value, see [`cache-mode`](#cache-mode) and [AUTOTITLE](/actions/reference/workflows-and-actions/dependency-caching#defaults).
536
+
537
+ > [!WARNING]
538
+ > Explicitly declaring `cache-mode: write` or `cache-mode: write-only` on low-trust triggers can bypass the secure default read-only cache restriction and reintroduce cache-poisoning risk. For guidance and mitigations, see [AUTOTITLE](/actions/reference/workflows-and-actions/dependency-caching#bypassing-the-default-untrusted-trigger-cache-restriction).
539
+
540
+ You can also set `cache-mode` on a job that calls a reusable workflow to limit the cache access granted to the called workflow. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/reusing-workflow-configurations#supported-keywords-for-jobs-that-call-a-reusable-workflow) and [AUTOTITLE](/actions/how-tos/reuse-automations/reuse-workflows#controlling-cache-access-in-reusable-workflows).
541
+
542
+ ### Example of `jobs.<job_id>.cache-mode`
543
+
544
+ ```yaml
545
+ jobs:
546
+ build:
547
+ runs-on: ubuntu-latest
548
+ cache-mode: write
549
+ test:
550
+ runs-on: ubuntu-latest
551
+ cache-mode: read
552
+ ```
553
+
554
+ {% endif %}
555
+
556
+ ## `jobs.<job_id>.outputs`
557
+
558
+ {% data reusables.actions.jobs.section-defining-outputs-for-jobs %}
559
+
560
+ ## `jobs.<job_id>.env`
561
+
562
+ A `map` of variables that are available to all steps in the job. You can set variables for the entire workflow or an individual step. For more information, see [`env`](#env) and [`jobs.<job_id>.steps[*].env`](#jobsjob_idstepsenv).
563
+
564
+ {% data reusables.repositories.actions-env-var-note %}
565
+
566
+ ### Example of `jobs.<job_id>.env`
567
+
568
+ ```yaml
569
+ jobs:
570
+ job1:
571
+ env:
572
+ FIRST_NAME: Mona
573
+ ```
574
+
575
+ ## `jobs.<job_id>.defaults`
576
+
577
+ {% data reusables.actions.jobs.setting-default-values-for-jobs-defaults-job %}
578
+
579
+ ## `jobs.<job_id>.defaults.run`
580
+
581
+ {% data reusables.actions.jobs.setting-default-values-for-jobs-defaults-job-run %}
582
+
583
+ ## `jobs.<job_id>.defaults.run.shell`
584
+
585
+ {% data reusables.actions.jobs.setting-default-values-for-jobs-defaults-run-shell %}
586
+
587
+ ## `jobs.<job_id>.defaults.run.working-directory`
588
+
589
+ {% data reusables.actions.jobs.setting-default-values-for-jobs-defaults-run-working-directory %}
590
+
591
+ ### Example: Setting default `run` step options for a job
592
+
593
+ {% data reusables.actions.jobs.setting-default-run-value-for-job-example %}
594
+
595
+ ## `jobs.<job_id>.steps`
596
+
597
+ A job contains a sequence of tasks called `steps`. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the runner environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. {% data variables.product.prodname_dotcom %} provides built-in steps to set up and complete a job.
598
+
599
+ {% data variables.product.prodname_dotcom %} only displays the first 1,000 checks, however, you can run an unlimited number of steps as long as you are within the workflow usage limits. For more information, see [AUTOTITLE](/actions/concepts/billing-and-usage) for {% data variables.product.prodname_dotcom %}-hosted runners and [AUTOTITLE](/actions/reference/limits) for self-hosted runner usage limits.
600
+
601
+ ### Example of `jobs.<job_id>.steps`
602
+
603
+ {% raw %}
604
+
605
+ ```yaml
606
+ name: Greeting from Mona
607
+
608
+ on: push
609
+
610
+ jobs:
611
+ my-job:
612
+ name: My Job
613
+ runs-on: ubuntu-latest
614
+ steps:
615
+ - name: Print a greeting
616
+ env:
617
+ MY_VAR: Hi there! My name is
618
+ FIRST_NAME: Mona
619
+ MIDDLE_NAME: The
620
+ LAST_NAME: Octocat
621
+ run: |
622
+ echo $MY_VAR $FIRST_NAME $MIDDLE_NAME $LAST_NAME.
623
+ ```
624
+
625
+ {% endraw %}
626
+
627
+ ## `jobs.<job_id>.steps[*].id`
628
+
629
+ A unique identifier for the step. You can use the `id` to reference the step in contexts. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/contexts).
630
+
631
+ ## `jobs.<job_id>.steps[*].if`
632
+
633
+ You can use the `if` conditional to prevent a step from running unless a condition is met. {% data reusables.actions.if-supported-contexts %}
634
+
635
+ {% data reusables.actions.expression-syntax-if %} For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/expressions).
636
+
637
+ ### Example: Using contexts
638
+
639
+ This step only runs when the event type is a `pull_request` and the event action is `unassigned`.
640
+
641
+ ```yaml
642
+ steps:
643
+ - name: My first step
644
+ if: {% raw %}${{ github.event_name == 'pull_request' && github.event.action == 'unassigned' }}{% endraw %}
645
+ run: echo This event is a pull request that had an assignee removed.
646
+ ```
647
+
648
+ ### Example: Using status check functions
649
+
650
+ The `my backup step` only runs when the previous step of a job fails. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/expressions#status-check-functions).
651
+
652
+ ```yaml
653
+ steps:
654
+ - name: My first step
655
+ uses: octo-org/action-name@main
656
+ - name: My backup step
657
+ if: {% raw %}${{ failure() }}{% endraw %}
658
+ uses: actions/heroku@1.0.0
659
+ ```
660
+
661
+ ### Example: Using secrets
662
+
663
+ Secrets cannot be directly referenced in `if:` conditionals. Instead, consider setting secrets as job-level environment variables, then referencing the environment variables to conditionally run steps in the job.
664
+
665
+ If a secret has not been set, the return value of an expression referencing the secret (such as {% raw %}`${{ secrets.SuperSecret }}`{% endraw %} in the example) will be an empty string.
666
+
667
+ {% raw %}
668
+
669
+ ```yaml
670
+ name: Run a step if a secret has been set
671
+ on: push
672
+ jobs:
673
+ my-jobname:
674
+ runs-on: ubuntu-latest
675
+ env:
676
+ super_secret: ${{ secrets.SuperSecret }}
677
+ steps:
678
+ - if: ${{ env.super_secret != '' }}
679
+ run: echo 'This step will only run if the secret has a value set.'
680
+ - if: ${{ env.super_secret == '' }}
681
+ run: echo 'This step will only run if the secret does not have a value set.'
682
+ ```
683
+
684
+ {% endraw %}
685
+
686
+ For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/contexts#context-availability) and [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets).
687
+
688
+ ## `jobs.<job_id>.steps[*].name`
689
+
690
+ A name for your step to display on {% data variables.product.prodname_dotcom %}.
691
+
692
+ ## `jobs.<job_id>.steps[*].uses`
693
+
694
+ Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a [published Docker container image](https://hub.docker.com/).
695
+
696
+ We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update.
697
+ * Using the commit SHA of a released action version is the safest for stability and security.
698
+ * If the action publishes major version tags, you should expect to receive critical fixes and security patches while still retaining compatibility. Note that this behavior is at the discretion of the action's author.
699
+ * Using the default branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break.
700
+
701
+ Some actions require inputs that you must set using the [`with`](#jobsjob_idstepswith) keyword. Review the action's README file to determine the inputs required.
702
+
703
+ Actions can be JavaScript, composite, or Docker container actions. If the action you're using is a Docker container you must run the job in a Linux environment. For more details, see [`runs-on`](#jobsjob_idruns-on).
704
+
705
+ ### Example: Using versioned actions
706
+
707
+ ```yaml
708
+ steps:
709
+ # Reference a specific commit
710
+ - uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3
711
+ # Reference the major version of a release
712
+ - uses: {% data reusables.actions.action-checkout %}
713
+ # Reference a specific version
714
+ - uses: {% data reusables.actions.action-checkout %}.2.0
715
+ # Reference a branch
716
+ - uses: actions/checkout@main
717
+ ```
718
+
719
+ ### Example: Using a public action
720
+
721
+ `{owner}/{repo}@{ref}`
722
+
723
+ You can specify a branch, ref, or SHA in a public {% data variables.product.prodname_dotcom %} repository.
724
+
725
+ ```yaml
726
+ jobs:
727
+ my_first_job:
728
+ steps:
729
+ - name: My first step
730
+ # Uses the default branch of a public repository
731
+ uses: actions/heroku@main
732
+ - name: My second step
733
+ # Uses a specific version tag of a public repository
734
+ uses: actions/aws@v2.0.1
735
+ ```
736
+
737
+ ### Example: Using a public action in a subdirectory
738
+
739
+ `{owner}/{repo}/{path}@{ref}`
740
+
741
+ A subdirectory in a public {% data variables.product.prodname_dotcom %} repository at a specific branch, ref, or SHA.
742
+
743
+ ```yaml
744
+ jobs:
745
+ my_first_job:
746
+ steps:
747
+ - name: My first step
748
+ uses: actions/aws/ec2@main
749
+ ```
750
+
751
+ ### Example: Using an action in the same repository as the workflow at the running commit (recommended)
752
+
753
+ `$/path/to/action`
754
+
755
+ The `$/` prefix is the self repository reference. It references an action stored in the same repository as the workflow or action that is currently running, and resolves to that repository at the running commit (the same SHA as the running workflow or action). You do not need to check out the repository first, so it is the recommended way to reference an action within its own repository.
756
+
757
+ The `$/` syntax is not available in {% data variables.product.prodname_ghe_server %}.
758
+
759
+ A `$/` reference must not include an `@{ref}` suffix. The ref is always the commit the running workflow or action is using, so a reference such as `$/actions/my-action@v1` is invalid.
760
+
761
+ `$/` always resolves against the repository of the file it appears in, not the repository that called it. For example, if a reusable workflow in one repository is called by a workflow in another repository, a `$/` reference in the called workflow resolves to the called workflow's repository, not the calling workflow's repository. This makes `$/` reliable for action composition, where a relative `./` path would instead resolve against whatever is checked out in the caller's workspace. For using `$/` in a composite action's steps, see [AUTOTITLE](/actions/reference/workflows-and-actions/metadata-syntax#runsstepsuses).
762
+
763
+ The following table compares the ways to reference an action.
764
+
765
+ | Syntax | Resolves to | Recommended for |
766
+ | ------ | ----------- | --------------- |
767
+ | `$/path/to/action` | The same repository as the running workflow or action, at the running commit | Actions in the same repository |
768
+ | `{owner}/{repo}@{ref}` | The specified repository at the specified ref | Actions in another repository |
769
+ | `./path/to/action` | A path in the runner's checked-out workspace, relative to the default working directory (`{% raw %}${{ github.workspace }}{% endraw %}`) | Edge cases only |
770
+
771
+ ```yaml
772
+ on: [push]
773
+
774
+ jobs:
775
+ my_first_job:
776
+ runs-on: ubuntu-latest
777
+ steps:
778
+ # References an action in the same repository at the running commit
779
+ - uses: $/.github/actions/hello-world-action
780
+ ```
781
+
782
+ ### Example: Using an action in the same repository as the workflow
783
+
784
+ `./path/to/dir`
785
+
786
+ The path to the directory that contains the action in your workflow's repository. You must check out your repository before using the action, and the `./` path resolves against the runner's workspace rather than the repository of the running workflow. For most cases, use the `$/` syntax shown above instead.
787
+
788
+ {% data reusables.actions.workflows.section-referencing-an-action-from-the-same-repository %}
789
+
790
+ ### Example: Using a Docker Hub action
791
+
792
+ `docker://{image}:{tag}`
793
+
794
+ A Docker image published on [Docker Hub](https://hub.docker.com/).
795
+
796
+ ```yaml
797
+ jobs:
798
+ my_first_job:
799
+ steps:
800
+ - name: My first step
801
+ uses: docker://alpine:3.8
802
+ ```
803
+
804
+ {% ifversion fpt or ghec %}
805
+
806
+ ### Example: Using the {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %}
807
+
808
+ `docker://{host}/{image}:{tag}`
809
+
810
+ A public Docker image in the {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %}.
811
+
812
+ ```yaml
813
+ jobs:
814
+ my_first_job:
815
+ steps:
816
+ - name: My first step
817
+ uses: docker://ghcr.io/OWNER/IMAGE_NAME
818
+ ```
819
+
820
+ {% endif %}
821
+
822
+ ### Example: Using a Docker public registry action
823
+
824
+ `docker://{host}/{image}:{tag}`
825
+
826
+ A Docker image in a public registry. This example uses the Google Container Registry at `gcr.io`.
827
+
828
+ ```yaml
829
+ jobs:
830
+ my_first_job:
831
+ steps:
832
+ - name: My first step
833
+ uses: docker://gcr.io/cloud-builders/gradle
834
+ ```
835
+
836
+ ### Example: Using an action inside a different private repository than the workflow
837
+
838
+ If the action is in an internal repository, or in a private repository configured to allow access from your workflow's repository, you can reference the action directly. For more information, see {% ifversion ghes or ghec %}[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository){% else %}[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository){% endif %} and [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository).
839
+
840
+ If the action isn't in a repository configured to allow access, you need to check out the repository and reference the action locally. Generate a {% data variables.product.pat_generic %} and add the token as a secret. The following example shows this method for referencing an action. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) and [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets).
841
+
842
+ Replace `PERSONAL_ACCESS_TOKEN` in the example with the name of your secret.
843
+
844
+ ```yaml
845
+ jobs:
846
+ my_first_job:
847
+ steps:
848
+ - name: Check out repository
849
+ uses: {% data reusables.actions.action-checkout %}
850
+ with:
851
+ repository: octocat/my-private-repo
852
+ ref: v1.0
853
+ token: {% raw %}${{ secrets.PERSONAL_ACCESS_TOKEN }}{% endraw %}
854
+ path: ./.github/actions/my-private-repo
855
+ - name: Run my action
856
+ uses: ./.github/actions/my-private-repo/my-action
857
+ ```
858
+
859
+ Alternatively, use a {% data variables.product.prodname_github_app %} instead of a {% data variables.product.pat_generic %} in order to ensure your workflow continues to run even if the {% data variables.product.pat_generic %} owner leaves. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow).
860
+
861
+ ## `jobs.<job_id>.steps[*].run`
862
+
863
+ Runs command-line programs that do not exceed 21,000 characters using the operating system's shell. If you do not provide a `name`, the step name will default to the text specified in the `run` command.
864
+
865
+ Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see [`jobs.<job_id>.steps[*].shell`](#jobsjob_idstepsshell).
866
+
867
+ Each `run` keyword represents a new process and shell in the runner environment. When you provide multi-line commands, each line runs in the same shell. For example:
868
+
869
+ * A single-line command:
870
+
871
+ ```yaml
872
+ - name: Install Dependencies
873
+ run: npm install
874
+ ```
875
+
876
+ * A multi-line command:
877
+
878
+ ```yaml
879
+ - name: Clean install dependencies and build
880
+ run: |
881
+ npm ci
882
+ npm run build
883
+ ```
884
+
885
+ ## `jobs.<job_id>.steps[*].working-directory`
886
+
887
+ Using the `working-directory` keyword, you can specify the working directory of where to run the command.
888
+
889
+ ```yaml
890
+ - name: Clean temp directory
891
+ run: rm -rf *
892
+ working-directory: ./temp
893
+ ```
894
+
895
+ Alternatively, you can specify a default working directory for all `run` steps in a job, or for all `run` steps in the entire workflow. For more information, see [`defaults.run.working-directory`](/actions/reference/workflows-and-actions/workflow-syntax#defaultsrunworking-directory) and [`jobs.<job_id>.defaults.run.working-directory`](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_iddefaultsrunworking-directory).
896
+
897
+ You can also use a `run` step to run a script. For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/add-scripts).
898
+
899
+ ## `jobs.<job_id>.steps[*].shell`
900
+
901
+ You can override the default shell settings in the runner's operating system and the job's default using the `shell` keyword. You can use built-in `shell` keywords, or you can define a custom set of shell options. The shell command that is run internally executes a temporary file that contains the commands specified in the `run` keyword.
902
+
903
+ {% data reusables.actions.supported-shells %}
904
+
905
+ Alternatively, you can specify a default shell for all `run` steps in a job, or for all `run` steps in the entire workflow. For more information, see [`defaults.run.shell`](/actions/reference/workflows-and-actions/workflow-syntax#defaultsrunshell) and [`jobs.<job_id>.defaults.run.shell`](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_iddefaultsrunshell).
906
+
907
+ ### Example: Running a command using Bash
908
+
909
+ ```yaml
910
+ steps:
911
+ - name: Display the path
912
+ shell: bash
913
+ run: echo $PATH
914
+ ```
915
+
916
+ ### Example: Running a command using Windows `cmd`
917
+
918
+ ```yaml
919
+ steps:
920
+ - name: Display the path
921
+ shell: cmd
922
+ run: echo %PATH%
923
+ ```
924
+
925
+ ### Example: Running a command using PowerShell Core
926
+
927
+ ```yaml
928
+ steps:
929
+ - name: Display the path
930
+ shell: pwsh
931
+ run: echo ${env:PATH}
932
+ ```
933
+
934
+ ### Example: Using PowerShell Desktop to run a command
935
+
936
+ ```yaml
937
+ steps:
938
+ - name: Display the path
939
+ shell: powershell
940
+ run: echo ${env:PATH}
941
+ ```
942
+
943
+ ### Example: Running an inline Python script
944
+
945
+ ```yaml
946
+ steps:
947
+ - name: Display the path
948
+ shell: python
949
+ run: |
950
+ import os
951
+ print(os.environ['PATH'])
952
+ ```
953
+
954
+ ### Custom shell
955
+
956
+ You can set the `shell` value to a template string using `command [options] {0} [more_options]`. {% data variables.product.prodname_dotcom %} interprets the first whitespace-delimited word of the string as the command, and inserts the file name for the temporary script at `{0}`.
957
+
958
+ For example:
959
+
960
+ ```yaml
961
+ steps:
962
+ - name: Display the environment variables and their values
963
+ shell: perl {0}
964
+ run: |
965
+ print %ENV
966
+ ```
967
+
968
+ The command used, `perl` in this example, must be installed on the runner.
969
+
970
+ {% ifversion fpt or ghec %}
971
+ For information about the software included on GitHub-hosted runners, see [AUTOTITLE](/actions/concepts/runners/github-hosted-runners#preinstalled-software-for-github-owned-images).
972
+ {% endif %}
973
+
974
+ ### Exit codes and error action preference
975
+
976
+ For built-in shell keywords, we provide the following defaults that are executed by {% data variables.product.prodname_dotcom %}-hosted runners. You should use these guidelines when running shell scripts.
977
+
978
+ * `bash`/`sh`:
979
+ * By default, fail-fast behavior is enforced using `set -e` for both `sh` and `bash`. When `shell: bash` is specified, `-o pipefail` is also applied to enforce early exit from pipelines that generate a non-zero exit status.
980
+ * You can take full control over shell parameters by providing a template string to the shell options. For example, `bash {0}`.
981
+ * `sh`-like shells exit with the exit code of the last command executed in a script, which is also the default behavior for actions. The runner will report the status of the step as fail/succeed based on this exit code.
982
+
983
+ * `powershell`/`pwsh`
984
+ * Fail-fast behavior when possible. For `pwsh` and `powershell` built-in shell, we will prepend `$ErrorActionPreference = 'stop'` to script contents.
985
+ * We append `if ((Test-Path -LiteralPath variable:\LASTEXITCODE)) { exit $LASTEXITCODE }` to powershell scripts so action statuses reflect the script's last exit code.
986
+ * Users can always opt out by not using the built-in shell, and providing a custom shell option like: `pwsh -File {0}`, or `powershell -Command "& '{0}'"`, depending on need.
987
+
988
+ * `cmd`
989
+ * There doesn't seem to be a way to fully opt into fail-fast behavior other than writing your script to check each error code and respond accordingly. Because we can't actually provide that behavior by default, you need to write this behavior into your script.
990
+ * `cmd.exe` will exit with the error level of the last program it executed, and it will return the error code to the runner. This behavior is internally consistent with the previous `sh` and `pwsh` default behavior and is the `cmd.exe` default, so this behavior remains intact.
991
+
992
+ ## `jobs.<job_id>.steps[*].with`
993
+
994
+ A `map` of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with `INPUT_` and converted to upper case.
995
+
996
+ Input parameters defined for a Docker container must use `args`. For more information, see [`jobs.<job_id>.steps[*].with.args`](#jobsjob_idstepswithargs).
997
+
998
+ ### Example of `jobs.<job_id>.steps[*].with`
999
+
1000
+ Defines the three input parameters (`first_name`, `middle_name`, and `last_name`) defined by the `hello_world` action. These input variables will be accessible to the `hello-world` action as `INPUT_FIRST_NAME`, `INPUT_MIDDLE_NAME`, and `INPUT_LAST_NAME` environment variables.
1001
+
1002
+ ```yaml
1003
+ jobs:
1004
+ my_first_job:
1005
+ steps:
1006
+ - name: My first step
1007
+ uses: actions/hello_world@main
1008
+ with:
1009
+ first_name: Mona
1010
+ middle_name: The
1011
+ last_name: Octocat
1012
+ ```
1013
+
1014
+ ## `jobs.<job_id>.steps[*].with.args`
1015
+
1016
+ A `string` that defines the inputs for a Docker container. {% data variables.product.prodname_dotcom %} passes the `args` to the container's `ENTRYPOINT` when the container starts up. An `array of strings` is not supported by this parameter. A single argument that includes spaces should be surrounded by double quotes `""`.
1017
+
1018
+ ### Example of `jobs.<job_id>.steps[*].with.args`
1019
+
1020
+ {% raw %}
1021
+
1022
+ ```yaml
1023
+ steps:
1024
+ - name: Explain why this job ran
1025
+ uses: octo-org/action-name@main
1026
+ with:
1027
+ entrypoint: /bin/echo
1028
+ args: The ${{ github.event_name }} event triggered this step.
1029
+ ```
1030
+
1031
+ {% endraw %}
1032
+
1033
+ The `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference:
1034
+
1035
+ 1. Document required arguments in the action's README and omit them from the `CMD` instruction.
1036
+ 1. Use defaults that allow using the action without specifying any `args`.
1037
+ 1. If the action exposes a `--help` flag, or something similar, use that as the default to make your action self-documenting.
1038
+
1039
+ ## `jobs.<job_id>.steps[*].with.entrypoint`
1040
+
1041
+ Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Unlike the Docker `ENTRYPOINT` instruction which has a shell and exec form, `entrypoint` keyword accepts only a single string defining the executable to be run.
1042
+
1043
+ ### Example of `jobs.<job_id>.steps[*].with.entrypoint`
1044
+
1045
+ ```yaml
1046
+ steps:
1047
+ - name: Run a custom command
1048
+ uses: octo-org/action-name@main
1049
+ with:
1050
+ entrypoint: /a/different/executable
1051
+ ```
1052
+
1053
+ The `entrypoint` keyword is meant to be used with Docker container actions, but you can also use it with JavaScript actions that don't define any inputs.
1054
+
1055
+ ## `jobs.<job_id>.steps[*].env`
1056
+
1057
+ Sets variables for steps to use in the runner environment. You can also set variables for the entire workflow or a job. For more information, see [`env`](#env) and [`jobs.<job_id>.env`](#jobsjob_idenv).
1058
+
1059
+ {% data reusables.repositories.actions-env-var-note %}
1060
+
1061
+ Public actions may specify expected variables in the README file. If you are setting a secret or sensitive value, such as a password or token, you must set secrets using the `secrets` context. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/contexts).
1062
+
1063
+ ### Example of `jobs.<job_id>.steps[*].env`
1064
+
1065
+ {% raw %}
1066
+
1067
+ ```yaml
1068
+ steps:
1069
+ - name: My first action
1070
+ env:
1071
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1072
+ FIRST_NAME: Mona
1073
+ LAST_NAME: Octocat
1074
+ ```
1075
+
1076
+ {% endraw %}
1077
+
1078
+ ## `jobs.<job_id>.steps[*].continue-on-error`
1079
+
1080
+ Prevents a job from failing when a step fails. Set to `true` to allow a job to pass when this step fails.
1081
+
1082
+ ## `jobs.<job_id>.steps[*].timeout-minutes`
1083
+
1084
+ The maximum number of minutes to run the step before killing the process. Maximum: 360 for both {% data variables.product.github %}-hosted and self-hosted runners.
1085
+
1086
+ Fractional values are not supported. `timeout-minutes` must be a positive integer.
1087
+
1088
+ {% ifversion actions-nga %}
1089
+
1090
+ ## `jobs.<job_id>.steps[*].background`
1091
+
1092
+ Runs a step asynchronously so the job continues to the next step without waiting for it to finish. Use `background: true` for long-running processes, such as databases, servers, or monitoring tasks, that need to run alongside other steps. You synchronize with background steps later using [`wait`](#jobsjob_idstepswait) or [`wait-all`](#jobsjob_idstepswait-all) or stop them with [`cancel`](#jobsjob_idstepscancel).
1093
+
1094
+ You can use `background` on steps that use `run` or `uses`. To reference a background step from [`wait`](#jobsjob_idstepswait) or [`cancel`](#jobsjob_idstepscancel), give it an [`id`](#jobsjob_idstepsid). A maximum of 10 background steps can run concurrently in a single job; additional background steps are queued until a slot is free.
1095
+
1096
+ Outputs and environment changes from a background step are only available after you run a `wait` or `wait-all` step that includes it. If a background step fails, the job fails at the next `wait` or `wait-all` that includes it (unless [`continue-on-error`](#jobsjob_idstepscontinue-on-error) is set on that step). An implicit `wait-all` runs before any post-job cleanup.
1097
+
1098
+ Use `background` when you need fine-grained control: starting a long-running process (like a server or database) that stays up while later steps run, referencing a specific step with [`wait`](#jobsjob_idstepswait) or [`cancel`](#jobsjob_idstepscancel), or interleaving background work with other steps. If you instead have a self-contained group of steps that should all finish before the job continues, [`parallel`](#jobsjob_idstepsparallel) is a more convenient shorthand.
1099
+
1100
+ > [!NOTE]
1101
+ > You cannot use `background` on steps inside a composite action. A composite action can itself run as a background step, but it cannot declare background steps internally.
1102
+
1103
+ ### Example: Running a step in the background
1104
+
1105
+ ```yaml
1106
+ steps:
1107
+ - name: Start server
1108
+ id: server
1109
+ run: npm start
1110
+ background: true
1111
+
1112
+ - name: Run tests against the server
1113
+ run: npm test
1114
+
1115
+ - name: Wait for the server step to finish
1116
+ wait: server
1117
+ ```
1118
+
1119
+ ## `jobs.<job_id>.steps[*].wait`
1120
+
1121
+ Pauses the job until one or more background steps complete. A `wait` step performs no work itself, it only blocks until the referenced background steps finish. Provide a single step `id` as a string, or multiple step `id`s as an array.
1122
+
1123
+ After a `wait` step completes, the outputs of the referenced background steps become available to subsequent steps. If a referenced background step failed, the `wait` step fails too.
1124
+
1125
+ > [!NOTE]
1126
+ > A `wait` step always runs and does not support the [`if`](#jobsjob_idstepsif) conditional.
1127
+
1128
+ ### Example: Waiting for specific background steps
1129
+
1130
+ ```yaml
1131
+ steps:
1132
+ - name: Build frontend
1133
+ id: build-frontend
1134
+ run: npm run build:frontend
1135
+ background: true
1136
+
1137
+ - name: Build backend
1138
+ id: build-backend
1139
+ run: npm run build:backend
1140
+ background: true
1141
+
1142
+ - name: Run linter while builds run
1143
+ run: npm run lint
1144
+
1145
+ - name: Wait for both builds to finish
1146
+ wait: [build-frontend, build-backend]
1147
+
1148
+ - name: Run tests
1149
+ run: npm test
1150
+ ```
1151
+
1152
+ ## `jobs.<job_id>.steps[*].wait-all`
1153
+
1154
+ Pauses the job until all active background steps complete. This is useful when several background steps are running and you want them all to finish before continuing. Like `wait`, the `wait-all` step fails if any of the background steps it waits on failed, unless you set [`continue-on-error`](#jobsjob_idstepscontinue-on-error) to `true`.
1155
+
1156
+ The `wait-all` keyword takes no arguments.
1157
+
1158
+ > [!NOTE]
1159
+ > A `wait-all` step always runs and does not support the [`if`](#jobsjob_idstepsif) conditional.
1160
+
1161
+ ### Example: Waiting for all background steps
1162
+
1163
+ ```yaml
1164
+ steps:
1165
+ - name: Start database
1166
+ id: db
1167
+ run: docker run -d postgres:15
1168
+ background: true
1169
+
1170
+ - name: Start cache
1171
+ id: cache
1172
+ run: docker run -d redis:7
1173
+ background: true
1174
+
1175
+ - name: Run integration tests
1176
+ run: npm run test:integration
1177
+
1178
+ - name: Wait for all services to stop
1179
+ wait-all:
1180
+ ```
1181
+
1182
+ ## `jobs.<job_id>.steps[*].cancel`
1183
+
1184
+ Gracefully terminates a running background step. The runner sends the step's process a termination signal (`SIGTERM`) so it can clean up, and forcibly stops it (`SIGKILL`) if it does not exit within a short grace period. The `cancel` keyword targets a single background step by its `id`.
1185
+
1186
+ > [!NOTE]
1187
+ > A `cancel` step always runs and does not support the [`if`](#jobsjob_idstepsif) conditional.
1188
+
1189
+ ### Example: Canceling a background step
1190
+
1191
+ ```yaml
1192
+ steps:
1193
+ - name: Start long-running monitor
1194
+ id: monitor
1195
+ run: ./scripts/monitor.sh
1196
+ background: true
1197
+
1198
+ - name: Run the main task
1199
+ run: npm test
1200
+
1201
+ - name: Stop the monitor
1202
+ cancel: monitor
1203
+ ```
1204
+
1205
+ ## `jobs.<job_id>.steps[*].parallel`
1206
+
1207
+ Runs a group of steps concurrently, then waits for all of them to finish before continuing. The `parallel` keyword is shorthand: every step in the group runs as a background step, with an implicit `wait` at the end of the group. Use it when you have an independent group of steps that can run at the same time and you don't need to reference them individually.
1208
+
1209
+ Use `parallel` when you have a self-contained group of steps that should all finish before the job moves on, such as building several components at once. Use [`background`](#jobsjob_idstepsbackground) when you need finer control: starting a long-running process (like a server or database) that stays up while later steps run, referencing a specific step with [`wait`](#jobsjob_idstepswait) or [`cancel`](#jobsjob_idstepscancel), or interleaving background work with other steps. In short, `parallel` is more limited but more convenient for the "run this group at once" case, while `background` is the general-purpose primitive.
1210
+
1211
+ Each step in the group is subject to the same 10-step concurrency limit as other background steps.
1212
+
1213
+ > [!NOTE]
1214
+ > You cannot use `parallel` inside a composite action.
1215
+
1216
+ ### Example: Running steps in parallel
1217
+
1218
+ ```yaml
1219
+ steps:
1220
+ - uses: {% data reusables.actions.action-checkout %}
1221
+
1222
+ - parallel:
1223
+ - name: Build frontend
1224
+ run: npm run build:frontend
1225
+
1226
+ - name: Build backend
1227
+ run: npm run build:backend
1228
+
1229
+ - name: Build docs
1230
+ run: npm run build:docs
1231
+
1232
+ - name: Run tests after all builds complete
1233
+ run: npm test
1234
+ ```
1235
+
1236
+ The group above is equivalent to declaring each step with `background: true` followed by a `wait` step.
1237
+
1238
+ {% endif %}
1239
+
1240
+ ## `jobs.<job_id>.timeout-minutes`
1241
+
1242
+ The maximum number of minutes to let a job run before {% data variables.product.prodname_dotcom %} automatically cancels it. Default: 360
1243
+
1244
+ If the timeout exceeds the job execution time limit for the runner, the job will be canceled when the execution time limit is met instead. For more information about job execution time limits, see [AUTOTITLE](/actions/concepts/billing-and-usage#usage-limits-and-policy) for {% data variables.product.prodname_dotcom %}-hosted runners and [AUTOTITLE](/actions/reference/limits) for self-hosted runner usage limits.
1245
+
1246
+ > [!NOTE]
1247
+ > {% data reusables.actions.github-token-expiration %} For self-hosted runners, the token may be the limiting factor if the job timeout is greater than 24 hours. For more information on the `GITHUB_TOKEN`, see [AUTOTITLE](/actions/tutorials/authenticate-with-github_token).
1248
+
1249
+ ## `jobs.<job_id>.strategy`
1250
+
1251
+ Use `jobs.<job_id>.strategy` to use a matrix strategy for your jobs. {% data reusables.actions.jobs.about-matrix-strategy %} For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/run-job-variations).
1252
+
1253
+ ## `jobs.<job_id>.strategy.matrix`
1254
+
1255
+ Use `jobs.<job_id>.strategy.matrix` to define a matrix of different job configurations. For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/run-job-variations).
1256
+
1257
+ A matrix will generate a maximum of 256 jobs per workflow run. This limit applies to both {% data variables.product.github %}-hosted and self-hosted runners.
1258
+
1259
+ The variables that you define become properties in the `matrix` context, and you can reference the property in other areas of your workflow file. In this example, you can use `matrix.version` and `matrix.os` to access the current value of `version` and `os` that the job is using. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/contexts).
1260
+
1261
+ {% data reusables.actions.workflows.matrix-keys-are-case-insensitive %}
1262
+
1263
+ By default, {% data variables.product.github %} will maximize the number of jobs run in parallel depending on runner availability. The order of the variables in the matrix determines the order in which the jobs are created. The first variable you define will be the first job that is created in your workflow run.
1264
+
1265
+ ### Using a single-dimension matrix
1266
+
1267
+ The following workflow defines the variable `version` with the values `[10, 12, 14]`. The workflow will run three jobs, one for each value in the variable. Each job will access the `version` value through the `matrix.version` context and pass the value as `node-version` to the `actions/setup-node` action.
1268
+
1269
+ ```yaml
1270
+ jobs:
1271
+ example_matrix:
1272
+ strategy:
1273
+ matrix:
1274
+ version: [10, 12, 14]
1275
+ steps:
1276
+ - uses: {% data reusables.actions.action-setup-node %}
1277
+ with:
1278
+ node-version: {% raw %}${{ matrix.version }}{% endraw %}
1279
+ ```
1280
+
1281
+ ### Using a multi-dimensional matrix
1282
+
1283
+ Specify multiple variables to create a multi-dimensional matrix. A job will run for each possible combination of the variables.
1284
+
1285
+ For example, the following workflow specifies two variables:
1286
+
1287
+ * Two operating systems specified in the `os` variable
1288
+ * Three Node.js versions specified in the `version` variable
1289
+
1290
+ The workflow will run six jobs, one for each combination of the `os` and `version` variables. Each job will set the `runs-on` value to the current `os` value and will pass the current `version` value to the `actions/setup-node` action.
1291
+
1292
+ ```yaml
1293
+ jobs:
1294
+ example_matrix:
1295
+ strategy:
1296
+ matrix:
1297
+ os: [ubuntu-22.04, ubuntu-24.04]
1298
+ version: [10, 12, 14]
1299
+ runs-on: {% raw %}${{ matrix.os }}{% endraw %}
1300
+ steps:
1301
+ - uses: {% data reusables.actions.action-setup-node %}
1302
+ with:
1303
+ node-version: {% raw %}${{ matrix.version }}{% endraw %}
1304
+ ```
1305
+
1306
+ A variable configuration in a matrix can be an `array` of `object`s. For example, the following matrix produces 4 jobs with corresponding contexts.
1307
+
1308
+ ```yaml
1309
+ matrix:
1310
+ os:
1311
+ - ubuntu-latest
1312
+ - macos-latest
1313
+ node:
1314
+ - version: 14
1315
+ - version: 20
1316
+ env: NODE_OPTIONS=--openssl-legacy-provider
1317
+ ```
1318
+
1319
+ Each job in the matrix will have its own combination of `os` and `node` values, as shown below.
1320
+
1321
+ ```yaml
1322
+ - matrix.os: ubuntu-latest
1323
+ matrix.node.version: 14
1324
+ - matrix.os: ubuntu-latest
1325
+ matrix.node.version: 20
1326
+ matrix.node.env: NODE_OPTIONS=--openssl-legacy-provider
1327
+ - matrix.os: macos-latest
1328
+ matrix.node.version: 14
1329
+ - matrix.os: macos-latest
1330
+ matrix.node.version: 20
1331
+ matrix.node.env: NODE_OPTIONS=--openssl-legacy-provider
1332
+ ```
1333
+
1334
+ ## `jobs.<job_id>.strategy.matrix.include`
1335
+
1336
+ For each object in the `include` list, the key:value pairs in the object will be added to each of the matrix combinations if none of the key:value pairs overwrite any of the original matrix values. If the object cannot be added to any of the matrix combinations, a new matrix combination will be created instead. Note that the original matrix values will not be overwritten, but added matrix values can be overwritten.
1337
+
1338
+ ### Example: Expanding configurations
1339
+
1340
+ {% data reusables.actions.jobs.matrix-expand-with-include %}
1341
+
1342
+ ### Example: Adding configurations
1343
+
1344
+ {% data reusables.actions.jobs.matrix-add-with-include %}
1345
+
1346
+ ## `jobs.<job_id>.strategy.matrix.exclude`
1347
+
1348
+ An excluded configuration only has to be a partial match for it to be excluded.
1349
+
1350
+ All `include` combinations are processed after `exclude`. This allows you to use `include` to add back combinations that were previously excluded.
1351
+
1352
+ ## `jobs.<job_id>.strategy.fail-fast`
1353
+
1354
+ {% data reusables.actions.jobs.section-using-a-build-matrix-for-your-jobs-failfast %}
1355
+
1356
+ ## `jobs.<job_id>.strategy.max-parallel`
1357
+
1358
+ By default, {% data variables.product.github %} will maximize the number of jobs run in parallel depending on runner availability.
1359
+
1360
+ ## `jobs.<job_id>.continue-on-error`
1361
+
1362
+ `jobs.<job_id>.continue-on-error` applies to a single job. If `jobs.<job_id>.continue-on-error` is `true`, other jobs in the matrix will continue running even if the job with `jobs.<job_id>.continue-on-error: true` fails.
1363
+
1364
+ Prevents a workflow run from failing when a job fails. Set to `true` to allow a workflow run to pass when this job fails.
1365
+
1366
+ ### Example: Preventing a specific failing matrix job from failing a workflow run
1367
+
1368
+ You can allow specific jobs in a job matrix to fail without failing the workflow run. For example, if you wanted to only allow an experimental job with `node` set to `15` to fail without failing the workflow run.
1369
+
1370
+ {% raw %}
1371
+
1372
+ ```yaml
1373
+ runs-on: ${{ matrix.os }}
1374
+ continue-on-error: ${{ matrix.experimental }}
1375
+ strategy:
1376
+ fail-fast: false
1377
+ matrix:
1378
+ node: [13, 14]
1379
+ os: [macos-latest, ubuntu-latest]
1380
+ experimental: [false]
1381
+ include:
1382
+ - node: 15
1383
+ os: ubuntu-latest
1384
+ experimental: true
1385
+ ```
1386
+
1387
+ {% endraw %}
1388
+
1389
+ ## `jobs.<job_id>.container`
1390
+
1391
+ {% data reusables.actions.docker-container-os-support %}
1392
+
1393
+ {% data reusables.actions.jobs.section-running-jobs-in-a-container %}
1394
+
1395
+ ## `jobs.<job_id>.container.image`
1396
+
1397
+ {% data reusables.actions.jobs.section-running-jobs-in-a-container-image %}
1398
+
1399
+ ## `jobs.<job_id>.container.credentials`
1400
+
1401
+ {% data reusables.actions.jobs.section-running-jobs-in-a-container-credentials %}
1402
+
1403
+ ## `jobs.<job_id>.container.env`
1404
+
1405
+ {% data reusables.actions.jobs.section-running-jobs-in-a-container-env %}
1406
+
1407
+ ## `jobs.<job_id>.container.ports`
1408
+
1409
+ {% data reusables.actions.jobs.section-running-jobs-in-a-container-ports %}
1410
+
1411
+ ## `jobs.<job_id>.container.volumes`
1412
+
1413
+ {% data reusables.actions.jobs.section-running-jobs-in-a-container-volumes %}
1414
+
1415
+ ## `jobs.<job_id>.container.options`
1416
+
1417
+ {% data reusables.actions.jobs.section-running-jobs-in-a-container-options %}
1418
+
1419
+ ## `jobs.<job_id>.services`
1420
+
1421
+ {% data reusables.actions.docker-container-os-support %}
1422
+
1423
+ Used to host service containers for a job in a workflow. Service containers are useful for creating databases or cache services like Redis. The runner automatically creates a Docker network and manages the life cycle of the service containers.
1424
+
1425
+ If you configure your job to run in a container, or your step uses container actions, you don't need to map ports to access the service or action. Docker automatically exposes all ports between containers on the same Docker user-defined bridge network. You can directly reference the service container by its hostname. The hostname is automatically mapped to the label name you configure for the service in the workflow.
1426
+
1427
+ If you configure the job to run directly on the runner machine and your step doesn't use a container action, you must map any required Docker service container ports to the Docker host (the runner machine). You can access the service container using localhost and the mapped port.
1428
+
1429
+ For more information about the differences between networking service containers, see [AUTOTITLE](/actions/tutorials/use-containerized-services/use-docker-service-containers).
1430
+
1431
+ ### Example: Using localhost
1432
+
1433
+ This example creates two services: nginx and redis. When you specify the container port but not the host port, the container port is randomly assigned to a free port on the host. {% data variables.product.prodname_dotcom %} sets the assigned host port in the {% raw %}`${{job.services.<service_name>.ports}}`{% endraw %} context. In this example, you can access the service host ports using the {% raw %}`${{ job.services.nginx.ports['80'] }}`{% endraw %} and {% raw %}`${{ job.services.redis.ports['6379'] }}`{% endraw %} contexts.
1434
+
1435
+ ```yaml
1436
+ services:
1437
+ nginx:
1438
+ image: nginx
1439
+ # Map port 8080 on the Docker host to port 80 on the nginx container
1440
+ ports:
1441
+ - 8080:80
1442
+ redis:
1443
+ image: redis
1444
+ # Map random free TCP port on Docker host to port 6379 on redis container
1445
+ ports:
1446
+ - 6379/tcp
1447
+ steps:
1448
+ - run: |
1449
+ echo "Redis available on 127.0.0.1:{% raw %}${{ job.services.redis.ports['6379'] }}{% endraw %}"
1450
+ echo "Nginx available on 127.0.0.1:{% raw %}${{ job.services.nginx.ports['80'] }}{% endraw %}"
1451
+ ```
1452
+
1453
+ ## `jobs.<job_id>.services.<service_id>.image`
1454
+
1455
+ The Docker image to use as the service container to run the action. The value can be the Docker Hub image name or a registry name.
1456
+
1457
+ If `jobs.<job_id>.services.<service_id>.image` is assigned an empty string, the service will not start. You can use this to set up conditional services, similar to the following example.
1458
+
1459
+ ```yaml
1460
+ services:
1461
+ nginx:
1462
+ image: {% raw %}${{ options.nginx == true && 'nginx' || '' }}{% endraw %}
1463
+ ```
1464
+
1465
+ ## `jobs.<job_id>.services.<service_id>.credentials`
1466
+
1467
+ {% data reusables.actions.registry-credentials %}
1468
+
1469
+ ### Example of `jobs.<job_id>.services.<service_id>.credentials`
1470
+
1471
+ {% raw %}
1472
+
1473
+ ```yaml
1474
+ services:
1475
+ myservice1:
1476
+ image: ghcr.io/owner/myservice1
1477
+ credentials:
1478
+ username: ${{ github.actor }}
1479
+ password: ${{ secrets.github_token }}
1480
+ myservice2:
1481
+ image: dockerhub_org/myservice2
1482
+ credentials:
1483
+ username: ${{ secrets.DOCKER_USER }}
1484
+ password: ${{ secrets.DOCKER_PASSWORD }}
1485
+ ```
1486
+
1487
+ {% endraw %}
1488
+
1489
+ ## `jobs.<job_id>.services.<service_id>.env`
1490
+
1491
+ Sets a `map` of environment variables in the service container.
1492
+
1493
+ ## `jobs.<job_id>.services.<service_id>.ports`
1494
+
1495
+ Sets an `array` of ports to expose on the service container.
1496
+
1497
+ ## `jobs.<job_id>.services.<service_id>.volumes`
1498
+
1499
+ Sets an `array` of volumes for the service container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host.
1500
+
1501
+ To specify a volume, you specify the source and destination path:
1502
+
1503
+ `<source>:<destinationPath>`.
1504
+
1505
+ The `<source>` is a volume name or an absolute path on the host machine, and `<destinationPath>` is an absolute path in the container.
1506
+
1507
+ ### Example of `jobs.<job_id>.services.<service_id>.volumes`
1508
+
1509
+ ```yaml
1510
+ volumes:
1511
+ - my_docker_volume:/volume_mount
1512
+ - /data/my_data
1513
+ - /source/directory:/destination/directory
1514
+ ```
1515
+
1516
+ ## `jobs.<job_id>.services.<service_id>.options`
1517
+
1518
+ Additional Docker container resource options. For a list of options, see [`docker create` options](https://docs.docker.com/engine/reference/commandline/create/#options).
1519
+
1520
+ > [!WARNING]
1521
+ > The `--network` option is not supported.
1522
+
1523
+ {% ifversion fpt or ghec %}
1524
+
1525
+ ## `jobs.<job_id>.services.<service_id>.command`
1526
+
1527
+ Overrides the Docker image's default command (`CMD`). The value is passed as arguments after the image name in the `docker create` command. If you also specify `entrypoint`, `command` provides the arguments to that entrypoint.
1528
+
1529
+ ### Example of `jobs.<job_id>.services.<service_id>.command`
1530
+
1531
+ ```yaml
1532
+ services:
1533
+ mysql:
1534
+ image: mysql:8
1535
+ command: --sql_mode=STRICT_TRANS_TABLES --max_allowed_packet=512M
1536
+ env:
1537
+ MYSQL_ROOT_PASSWORD: test
1538
+ ports:
1539
+ - 3306:3306
1540
+ ```
1541
+
1542
+ ## `jobs.<job_id>.services.<service_id>.entrypoint`
1543
+
1544
+ Overrides the Docker image's default `ENTRYPOINT`. The value is a single string defining the executable to run. Use this when you need to replace the image's entrypoint entirely. You can combine `entrypoint` with `command` to pass arguments to the custom entrypoint.
1545
+
1546
+ ### Example of `jobs.<job_id>.services.<service_id>.entrypoint`
1547
+
1548
+ ```yaml
1549
+ services:
1550
+ etcd:
1551
+ image: quay.io/coreos/etcd:v3.5.17
1552
+ entrypoint: etcd
1553
+ command: >-
1554
+ --listen-client-urls http://0.0.0.0:2379
1555
+ --advertise-client-urls http://0.0.0.0:2379
1556
+ ports:
1557
+ - 2379:2379
1558
+ ```
1559
+
1560
+ {% endif %}
1561
+
1562
+ ## `jobs.<job_id>.uses`
1563
+
1564
+ The location and version of a reusable workflow file to run as a job. Use one of the following syntaxes:
1565
+
1566
+ {% data reusables.actions.reusable-workflow-calling-syntax %}
1567
+
1568
+ ### Example of `jobs.<job_id>.uses`
1569
+
1570
+ {% data reusables.actions.uses-keyword-example %}
1571
+
1572
+ For more information, see [AUTOTITLE](/actions/how-tos/reuse-automations/reuse-workflows).
1573
+
1574
+ ## `jobs.<job_id>.with`
1575
+
1576
+ When a job is used to call a reusable workflow, you can use `with` to provide a map of inputs that are passed to the called workflow.
1577
+
1578
+ Any inputs that you pass must match the input specifications defined in the called workflow.
1579
+
1580
+ Unlike [`jobs.<job_id>.steps[*].with`](#jobsjob_idstepswith), the inputs you pass with `jobs.<job_id>.with` are not available as environment variables in the called workflow. Instead, you can reference the inputs by using the `inputs` context.
1581
+
1582
+ ### Example of `jobs.<job_id>.with`
1583
+
1584
+ ```yaml
1585
+ jobs:
1586
+ call-workflow:
1587
+ uses: octo-org/example-repo/.github/workflows/called-workflow.yml@main
1588
+ with:
1589
+ username: mona
1590
+ ```
1591
+
1592
+ ## `jobs.<job_id>.with.<input_id>`
1593
+
1594
+ A pair consisting of a string identifier for the input and the value of the input. The identifier must match the name of an input defined by [`on.workflow_call.inputs.<inputs_id>`](/actions/reference/workflows-and-actions/metadata-syntax#inputsinput_id) in the called workflow. The data type of the value must match the type defined by [`on.workflow_call.inputs.<input_id>.type`](#onworkflow_callinputsinput_idtype) in the called workflow.
1595
+
1596
+ Allowed expression contexts: `github`, `needs`, `strategy`, `matrix`, `inputs`, and `vars`.
1597
+
1598
+ ## `jobs.<job_id>.secrets`
1599
+
1600
+ When a job is used to call a reusable workflow, you can use `secrets` to provide a map of secrets that are passed to the called workflow.
1601
+
1602
+ Any secrets that you pass must match the names defined in the called workflow.
1603
+
1604
+ ### Example of `jobs.<job_id>.secrets`
1605
+
1606
+ {% raw %}
1607
+
1608
+ ```yaml
1609
+ jobs:
1610
+ call-workflow:
1611
+ uses: octo-org/example-repo/.github/workflows/called-workflow.yml@main
1612
+ secrets:
1613
+ access-token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
1614
+ ```
1615
+
1616
+ {% endraw %}
1617
+
1618
+ ## `jobs.<job_id>.secrets.inherit`
1619
+
1620
+ Use the `inherit` keyword to pass all the calling workflow's secrets to the called workflow. This includes all secrets the calling workflow has access to, namely organization, repository, and environment secrets. The `inherit` keyword can be used to pass secrets across repositories within the same organization, or across organizations within the same enterprise.
1621
+
1622
+ ### Example of `jobs.<job_id>.secrets.inherit`
1623
+
1624
+ {% raw %}
1625
+
1626
+ ```yaml
1627
+ on:
1628
+ workflow_dispatch:
1629
+
1630
+ jobs:
1631
+ pass-secrets-to-workflow:
1632
+ uses: ./.github/workflows/called-workflow.yml
1633
+ secrets: inherit
1634
+ ```
1635
+
1636
+ ```yaml
1637
+ on:
1638
+ workflow_call:
1639
+
1640
+ jobs:
1641
+ pass-secret-to-action:
1642
+ runs-on: ubuntu-latest
1643
+ steps:
1644
+ - name: Use a repo or org secret from the calling workflow.
1645
+ run: echo ${{ secrets.CALLING_WORKFLOW_SECRET }}
1646
+ ```
1647
+
1648
+ {% endraw %}
1649
+
1650
+ ## `jobs.<job_id>.secrets.<secret_id>`
1651
+
1652
+ A pair consisting of a string identifier for the secret and the value of the secret. The identifier must match the name of a secret defined by [`on.workflow_call.secrets.<secret_id>`](#onworkflow_callsecretssecret_id) in the called workflow.
1653
+
1654
+ Allowed expression contexts: `github`, `needs`, `strategy`, `matrix`, `secrets`, `inputs`, and `vars`.
1655
+
1656
+ ## Filter pattern cheat sheet
1657
+
1658
+ You can use special characters in path, branch, tag, and workflow name filters.
1659
+
1660
+ * `*`: Matches zero or more characters, but does not match the `/` character. For example, `Octo*` matches `Octocat`.
1661
+ * `**`: Matches zero or more of any character.
1662
+ * `?`: Matches zero or one of the preceding character.
1663
+ * `+`: Matches one or more of the preceding character.
1664
+ * `[]` Matches one alphanumeric character listed in the brackets or included in ranges. Ranges can only include `a-z`, `A-Z`, and `0-9`. For example, the range`[0-9a-z]` matches any digit or lowercase letter. For example, `[CB]at` matches `Cat` or `Bat` and `[1-2]00` matches `100` and `200`.
1665
+ * `!`: At the start of a pattern makes it negate previous positive patterns. It has no special meaning if not the first character.
1666
+
1667
+ The characters `*`, `[`, and `!` are special characters in YAML. If you start a pattern with `*`, `[`, or `!`, you must enclose the pattern in quotes. Also, if you use a [flow sequence](https://yaml.org/spec/1.2.2/#flow-sequences) with a pattern containing `[` and/or `]`, the pattern must be enclosed in quotes.
1668
+
1669
+ ```yaml
1670
+ # Valid
1671
+ paths:
1672
+ - '**/README.md'
1673
+
1674
+ # Invalid - creates a parse error that
1675
+ # prevents your workflow from running.
1676
+ paths:
1677
+ - **/README.md
1678
+
1679
+ # Valid
1680
+ branches: [ main, 'release/v[0-9].[0-9]' ]
1681
+
1682
+ # Invalid - creates a parse error
1683
+ branches: [ main, release/v[0-9].[0-9] ]
1684
+ ```
1685
+
1686
+ For more information about branch, tag, and path filter syntax, see [`on.<push>.<branches|tags>`](#onpushbranchestagsbranches-ignoretags-ignore), [`on.<pull_request>.<branches|tags>`](#onpull_requestpull_request_targetbranchesbranches-ignore), and [`on.<push|pull_request>.paths`](#onpushpull_requestpull_request_targetpathspaths-ignore).
1687
+
1688
+ ### Patterns to match branches and tags
1689
+
1690
+ | Pattern | Description | Example matches |
1691
+ | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
1692
+ | `feature/*` | The `*` wildcard matches any character, but does not match slash (`/`). | `feature/my-branch`<br/><br/>`feature/your-branch` |
1693
+ | `feature/**` | The `**` wildcard matches any character including slash (`/`) in branch and tag names. | `feature/beta-a/my-branch`<br/><br/>`feature/your-branch`<br/><br/>`feature/mona/the/octocat` |
1694
+ | `main`<br/><br/>`releases/mona-the-octocat` | Matches the exact name of a branch or tag name. | `main`<br/><br/>`releases/mona-the-octocat` |
1695
+ | `'*'` | Matches all branch and tag names that don't contain a slash (`/`). The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | `main`<br/><br/>`releases` |
1696
+ | `'**'` | Matches all branch and tag names. This is the default behavior when you don't use a `branches` or `tags` filter. | `all/the/branches`<br/><br/>`every/tag` |
1697
+ | `'*feature'` | The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | `mona-feature`<br/><br/>`feature`<br/><br/>`ver-10-feature` |
1698
+ | `v2*` | Matches branch and tag names that start with `v2`. | `v2`<br/><br/>`v2.0`<br/><br/>`v2.9` |
1699
+ | `v[12].[0-9]+.[0-9]+` | Matches all semantic versioning branches and tags with major version 1 or 2. | `v1.10.1`<br/><br/>`v2.0.0` |
1700
+
1701
+ ### Patterns to match file paths
1702
+
1703
+ Path patterns must match the whole path, and start from the repository's root.
1704
+
1705
+ | Pattern | Description of matches | Example matches |
1706
+ | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
1707
+ | `'*'` | The `*` wildcard matches any character, but does not match slash (`/`). The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | `README.md`<br/><br/>`server.rb` |
1708
+ | `'*.jsx?'` | The `?` character matches zero or one of the preceding character. | `page.js`<br/><br/>`page.jsx` |
1709
+ | `'**'` | The `**` wildcard matches any character including slash (`/`). This is the default behavior when you don't use a `path` filter. | `all/the/files.md` |
1710
+ | `'*.js'` | The `*` wildcard matches any character, but does not match slash (`/`). Matches all `.js` files at the root of the repository. | `app.js`<br/><br/>`index.js` |
1711
+ | `'**.js'` | Matches all `.js` files in the repository. | `index.js`<br/><br/>`js/index.js`<br/><br/>`src/js/app.js` |
1712
+ | `docs/*` | All files within the root of the `docs` directory only, at the root of the repository. | `docs/README.md`<br/><br/>`docs/file.txt` |
1713
+ | `docs/**` | Any files in the `docs` directory and its subdirectories at the root of the repository. | `docs/README.md`<br/><br/>`docs/mona/octocat.txt` |
1714
+ | `docs/**/*.md` | A file with a `.md` suffix anywhere in the `docs` directory. | `docs/README.md`<br/><br/>`docs/mona/hello-world.md`<br/><br/>`docs/a/markdown/file.md` |
1715
+ | `'**/docs/**'` | Any files in a `docs` directory anywhere in the repository. | `docs/hello.md`<br/><br/>`dir/docs/my-file.txt`<br/><br/>`space/docs/plan/space.doc` |
1716
+ | `'**/README.md'` | A README.md file anywhere in the repository. | `README.md`<br/><br/>`js/README.md` |
1717
+ | `'**/*src/**'` | Any file in a folder with a `src` suffix anywhere in the repository. | `a/src/app.js`<br/><br/>`my-src/code/js/app.js` |
1718
+ | `'**/*-post.md'` | A file with the suffix `-post.md` anywhere in the repository. | `my-post.md`<br/><br/>`path/their-post.md` |
1719
+ | `'**/migrate-*.sql'` | A file with the prefix `migrate-` and suffix `.sql` anywhere in the repository. | `migrate-10909.sql`<br/><br/>`db/migrate-v1.0.sql`<br/><br/>`db/sept/migrate-v1.sql` |
1720
+ | `'*.md'`<br/><br/>`'!README.md'` | Using an exclamation mark (`!`) in front of a pattern negates it. When a file matches a pattern and also matches a negative pattern defined later in the file, the file will not be included. | `hello.md`<br/><br/>_Does not match_<br/><br/>`README.md`<br/><br/>`docs/hello.md` |
1721
+ | `'*.md'`<br/><br/>`'!README.md'`<br/><br/>`README*` | Patterns are checked sequentially. A pattern that negates a previous pattern will re-include file paths. | `hello.md`<br/><br/>`README.md`<br/><br/>`README.doc` |