@intentius/chant 0.124.88 → 0.124.90

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 (377) hide show
  1. package/dist/actor.d.ts +36 -1
  2. package/dist/actor.d.ts.map +1 -1
  3. package/dist/actor.js +39 -1
  4. package/dist/chant-install.d.ts.map +1 -1
  5. package/dist/chant-install.js +1 -2
  6. package/dist/ci-base.d.ts +30 -0
  7. package/dist/ci-base.d.ts.map +1 -0
  8. package/dist/ci-base.js +33 -0
  9. package/dist/ci-comment-commands.d.ts +193 -0
  10. package/dist/ci-comment-commands.d.ts.map +1 -0
  11. package/dist/ci-comment-commands.js +353 -0
  12. package/dist/ci-comment-replies.d.ts +40 -0
  13. package/dist/ci-comment-replies.d.ts.map +1 -0
  14. package/dist/ci-comment-replies.js +59 -0
  15. package/dist/ci-evidence-from-job.d.ts +25 -0
  16. package/dist/ci-evidence-from-job.d.ts.map +1 -1
  17. package/dist/ci-evidence-from-job.js +43 -2
  18. package/dist/ci-evidence-jobs.d.ts +30 -1
  19. package/dist/ci-evidence-jobs.d.ts.map +1 -1
  20. package/dist/ci-evidence-jobs.js +46 -3
  21. package/dist/ci-image.d.ts +21 -4
  22. package/dist/ci-image.d.ts.map +1 -1
  23. package/dist/ci-image.js +62 -10
  24. package/dist/ci-job-guard.d.ts +42 -45
  25. package/dist/ci-job-guard.d.ts.map +1 -1
  26. package/dist/ci-job-guard.js +206 -3
  27. package/dist/ci-note-commands.d.ts +104 -4
  28. package/dist/ci-note-commands.d.ts.map +1 -1
  29. package/dist/ci-note-commands.js +131 -38
  30. package/dist/ci-product-words.d.ts +42 -0
  31. package/dist/ci-product-words.d.ts.map +1 -1
  32. package/dist/ci-product-words.js +25 -0
  33. package/dist/ci-product.d.ts +72 -1
  34. package/dist/ci-product.d.ts.map +1 -1
  35. package/dist/ci-product.js +73 -6
  36. package/dist/cli/commands/build.d.ts.map +1 -1
  37. package/dist/cli/commands/build.js +29 -2
  38. package/dist/cli/handlers/approve.d.ts.map +1 -1
  39. package/dist/cli/handlers/approve.js +2 -1
  40. package/dist/cli/handlers/ci-check.d.ts +1 -1
  41. package/dist/cli/handlers/ci-check.d.ts.map +1 -1
  42. package/dist/cli/handlers/ci-check.js +17 -7
  43. package/dist/cli/handlers/ci-evidence.d.ts.map +1 -1
  44. package/dist/cli/handlers/ci-evidence.js +33 -7
  45. package/dist/cli/handlers/components.d.ts.map +1 -1
  46. package/dist/cli/handlers/components.js +3 -1
  47. package/dist/cli/handlers/generated-check.d.ts +8 -0
  48. package/dist/cli/handlers/generated-check.d.ts.map +1 -1
  49. package/dist/cli/handlers/generated-check.js +31 -1
  50. package/dist/cli/handlers/lock.d.ts.map +1 -1
  51. package/dist/cli/handlers/lock.js +121 -4
  52. package/dist/cli/handlers/pr-comment.d.ts +33 -0
  53. package/dist/cli/handlers/pr-comment.d.ts.map +1 -0
  54. package/dist/cli/handlers/pr-comment.js +201 -0
  55. package/dist/cli/handlers/pr-env.d.ts.map +1 -1
  56. package/dist/cli/handlers/pr-env.js +6 -3
  57. package/dist/cli/handlers/pr-notes.d.ts.map +1 -1
  58. package/dist/cli/handlers/pr-notes.js +23 -1
  59. package/dist/cli/handlers/pr.d.ts +23 -1
  60. package/dist/cli/handlers/pr.d.ts.map +1 -1
  61. package/dist/cli/handlers/pr.js +71 -23
  62. package/dist/cli/handlers/promote.d.ts.map +1 -1
  63. package/dist/cli/handlers/promote.js +2 -1
  64. package/dist/cli/handlers/release.d.ts.map +1 -1
  65. package/dist/cli/handlers/release.js +11 -2
  66. package/dist/cli/handlers/run-wave.d.ts.map +1 -1
  67. package/dist/cli/handlers/run-wave.js +180 -4
  68. package/dist/cli/handlers/run.d.ts.map +1 -1
  69. package/dist/cli/handlers/run.js +2 -1
  70. package/dist/cli/main.d.ts.map +1 -1
  71. package/dist/cli/main.js +41 -2
  72. package/dist/cli/parse-args.d.ts.map +1 -1
  73. package/dist/cli/parse-args.js +31 -0
  74. package/dist/cli/registry.d.ts +19 -1
  75. package/dist/cli/registry.d.ts.map +1 -1
  76. package/dist/components/auto-release.d.ts.map +1 -1
  77. package/dist/components/auto-release.js +2 -1
  78. package/dist/components/pr-checks.d.ts +97 -6
  79. package/dist/components/pr-checks.d.ts.map +1 -1
  80. package/dist/components/pr-checks.js +107 -13
  81. package/dist/components/pr-pipeline.d.ts +19 -14
  82. package/dist/components/pr-pipeline.d.ts.map +1 -1
  83. package/dist/components/pr-pipeline.js +7 -13
  84. package/dist/components/product-pipeline.d.ts +96 -3
  85. package/dist/components/product-pipeline.d.ts.map +1 -1
  86. package/dist/components/product-pipeline.js +120 -14
  87. package/dist/components/product-plan.d.ts +203 -6
  88. package/dist/components/product-plan.d.ts.map +1 -1
  89. package/dist/components/product-plan.js +250 -43
  90. package/dist/drift-record.d.ts +7 -0
  91. package/dist/drift-record.d.ts.map +1 -1
  92. package/dist/drift-record.js +19 -0
  93. package/dist/floor-table.data.d.ts.map +1 -1
  94. package/dist/floor-table.data.js +63 -31
  95. package/dist/forge-check/contract.d.ts +11 -1
  96. package/dist/forge-check/contract.d.ts.map +1 -1
  97. package/dist/forge-check/contract.js +4 -1
  98. package/dist/forge-check/index.d.ts +2 -0
  99. package/dist/forge-check/index.d.ts.map +1 -1
  100. package/dist/forge-check/index.js +2 -0
  101. package/dist/gate-resume-run.d.ts +9 -1
  102. package/dist/gate-resume-run.d.ts.map +1 -1
  103. package/dist/gate-resume-run.js +26 -3
  104. package/dist/generated-check.d.ts +18 -4
  105. package/dist/generated-check.d.ts.map +1 -1
  106. package/dist/generated-check.js +37 -5
  107. package/dist/image-pins.d.ts +26 -0
  108. package/dist/image-pins.d.ts.map +1 -0
  109. package/dist/image-pins.js +19 -0
  110. package/dist/lexicon.d.ts +93 -4
  111. package/dist/lexicon.d.ts.map +1 -1
  112. package/dist/lifecycle/gate-applied.d.ts +9 -0
  113. package/dist/lifecycle/gate-applied.d.ts.map +1 -1
  114. package/dist/lifecycle/git.d.ts +11 -0
  115. package/dist/lifecycle/git.d.ts.map +1 -1
  116. package/dist/lifecycle/git.js +30 -3
  117. package/dist/lifecycle/publish-npm.d.ts +11 -0
  118. package/dist/lifecycle/publish-npm.d.ts.map +1 -1
  119. package/dist/lifecycle/publish-npm.js +27 -1
  120. package/dist/lifecycle/reach-locks.d.ts +131 -0
  121. package/dist/lifecycle/reach-locks.d.ts.map +1 -0
  122. package/dist/lifecycle/reach-locks.js +118 -0
  123. package/dist/lifecycle/release-cut.d.ts +3 -1
  124. package/dist/lifecycle/release-cut.d.ts.map +1 -1
  125. package/dist/lifecycle/release-cut.js +15 -0
  126. package/dist/lifecycle/release-images.d.ts.map +1 -1
  127. package/dist/lifecycle/release-images.js +1 -2
  128. package/dist/notify-product.d.ts +12 -3
  129. package/dist/notify-product.d.ts.map +1 -1
  130. package/dist/notify-product.js +10 -6
  131. package/dist/op/activities/source-release.d.ts.map +1 -1
  132. package/dist/op/activities/source-release.js +2 -1
  133. package/dist/op/activities/source-rollback.d.ts.map +1 -1
  134. package/dist/op/activities/source-rollback.js +2 -1
  135. package/dist/op/apply-status.d.ts +84 -0
  136. package/dist/op/apply-status.d.ts.map +1 -0
  137. package/dist/op/apply-status.js +106 -0
  138. package/dist/op/before-merge-decide.d.ts +102 -0
  139. package/dist/op/before-merge-decide.d.ts.map +1 -0
  140. package/dist/op/before-merge-decide.js +142 -0
  141. package/dist/op/before-merge-done.d.ts +56 -0
  142. package/dist/op/before-merge-done.d.ts.map +1 -0
  143. package/dist/op/before-merge-done.js +69 -0
  144. package/dist/op/before-merge-store.d.ts +20 -0
  145. package/dist/op/before-merge-store.d.ts.map +1 -0
  146. package/dist/op/before-merge-store.js +48 -0
  147. package/dist/op/before-merge.d.ts +150 -0
  148. package/dist/op/before-merge.d.ts.map +1 -0
  149. package/dist/op/before-merge.js +207 -0
  150. package/dist/op/follow-on-run.d.ts +117 -0
  151. package/dist/op/follow-on-run.d.ts.map +1 -0
  152. package/dist/op/follow-on-run.js +154 -0
  153. package/dist/op/follow-on-store.d.ts +17 -0
  154. package/dist/op/follow-on-store.d.ts.map +1 -0
  155. package/dist/op/follow-on-store.js +54 -0
  156. package/dist/op/gate.d.ts +6 -0
  157. package/dist/op/gate.d.ts.map +1 -1
  158. package/dist/op/gate.js +10 -1
  159. package/dist/op/index.d.ts +5 -1
  160. package/dist/op/index.d.ts.map +1 -1
  161. package/dist/op/index.js +2 -0
  162. package/dist/op/op-waves-after-plan.d.ts +13 -0
  163. package/dist/op/op-waves-after-plan.d.ts.map +1 -1
  164. package/dist/op/op-waves-evidence-jobs.d.ts +10 -2
  165. package/dist/op/op-waves-evidence-jobs.d.ts.map +1 -1
  166. package/dist/op/op-waves-evidence-jobs.js +19 -5
  167. package/dist/op/op-waves-follow-on.d.ts +162 -0
  168. package/dist/op/op-waves-follow-on.d.ts.map +1 -0
  169. package/dist/op/op-waves-follow-on.js +355 -0
  170. package/dist/op/op-waves-render-spec.d.ts +100 -0
  171. package/dist/op/op-waves-render-spec.d.ts.map +1 -0
  172. package/dist/op/op-waves-render-spec.js +162 -0
  173. package/dist/op/op-waves-run.d.ts +148 -6
  174. package/dist/op/op-waves-run.d.ts.map +1 -1
  175. package/dist/op/op-waves-run.js +873 -100
  176. package/dist/op/op-waves-split.d.ts +122 -0
  177. package/dist/op/op-waves-split.d.ts.map +1 -0
  178. package/dist/op/op-waves-split.js +166 -0
  179. package/dist/op/op-waves.d.ts +24 -0
  180. package/dist/op/op-waves.d.ts.map +1 -1
  181. package/dist/op/op-waves.js +18 -1
  182. package/dist/op/schedule-overdue.d.ts +15 -1
  183. package/dist/op/schedule-overdue.d.ts.map +1 -1
  184. package/dist/op/schedule-overdue.js +77 -5
  185. package/dist/op/stage-hooks.d.ts +36 -1
  186. package/dist/op/stage-hooks.d.ts.map +1 -1
  187. package/dist/op/stage-hooks.js +17 -3
  188. package/dist/op/wave-stop.d.ts +67 -0
  189. package/dist/op/wave-stop.d.ts.map +1 -0
  190. package/dist/op/wave-stop.js +129 -0
  191. package/dist/planned-files.d.ts +76 -0
  192. package/dist/planned-files.d.ts.map +1 -0
  193. package/dist/planned-files.js +108 -0
  194. package/dist/pr-forge-job.d.ts +22 -0
  195. package/dist/pr-forge-job.d.ts.map +1 -0
  196. package/dist/pr-forge-job.js +46 -0
  197. package/dist/pr-loop.d.ts +3 -6
  198. package/dist/pr-loop.d.ts.map +1 -1
  199. package/dist/pr-loop.js +4 -81
  200. package/dist/pr-plan-note.d.ts +97 -0
  201. package/dist/pr-plan-note.d.ts.map +1 -1
  202. package/dist/pr-plan-note.js +94 -1
  203. package/dist/pr-post.d.ts +28 -3
  204. package/dist/pr-post.d.ts.map +1 -1
  205. package/dist/pr-post.js +146 -13
  206. package/dist/pr-status.d.ts +16 -0
  207. package/dist/pr-status.d.ts.map +1 -0
  208. package/dist/pr-status.js +90 -0
  209. package/dist/ref-gate-init.d.ts +16 -2
  210. package/dist/ref-gate-init.d.ts.map +1 -1
  211. package/dist/ref-gate-init.js +24 -13
  212. package/dist/release-floors.d.ts +39 -1
  213. package/dist/release-floors.d.ts.map +1 -1
  214. package/dist/release-floors.js +63 -25
  215. package/dist/render-module.d.ts +15 -0
  216. package/dist/render-module.d.ts.map +1 -0
  217. package/dist/render-module.js +73 -0
  218. package/dist/state-migration.d.ts.map +1 -1
  219. package/dist/state-migration.js +1 -2
  220. package/dist/wave-blocked.d.ts +7 -1
  221. package/dist/wave-blocked.d.ts.map +1 -1
  222. package/dist/wave-blocked.js +7 -2
  223. package/dist/wave-runtime.mjs +366 -350
  224. package/dist/workspace/ci-green-cli.d.ts.map +1 -1
  225. package/dist/workspace/ci-green-cli.js +3 -2
  226. package/dist/workspace/release-train.d.ts.map +1 -1
  227. package/dist/workspace/release-train.js +2 -1
  228. package/dist/workspace/release-workflow.d.ts +4 -3
  229. package/dist/workspace/release-workflow.d.ts.map +1 -1
  230. package/dist/workspace/release-workflow.js +10 -7
  231. package/dist/workspace/trust/check-evidence-report.d.ts +7 -2
  232. package/dist/workspace/trust/check-evidence-report.d.ts.map +1 -1
  233. package/dist/workspace/trust/check-evidence-report.js +15 -8
  234. package/dist/workspace/trust/ref-gate-cli.d.ts +10 -1
  235. package/dist/workspace/trust/ref-gate-cli.d.ts.map +1 -1
  236. package/dist/workspace/trust/ref-gate-cli.js +30 -10
  237. package/dist/workspace/workspace-run.d.ts.map +1 -1
  238. package/dist/workspace/workspace-run.js +2 -1
  239. package/package.json +1 -1
  240. package/src/actor.test.ts +68 -2
  241. package/src/actor.ts +61 -1
  242. package/src/chant-install.test.ts +2 -3
  243. package/src/chant-install.ts +1 -2
  244. package/src/ci-base.test.ts +41 -0
  245. package/src/ci-base.ts +43 -0
  246. package/src/ci-comment-commands.test.ts +439 -0
  247. package/src/ci-comment-commands.ts +428 -0
  248. package/src/ci-comment-replies.ts +78 -0
  249. package/src/ci-commit.test.ts +2 -3
  250. package/src/ci-evidence-from-job.test.ts +18 -0
  251. package/src/ci-evidence-from-job.ts +58 -2
  252. package/src/ci-evidence-jobs.ts +50 -5
  253. package/src/ci-image.test.ts +130 -10
  254. package/src/ci-image.ts +85 -12
  255. package/src/ci-job-guard.before-merge.test.ts +148 -0
  256. package/src/ci-job-guard.follow-on-record.test.ts +137 -0
  257. package/src/ci-job-guard.follow-on.test.ts +144 -0
  258. package/src/ci-job-guard.ts +221 -3
  259. package/src/ci-note-commands.test.ts +76 -1
  260. package/src/ci-note-commands.ts +198 -46
  261. package/src/ci-product-words.ts +59 -0
  262. package/src/ci-product.ts +90 -6
  263. package/src/cli/commands/build.test.ts +41 -0
  264. package/src/cli/commands/build.ts +27 -2
  265. package/src/cli/handlers/approve.ts +2 -1
  266. package/src/cli/handlers/ci-check.ts +19 -7
  267. package/src/cli/handlers/ci-evidence.ts +29 -8
  268. package/src/cli/handlers/components.ts +3 -1
  269. package/src/cli/handlers/generated-check.ts +31 -1
  270. package/src/cli/handlers/lock-reach.test.ts +103 -0
  271. package/src/cli/handlers/lock.ts +100 -4
  272. package/src/cli/handlers/pr-comment.ts +187 -0
  273. package/src/cli/handlers/pr-env.ts +6 -3
  274. package/src/cli/handlers/pr-notes.ts +30 -6
  275. package/src/cli/handlers/pr-record.test.ts +1 -1
  276. package/src/cli/handlers/pr.ts +64 -21
  277. package/src/cli/handlers/promote.ts +2 -1
  278. package/src/cli/handlers/release.e2e.test.ts +35 -0
  279. package/src/cli/handlers/release.ts +14 -2
  280. package/src/cli/handlers/run-wave.ts +170 -4
  281. package/src/cli/handlers/run.ts +2 -1
  282. package/src/cli/main.ts +41 -2
  283. package/src/cli/parse-args.ts +23 -0
  284. package/src/cli/registry.ts +19 -1
  285. package/src/components/auto-release.ts +2 -1
  286. package/src/components/pr-checks.ts +165 -17
  287. package/src/components/pr-pipeline.ts +22 -18
  288. package/src/components/product-pipeline.apply-status.test.ts +50 -0
  289. package/src/components/product-pipeline.ts +204 -17
  290. package/src/components/product-plan.test.ts +60 -4
  291. package/src/components/product-plan.ts +367 -50
  292. package/src/drift-record.test.ts +20 -0
  293. package/src/drift-record.ts +16 -0
  294. package/src/floor-table.data.ts +63 -31
  295. package/src/forge-check/contract.ts +12 -1
  296. package/src/forge-check/forge-check.test.ts +17 -0
  297. package/src/forge-check/index.ts +2 -0
  298. package/src/gate-resume-run.ts +27 -3
  299. package/src/generated-check.e2e.test.ts +21 -1
  300. package/src/generated-check.test.ts +66 -0
  301. package/src/generated-check.ts +51 -10
  302. package/src/image-pins.ts +31 -0
  303. package/src/lexicon.ts +89 -1
  304. package/src/lifecycle/gate-applied.ts +7 -0
  305. package/src/lifecycle/git.test.ts +48 -0
  306. package/src/lifecycle/git.ts +27 -4
  307. package/src/lifecycle/publish-npm.ts +31 -1
  308. package/src/lifecycle/reach-locks.test.ts +87 -0
  309. package/src/lifecycle/reach-locks.ts +169 -0
  310. package/src/lifecycle/release-cut.ts +17 -1
  311. package/src/lifecycle/release-images.test.ts +56 -0
  312. package/src/lifecycle/release-images.ts +1 -2
  313. package/src/notify-product.ts +19 -8
  314. package/src/op/activities/source-release.ts +2 -1
  315. package/src/op/activities/source-rollback.ts +2 -1
  316. package/src/op/apply-status.test.ts +83 -0
  317. package/src/op/apply-status.ts +132 -0
  318. package/src/op/before-merge-decide.ts +190 -0
  319. package/src/op/before-merge-done.ts +99 -0
  320. package/src/op/before-merge-store.ts +44 -0
  321. package/src/op/before-merge.test.ts +201 -0
  322. package/src/op/before-merge.ts +266 -0
  323. package/src/op/follow-on-run.ts +206 -0
  324. package/src/op/follow-on-store.ts +54 -0
  325. package/src/op/gate-resume.test.ts +27 -0
  326. package/src/op/gate.ts +16 -1
  327. package/src/op/index.ts +15 -0
  328. package/src/op/op-waves-after-plan.ts +13 -0
  329. package/src/op/op-waves-evidence-jobs.ts +21 -7
  330. package/src/op/op-waves-follow-on-record.test.ts +152 -0
  331. package/src/op/op-waves-follow-on.test.ts +247 -0
  332. package/src/op/op-waves-follow-on.ts +385 -0
  333. package/src/op/op-waves-notify-words.test.ts +18 -0
  334. package/src/op/op-waves-render-spec.test.ts +159 -0
  335. package/src/op/op-waves-render-spec.ts +171 -0
  336. package/src/op/op-waves-run.ts +973 -94
  337. package/src/op/op-waves-split-product.test.ts +288 -0
  338. package/src/op/op-waves-split-step.test.ts +298 -0
  339. package/src/op/op-waves-split.test.ts +196 -0
  340. package/src/op/op-waves-split.ts +189 -0
  341. package/src/op/op-waves.ts +31 -3
  342. package/src/op/schedule-overdue.test.ts +72 -1
  343. package/src/op/schedule-overdue.ts +84 -6
  344. package/src/op/stage-hooks.ts +52 -4
  345. package/src/op/wave-stop.test.ts +72 -0
  346. package/src/op/wave-stop.ts +139 -0
  347. package/src/planned-files.test.ts +80 -0
  348. package/src/planned-files.ts +134 -0
  349. package/src/pr-forge-job.test.ts +53 -0
  350. package/src/pr-forge-job.ts +46 -0
  351. package/src/pr-loop-narrowed.test.ts +2 -1
  352. package/src/pr-loop-words.test.ts +2 -1
  353. package/src/pr-loop.test.ts +1 -2
  354. package/src/pr-loop.ts +4 -80
  355. package/src/pr-plan-note.ts +155 -3
  356. package/src/pr-post-replan.test.ts +144 -0
  357. package/src/pr-post-subject.test.ts +230 -0
  358. package/src/pr-post.test.ts +2 -1
  359. package/src/pr-post.ts +151 -15
  360. package/src/pr-status.ts +91 -0
  361. package/src/ref-gate-init.ts +30 -11
  362. package/src/release-floors.ts +81 -25
  363. package/src/render-module.ts +73 -0
  364. package/src/state-migration-record.test.ts +2 -3
  365. package/src/state-migration.ts +1 -2
  366. package/src/wave-blocked.ts +9 -4
  367. package/src/workspace/ci-green-cli.ts +3 -2
  368. package/src/workspace/ci-green-workflow.test.ts +32 -1
  369. package/src/workspace/release-train.ts +2 -1
  370. package/src/workspace/release-workflow.test.ts +36 -5
  371. package/src/workspace/release-workflow.ts +10 -7
  372. package/src/workspace/trust/check-evidence-report.ts +15 -8
  373. package/src/workspace/trust/check-evidence.test.ts +5 -0
  374. package/src/workspace/trust/ref-gate-cli.ts +30 -8
  375. package/src/workspace/trust/ref-gate-pieces.test.ts +46 -1
  376. package/src/workspace/trust/ref-gate.test.ts +10 -0
  377. package/src/workspace/workspace-run.ts +2 -1
@@ -80,6 +80,34 @@ export type OpWaveExec = (argv: string[], cwd: string, env?: Record<string, stri
80
80
  export declare const spawnExec: OpWaveExec;
81
81
  /** {@link OpWaveExec} for {@link runStageHooksAsync} (#4334): the exit code comes back as a promise, so the event loop runs while a hook does. */
82
82
  export type OpWaveAsyncExec = (argv: string[], cwd: string, env?: Record<string, string>) => Promise<number>;
83
+ /**
84
+ * One call of a hook a product serves in its own process (#4994), as
85
+ * {@link OpWaveInProcessHook} gets it: the hook's name and moment, its run
86
+ * for a `perRun` hook, the argv its command would have run with, the job's
87
+ * directory and the `CHANT_*` variables the command would have had.
88
+ */
89
+ export interface OpWaveInProcessHookCall {
90
+ name: string;
91
+ moment: CiHookMoment;
92
+ target?: string;
93
+ argv: string[];
94
+ cwd: string;
95
+ env: Record<string, string>;
96
+ }
97
+ /**
98
+ * A hook a product's bin serves in the job's own process (#4994), in place
99
+ * of the hook's command: the spec, read at base, still names the hook and
100
+ * its command, and a job whose process hands a function under that name
101
+ * calls it with the command's argv and variables. Its exit code counts as
102
+ * the command's would, a hold included: it writes `CHANT_HOLD` and returns
103
+ * non-zero. It runs in whichever job runs the hook, so one split wave's plan,
104
+ * gate and applying jobs each call it in their own process; what it needs
105
+ * from an earlier job it reads from files that job left, such as its own
106
+ * under `opWaveProductStateDir` (`./op-waves-split.ts`), which the plan job
107
+ * hands the gate and applying jobs. This replaces a hook that called back
108
+ * into a long-lived product process over a socket.
109
+ */
110
+ export type OpWaveInProcessHook = (call: OpWaveInProcessHookCall) => Promise<number>;
83
111
  /** {@link spawnExec} on `spawn`: it rejects when the command cannot start. */
84
112
  export declare const spawnExecAsync: OpWaveAsyncExec;
85
113
  /** Fill one argv template. A placeholder whose value is not given is left as it is. */
@@ -128,15 +156,22 @@ export interface HookPlace {
128
156
  /** Where a hook writes a hold on another gate (`CHANT_HOLD`). Default: under the wave's directory. */
129
157
  holdPath?: string;
130
158
  }
159
+ /** The in-process hook a product serves under `name` (#4994), or undefined: an own property that is a function. */
160
+ export declare function inProcessHookOf(hooks: Readonly<Record<string, OpWaveInProcessHook>> | undefined, name: string): OpWaveInProcessHook | undefined;
131
161
  /**
132
162
  * Run one moment's hooks, in order: each once for the wave, or once per run
133
163
  * for a `perRun` hook. A hook that fails stops the rest, unless its
134
164
  * `onFailure` is `approve`: then it holds the wave and the hooks after it run.
135
165
  */
136
166
  export declare function runHookList(at: HookPlace, moment: CiHookMoment, hooks: readonly OpWaveHook[] | undefined, runs: readonly OpWaveHookRun[], runsPath: string, extraEnv?: Record<string, string>): HookListOutcome;
137
- /** {@link runHookList} with an exec that returns a promise (#4334). */
167
+ /**
168
+ * {@link runHookList} with an exec that returns a promise (#4334). A hook
169
+ * whose name `at.inProcess` holds is called in this process in place of its
170
+ * command (#4994).
171
+ */
138
172
  export declare function runHookListAsync(at: Omit<HookPlace, "exec"> & {
139
173
  exec: OpWaveAsyncExec;
174
+ inProcess?: Readonly<Record<string, OpWaveInProcessHook>>;
140
175
  }, moment: CiHookMoment, hooks: readonly OpWaveHook[] | undefined, runs: readonly OpWaveHookRun[], runsPath: string, extraEnv?: Record<string, string>): Promise<HookListOutcome>;
141
176
  /** The options of {@link runStageHooks} (#4288). */
142
177
  export interface RunStageHooksOptions {
@@ -1 +1 @@
1
- {"version":3,"file":"stage-hooks.d.ts","sourceRoot":"","sources":["../../src/op/stage-hooks.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAKH,OAAO,EAAkB,KAAK,YAAY,EAAE,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAEhF,mFAAmF;AACnF,MAAM,WAAW,eAAe;IAC9B,qFAAqF;IACrF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,yDAAyD;IACzD,UAAU,EAAE,aAAa,EAAE,CAAC;CAC7B;AAED,iGAAiG;AACjG,eAAO,MAAM,wBAAwB,YACnC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EACjG,aAAa,EAAE,QAAQ,EAAE,cAAc,EAAE,UAAU,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CACvF,CAAC;AAEX,4HAA4H;AAC5H,MAAM,WAAW,iBAAiB;IAChC,mEAAmE;IACnE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gEAAgE;IAChE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CACpD;AAED,8BAA8B;AAC9B,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;IAClD,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,yCAAyC;AACzC,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;IACX,yCAAyC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4GAA4G;IAC5G,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yHAAyH;AACzH,MAAM,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC;AAE/F,eAAO,MAAM,SAAS,EAAE,UAIvB,CAAC;AAEF,kJAAkJ;AAClJ,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAE7G,8EAA8E;AAC9E,eAAO,MAAM,cAAc,EAAE,eAKzB,CAAC;AAEL,uFAAuF;AACvF,wBAAgB,UAAU,CACxB,QAAQ,EAAE,SAAS,MAAM,EAAE,EAC3B,MAAM,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GACrH,MAAM,EAAE,CAWV;AAED,+IAA+I;AAC/I,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAOhG;AAED,mHAAmH;AACnH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5B,OAAO,EAAE,iBAAiB,CAAC;CAC5B;AAED,qHAAqH;AACrH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAqBvH;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS,CAmBzH;AAED,wFAAwF;AACxF,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEzD;AAED,oEAAoE;AACpE,MAAM,WAAW,SAAS;IACxB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,CAAC,EAAE,MAAM,CAAC;IACV,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,UAAU,CAAC;IACjB,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5B,sGAAsG;IACtG,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAuFD;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,EAAE,EAAE,SAAS,EACb,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,SAAS,UAAU,EAAE,GAAG,SAAS,EACxC,IAAI,EAAE,SAAS,aAAa,EAAE,EAC9B,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GACpC,eAAe,CAcjB;AAED,uEAAuE;AACvE,wBAAsB,gBAAgB,CACpC,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG;IAAE,IAAI,EAAE,eAAe,CAAA;CAAE,EACvD,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,SAAS,UAAU,EAAE,GAAG,SAAS,EACxC,IAAI,EAAE,SAAS,aAAa,EAAE,EAC9B,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GACpC,OAAO,CAAC,eAAe,CAAC,CAc1B;AAED,oDAAoD;AACpD,MAAM,WAAW,oBAAoB;IACnC,2FAA2F;IAC3F,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,qEAAqE;IACrE,IAAI,EAAE,SAAS,aAAa,EAAE,CAAC;IAC/B,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yCAAyC;IACzC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC9B;AAED,uCAAuC;AACvC,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,qFAAqF;IACrF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6FAA6F;IAC7F,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,iGAAiG;IACjG,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;CAC9B;AAED,2EAA2E;AAC3E,MAAM,WAAW,yBAA0B,SAAQ,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC;IACnF,uCAAuC;IACvC,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAaD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,UAAU,EAAE,GAAG,SAAS,EAAE,OAAO,EAAE,oBAAoB,GAAG,aAAa,CAG1I;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,UAAU,EAAE,GAAG,SAAS,EAAE,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC,CAGnK"}
1
+ {"version":3,"file":"stage-hooks.d.ts","sourceRoot":"","sources":["../../src/op/stage-hooks.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAKH,OAAO,EAAkB,KAAK,YAAY,EAAE,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAEhF,mFAAmF;AACnF,MAAM,WAAW,eAAe;IAC9B,qFAAqF;IACrF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,yDAAyD;IACzD,UAAU,EAAE,aAAa,EAAE,CAAC;CAC7B;AAED,iGAAiG;AACjG,eAAO,MAAM,wBAAwB,YACnC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EACjG,aAAa,EAAE,QAAQ,EAAE,cAAc,EAAE,UAAU,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CACvF,CAAC;AAEX,4HAA4H;AAC5H,MAAM,WAAW,iBAAiB;IAChC,mEAAmE;IACnE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gEAAgE;IAChE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CACpD;AAED,8BAA8B;AAC9B,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;IAClD,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,yCAAyC;AACzC,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;IACX,yCAAyC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4GAA4G;IAC5G,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yHAAyH;AACzH,MAAM,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC;AAE/F,eAAO,MAAM,SAAS,EAAE,UAIvB,CAAC;AAEF,kJAAkJ;AAClJ,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAE7G;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC7B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,IAAI,EAAE,uBAAuB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAErF,8EAA8E;AAC9E,eAAO,MAAM,cAAc,EAAE,eAKzB,CAAC;AAEL,uFAAuF;AACvF,wBAAgB,UAAU,CACxB,QAAQ,EAAE,SAAS,MAAM,EAAE,EAC3B,MAAM,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GACrH,MAAM,EAAE,CAWV;AAED,+IAA+I;AAC/I,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAOhG;AAED,mHAAmH;AACnH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5B,OAAO,EAAE,iBAAiB,CAAC;CAC5B;AAED,qHAAqH;AACrH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAqBvH;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS,CAmBzH;AAED,wFAAwF;AACxF,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEzD;AAED,oEAAoE;AACpE,MAAM,WAAW,SAAS;IACxB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,CAAC,EAAE,MAAM,CAAC;IACV,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,UAAU,CAAC;IACjB,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5B,sGAAsG;IACtG,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAqFD,mHAAmH;AACnH,wBAAgB,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS,CAI/I;AAQD;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,EAAE,EAAE,SAAS,EACb,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,SAAS,UAAU,EAAE,GAAG,SAAS,EACxC,IAAI,EAAE,SAAS,aAAa,EAAE,EAC9B,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GACpC,eAAe,CAcjB;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CACpC,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAA;CAAE,EAClH,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,SAAS,UAAU,EAAE,GAAG,SAAS,EACxC,IAAI,EAAE,SAAS,aAAa,EAAE,EAC9B,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GACpC,OAAO,CAAC,eAAe,CAAC,CAiB1B;AAED,oDAAoD;AACpD,MAAM,WAAW,oBAAoB;IACnC,2FAA2F;IAC3F,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,qEAAqE;IACrE,IAAI,EAAE,SAAS,aAAa,EAAE,CAAC;IAC/B,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yCAAyC;IACzC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC9B;AAED,uCAAuC;AACvC,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,qFAAqF;IACrF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6FAA6F;IAC7F,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,iGAAiG;IACjG,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;CAC9B;AAED,2EAA2E;AAC3E,MAAM,WAAW,yBAA0B,SAAQ,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC;IACnF,uCAAuC;IACvC,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAaD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,UAAU,EAAE,GAAG,SAAS,EAAE,OAAO,EAAE,oBAAoB,GAAG,aAAa,CAG1I;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,UAAU,EAAE,GAAG,SAAS,EAAE,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC,CAGnK"}
@@ -157,7 +157,7 @@ function* hookListSteps(at, moment, hooks, runs, runsPath, extraEnv) {
157
157
  for (const call of calls) {
158
158
  const label = `${moment} hook ${name}${call.target ? ` (${call.target})` : ""}`;
159
159
  rmSync(join(cwd, holdPath), { force: true });
160
- const code = yield { label, argv: call.argv, cwd, env: call.env };
160
+ const code = yield { label, name, moment, ...(call.target ? { target: call.target } : {}), argv: call.argv, cwd, env: call.env };
161
161
  const base = { moment, name, ...(call.target ? { target: call.target } : {}), exit: code };
162
162
  if (code === 0) {
163
163
  out.outcomes.push({ ...base, outcome: "passed" });
@@ -183,6 +183,13 @@ function* hookListSteps(at, moment, hooks, runs, runsPath, extraEnv) {
183
183
  }
184
184
  return out;
185
185
  }
186
+ /** The in-process hook a product serves under `name` (#4994), or undefined: an own property that is a function. */
187
+ export function inProcessHookOf(hooks, name) {
188
+ if (!hooks || !Object.prototype.hasOwnProperty.call(hooks, name))
189
+ return undefined;
190
+ const fn = hooks[name];
191
+ return typeof fn === "function" ? fn : undefined;
192
+ }
186
193
  /** The exit code a call that did not start counts as, after its error is logged. */
187
194
  function didNotRun(call, err, log) {
188
195
  log(`${call.label} did not run: ${err instanceof Error ? err.message : String(err)}`);
@@ -209,7 +216,11 @@ export function runHookList(at, moment, hooks, runs, runsPath, extraEnv = {}) {
209
216
  }
210
217
  return step.value;
211
218
  }
212
- /** {@link runHookList} with an exec that returns a promise (#4334). */
219
+ /**
220
+ * {@link runHookList} with an exec that returns a promise (#4334). A hook
221
+ * whose name `at.inProcess` holds is called in this process in place of its
222
+ * command (#4994).
223
+ */
213
224
  export async function runHookListAsync(at, moment, hooks, runs, runsPath, extraEnv = {}) {
214
225
  const steps = hookListSteps(at, moment, hooks, runs, runsPath, extraEnv);
215
226
  let step = steps.next();
@@ -217,7 +228,10 @@ export async function runHookListAsync(at, moment, hooks, runs, runsPath, extraE
217
228
  const call = step.value;
218
229
  let code;
219
230
  try {
220
- code = await at.exec(call.argv, call.cwd, call.env);
231
+ const own = inProcessHookOf(at.inProcess, call.name);
232
+ code = own
233
+ ? await own({ name: call.name, moment: call.moment, ...(call.target ? { target: call.target } : {}), argv: call.argv, cwd: call.cwd, env: call.env })
234
+ : await at.exec(call.argv, call.cwd, call.env);
221
235
  }
222
236
  catch (err) {
223
237
  code = didNotRun(call, err, at.log);
@@ -0,0 +1,67 @@
1
+ /**
2
+ * A wave stop on a re-run (#4979): `/<product> apply wave-<n>` on a merged
3
+ * pull request runs its apply again and stops after wave n.
4
+ *
5
+ * A forge re-run cannot be told where to stop: GitHub's re-run of a run's
6
+ * failed jobs runs every job after them, Forgejo's dispatch runs the whole
7
+ * workflow, and GitLab runs the jobs after a retried one by itself. So the
8
+ * comment's job writes the stop on `chant/lifecycle` before it starts the
9
+ * run, `_waves/<op>.stops.json`, keyed by the commit the run applies, and
10
+ * each wave job of op `<op>` at that commit reads it before it plans: a wave
11
+ * after the stop waits, as a wave whose gate has no approval waits (exit 3),
12
+ * so a later `/<product> apply` runs it. An apply comment without a wave
13
+ * clears the commit's stop. The newest {@link WAVE_STOPS_KEPT} stops are
14
+ * kept.
15
+ */
16
+ /** The directory of the stops on `chant/lifecycle`. */
17
+ export declare const WAVE_STOPS_DIR = "_waves";
18
+ /** How many commits' stops the file keeps. */
19
+ export declare const WAVE_STOPS_KEPT = 50;
20
+ /** The stops file of op `op`. */
21
+ export declare function waveStopsFile(op: string): string;
22
+ /** One commit's stop: the last wave that runs, and who asked. */
23
+ export interface WaveStop {
24
+ through: number;
25
+ at: string;
26
+ by?: string;
27
+ pr?: number;
28
+ }
29
+ /** The stops file. */
30
+ export interface WaveStopsFile {
31
+ version: 1;
32
+ stops: Record<string, WaveStop>;
33
+ }
34
+ /** Read a stops file; anything that is not one reads as no stops, and a malformed entry is dropped. */
35
+ export declare function parseWaveStops(text: string | null): WaveStopsFile;
36
+ /** The file's text: the newest {@link WAVE_STOPS_KEPT} stops, by commit. */
37
+ export declare function renderWaveStops(file: WaveStopsFile): string;
38
+ /** Whether wave `k` waits under `stop`. */
39
+ export declare function waveStopped(stop: WaveStop | undefined, k: number): boolean;
40
+ /** The stop of op `op` at commit `sha`, from the local `chant/lifecycle` after a fetch. Undefined when there is none or the branch cannot be read. */
41
+ export declare function waveStopAt(op: string, sha: string, opts?: {
42
+ cwd?: string;
43
+ }): Promise<WaveStop | undefined>;
44
+ /**
45
+ * What a wave job of op `op` says when wave `k` waits behind a comment's
46
+ * stop at the job's checkout (`git rev-parse HEAD`). Undefined when it runs:
47
+ * no stop, no commit to read, or a branch that cannot be read, so a stop
48
+ * never fails a wave that would have run. `sha` (#4987) names the commit
49
+ * in place of the checkout's: a split wave's gate job runs at the default
50
+ * branch and reads the stop of the decided head.
51
+ */
52
+ export declare function waveStopLine(op: string, k: number, opts?: {
53
+ cwd?: string;
54
+ sha?: string;
55
+ }): Promise<string | undefined>;
56
+ /**
57
+ * Set op `op`'s stop at commit `sha`, or clear it (`stop` null), and push
58
+ * `chant/lifecycle`. Read, written and pushed again when another writer
59
+ * pushed first, up to three times.
60
+ */
61
+ export declare function setWaveStop(op: string, sha: string, stop: WaveStop | null, opts?: {
62
+ cwd?: string;
63
+ }): Promise<{
64
+ changed: boolean;
65
+ pushed: boolean;
66
+ }>;
67
+ //# sourceMappingURL=wave-stop.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"wave-stop.d.ts","sourceRoot":"","sources":["../../src/op/wave-stop.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,uDAAuD;AACvD,eAAO,MAAM,cAAc,WAAW,CAAC;AAEvC,8CAA8C;AAC9C,eAAO,MAAM,eAAe,KAAK,CAAC;AAElC,iCAAiC;AACjC,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED,iEAAiE;AACjE,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,sBAAsB;AACtB,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,CAAC,CAAC;IACX,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;CACjC;AAKD,uGAAuG;AACvG,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,aAAa,CAiBjE;AAED,4EAA4E;AAC5E,wBAAgB,eAAe,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAG3D;AAED,2CAA2C;AAC3C,wBAAgB,WAAW,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAE1E;AAED,sJAAsJ;AACtJ,wBAAsB,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAMpH;AAED;;;;;;;GAOG;AACH,wBAAsB,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,GAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAiBhI;AAED;;;;GAIG;AACH,wBAAsB,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI,EAAE,IAAI,GAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,OAAO,CAAC;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC,CAoB7J"}
@@ -0,0 +1,129 @@
1
+ /**
2
+ * A wave stop on a re-run (#4979): `/<product> apply wave-<n>` on a merged
3
+ * pull request runs its apply again and stops after wave n.
4
+ *
5
+ * A forge re-run cannot be told where to stop: GitHub's re-run of a run's
6
+ * failed jobs runs every job after them, Forgejo's dispatch runs the whole
7
+ * workflow, and GitLab runs the jobs after a retried one by itself. So the
8
+ * comment's job writes the stop on `chant/lifecycle` before it starts the
9
+ * run, `_waves/<op>.stops.json`, keyed by the commit the run applies, and
10
+ * each wave job of op `<op>` at that commit reads it before it plans: a wave
11
+ * after the stop waits, as a wave whose gate has no approval waits (exit 3),
12
+ * so a later `/<product> apply` runs it. An apply comment without a wave
13
+ * clears the commit's stop. The newest {@link WAVE_STOPS_KEPT} stops are
14
+ * kept.
15
+ */
16
+ import { fetchLifecycleStatus, getHeadCommit, pushLifecycleStatus, readBlobBySha, readPathSha, writeBlobToPath } from "../lifecycle/git.js";
17
+ /** The directory of the stops on `chant/lifecycle`. */
18
+ export const WAVE_STOPS_DIR = "_waves";
19
+ /** How many commits' stops the file keeps. */
20
+ export const WAVE_STOPS_KEPT = 50;
21
+ /** The stops file of op `op`. */
22
+ export function waveStopsFile(op) {
23
+ return `${op}.stops.json`;
24
+ }
25
+ const SHA = /^(?:[0-9a-f]{40}|[0-9a-f]{64})$/;
26
+ const OP = /^[A-Za-z0-9][A-Za-z0-9_.-]{0,127}$/;
27
+ /** Read a stops file; anything that is not one reads as no stops, and a malformed entry is dropped. */
28
+ export function parseWaveStops(text) {
29
+ let doc;
30
+ try {
31
+ doc = JSON.parse(text ?? "null");
32
+ }
33
+ catch {
34
+ return { version: 1, stops: {} };
35
+ }
36
+ const stops = {};
37
+ const given = doc && typeof doc === "object" && doc.version === 1 ? doc.stops : undefined;
38
+ if (given && typeof given === "object") {
39
+ for (const [sha, s] of Object.entries(given)) {
40
+ const v = s;
41
+ if (!SHA.test(sha) || !v || !Number.isInteger(v.through) || v.through < 1 || typeof v.at !== "string")
42
+ continue;
43
+ stops[sha] = { through: v.through, at: v.at, ...(typeof v.by === "string" ? { by: v.by } : {}), ...(Number.isInteger(v.pr) ? { pr: v.pr } : {}) };
44
+ }
45
+ }
46
+ return { version: 1, stops };
47
+ }
48
+ /** The file's text: the newest {@link WAVE_STOPS_KEPT} stops, by commit. */
49
+ export function renderWaveStops(file) {
50
+ const newest = Object.entries(file.stops).sort((a, b) => b[1].at.localeCompare(a[1].at)).slice(0, WAVE_STOPS_KEPT);
51
+ return `${JSON.stringify({ version: 1, stops: Object.fromEntries(newest.sort((a, b) => a[0].localeCompare(b[0]))) }, null, 2)}\n`;
52
+ }
53
+ /** Whether wave `k` waits under `stop`. */
54
+ export function waveStopped(stop, k) {
55
+ return stop !== undefined && k > stop.through;
56
+ }
57
+ /** The stop of op `op` at commit `sha`, from the local `chant/lifecycle` after a fetch. Undefined when there is none or the branch cannot be read. */
58
+ export async function waveStopAt(op, sha, opts = {}) {
59
+ if (!OP.test(op) || !SHA.test(sha))
60
+ return undefined;
61
+ await fetchLifecycleStatus(opts);
62
+ const blob = await readPathSha(WAVE_STOPS_DIR, waveStopsFile(op), opts);
63
+ if (!blob)
64
+ return undefined;
65
+ return parseWaveStops(await readBlobBySha(blob, opts)).stops[sha];
66
+ }
67
+ /**
68
+ * What a wave job of op `op` says when wave `k` waits behind a comment's
69
+ * stop at the job's checkout (`git rev-parse HEAD`). Undefined when it runs:
70
+ * no stop, no commit to read, or a branch that cannot be read, so a stop
71
+ * never fails a wave that would have run. `sha` (#4987) names the commit
72
+ * in place of the checkout's: a split wave's gate job runs at the default
73
+ * branch and reads the stop of the decided head.
74
+ */
75
+ export async function waveStopLine(op, k, opts = {}) {
76
+ let sha;
77
+ try {
78
+ sha = opts.sha ?? (await getHeadCommit(opts));
79
+ }
80
+ catch {
81
+ return undefined;
82
+ }
83
+ let stop;
84
+ try {
85
+ stop = await waveStopAt(op, sha, opts);
86
+ }
87
+ catch {
88
+ return undefined;
89
+ }
90
+ if (!waveStopped(stop, k))
91
+ return undefined;
92
+ const who = stop.by ? `${stop.by}'s` : "a";
93
+ const where = stop.pr !== undefined ? ` on pull request ${stop.pr}` : "";
94
+ return `wave ${k} waits: ${who} comment${where} ran ${op} again at ${sha.slice(0, 12)} through wave ${stop.through}; comment the apply again without a wave to run the waves after it`;
95
+ }
96
+ /**
97
+ * Set op `op`'s stop at commit `sha`, or clear it (`stop` null), and push
98
+ * `chant/lifecycle`. Read, written and pushed again when another writer
99
+ * pushed first, up to three times.
100
+ */
101
+ export async function setWaveStop(op, sha, stop, opts = {}) {
102
+ if (!OP.test(op))
103
+ throw new Error(`the op name ${JSON.stringify(op)} is not a stops file name`);
104
+ if (!SHA.test(sha))
105
+ throw new Error(`${JSON.stringify(sha)} is not a commit sha`);
106
+ for (let attempt = 1; attempt <= 3; attempt++) {
107
+ const fetched = await fetchLifecycleStatus(opts);
108
+ if (fetched.status === "unreachable")
109
+ throw new Error("chant/lifecycle could not be fetched, so the stop was not written");
110
+ const blob = await readPathSha(WAVE_STOPS_DIR, waveStopsFile(op), opts);
111
+ const file = parseWaveStops(blob ? await readBlobBySha(blob, opts) : null);
112
+ const next = { version: 1, stops: { ...file.stops } };
113
+ if (stop)
114
+ next.stops[sha] = stop;
115
+ else
116
+ delete next.stops[sha];
117
+ if (renderWaveStops(next) === renderWaveStops(file))
118
+ return { changed: false, pushed: false };
119
+ const what = stop ? `Stop ${op} after wave ${stop.through} at ${sha.slice(0, 12)}` : `Clear the stop of ${op} at ${sha.slice(0, 12)}`;
120
+ await writeBlobToPath(WAVE_STOPS_DIR, waveStopsFile(op), renderWaveStops(next), what, { ...opts, expectPriorPathSha: blob });
121
+ const pushed = await pushLifecycleStatus(opts);
122
+ if (pushed.status === "stale")
123
+ continue;
124
+ if (pushed.status === "failed")
125
+ throw new Error(`could not push the stop to chant/lifecycle (${pushed.stderr.trim()})`);
126
+ return { changed: true, pushed: pushed.status === "pushed" };
127
+ }
128
+ throw new Error("chant/lifecycle kept moving, so the stop was not written; comment again");
129
+ }
@@ -0,0 +1,76 @@
1
+ /**
2
+ * `@intentius/chant/planned-files` (#4966): the files a product's init or
3
+ * render plans, written in one call, and the generated files it no longer
4
+ * renders.
5
+ *
6
+ * Each product carried its own: terragucci's `init.ts` plans a
7
+ * `FileChange` per file and writes or unlinks them in a loop, with a
8
+ * `chmodSync` beside its image recipe's writes; plywood's `init.ts` `put`
9
+ * writes a file when it differs; sql-yodeler's `yodel ci` finds the
10
+ * pipeline files that open with its header and removes the ones it no
11
+ * longer renders (its #348).
12
+ *
13
+ * - {@link planFile} plans one file against what is on disk, its mode
14
+ * included, and writes nothing, so a dry run prints the plan as it is.
15
+ * - {@link planRemoval} plans the removal of a file an earlier run wrote.
16
+ * - {@link writePlannedFiles} writes the plan: each directory made, each
17
+ * file's mode set, each removed file unlinked, an unchanged one left as
18
+ * it is.
19
+ * - {@link staleGeneratedFiles} lists the files under some directories that
20
+ * open with a product's header and that the product no longer renders.
21
+ *
22
+ * `@intentius/chant/ref-gate-init` writes its plan with
23
+ * {@link writePlannedFiles}.
24
+ *
25
+ * This module imports only Node's own modules.
26
+ */
27
+ /** One planned file. */
28
+ export interface PlannedFile {
29
+ /** Where it is written. Absolute, or relative to the process's directory. */
30
+ path: string;
31
+ /** `removed`: a file an earlier run wrote that this one no longer asks for. */
32
+ status: "created" | "updated" | "unchanged" | "removed";
33
+ /** The text to write; empty for a removal. */
34
+ content: string;
35
+ /** The permission bits to set, such as `0o755` for a script. Unset, a new file gets the process's default and an existing one keeps its own. */
36
+ mode?: number;
37
+ /** In the git directory or otherwise never committed, such as a hook. */
38
+ local?: boolean;
39
+ }
40
+ /**
41
+ * Plan `content` at `path`: `created` when there is no file, `unchanged`
42
+ * when the file holds the content (and, with `mode`, has that mode),
43
+ * `updated` otherwise. Writes nothing.
44
+ */
45
+ export declare function planFile(path: string, content: string, extra?: Pick<PlannedFile, "mode" | "local">): PlannedFile;
46
+ /** Plan the removal of the file at `path`; undefined when there is nothing there to remove. */
47
+ export declare function planRemoval(path: string): PlannedFile | undefined;
48
+ /**
49
+ * Write a plan: each created or updated file written, its directory made
50
+ * and its mode set; each removed file unlinked; an unchanged file not
51
+ * touched. A removed file that is already gone is not an error.
52
+ */
53
+ export declare function writePlannedFiles(files: readonly Pick<PlannedFile, "path" | "status" | "content" | "mode">[]): void;
54
+ export interface StaleGeneratedOptions {
55
+ /** The directory the paths are relative to: a product's checkout. */
56
+ root: string;
57
+ /** Directories, relative to `root`, whose files (not their subdirectories) may be generated. */
58
+ dirs?: readonly string[];
59
+ /** Single files, relative to `root`, that may be generated, such as `.gitlab-ci.yml`. */
60
+ files?: readonly string[];
61
+ /** The names in `dirs` to look at. Default every file. */
62
+ match?: RegExp;
63
+ /** The product's header: its first line, which a generated file opens with, or a test of the file's text. */
64
+ header: string | ((text: string) => boolean);
65
+ /** The paths, relative to `root` and written with `/`, the product renders now. */
66
+ rendered: Iterable<string>;
67
+ }
68
+ /**
69
+ * The files under `dirs` and among `files` that open with the product's
70
+ * header and that it does not render now, relative to `root`, in the order
71
+ * found (each directory's names sorted). A file without the header is the
72
+ * person's own and never listed.
73
+ */
74
+ export declare function staleGeneratedFiles(options: StaleGeneratedOptions): string[];
75
+ export { PLANNED_FILES_FLOOR } from "./release-floors.js";
76
+ //# sourceMappingURL=planned-files.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"planned-files.d.ts","sourceRoot":"","sources":["../src/planned-files.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAKH,wBAAwB;AACxB,MAAM,WAAW,WAAW;IAC1B,6EAA6E;IAC7E,IAAI,EAAE,MAAM,CAAC;IACb,+EAA+E;IAC/E,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,CAAC;IACxD,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,gJAAgJ;IAChJ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yEAAyE;IACzE,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAWD;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAM,GAAG,WAAW,CAKpH;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAEjE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,SAAS,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC,EAAE,GAAG,IAAI,CAWnH;AAED,MAAM,WAAW,qBAAqB;IACpC,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;IACb,gGAAgG;IAChG,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,yFAAyF;IACzF,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6GAA6G;IAC7G,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC;IAC7C,mFAAmF;IACnF,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,qBAAqB,GAAG,MAAM,EAAE,CAsB5E;AAED,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC"}
@@ -0,0 +1,108 @@
1
+ /**
2
+ * `@intentius/chant/planned-files` (#4966): the files a product's init or
3
+ * render plans, written in one call, and the generated files it no longer
4
+ * renders.
5
+ *
6
+ * Each product carried its own: terragucci's `init.ts` plans a
7
+ * `FileChange` per file and writes or unlinks them in a loop, with a
8
+ * `chmodSync` beside its image recipe's writes; plywood's `init.ts` `put`
9
+ * writes a file when it differs; sql-yodeler's `yodel ci` finds the
10
+ * pipeline files that open with its header and removes the ones it no
11
+ * longer renders (its #348).
12
+ *
13
+ * - {@link planFile} plans one file against what is on disk, its mode
14
+ * included, and writes nothing, so a dry run prints the plan as it is.
15
+ * - {@link planRemoval} plans the removal of a file an earlier run wrote.
16
+ * - {@link writePlannedFiles} writes the plan: each directory made, each
17
+ * file's mode set, each removed file unlinked, an unchanged one left as
18
+ * it is.
19
+ * - {@link staleGeneratedFiles} lists the files under some directories that
20
+ * open with a product's header and that the product no longer renders.
21
+ *
22
+ * `@intentius/chant/ref-gate-init` writes its plan with
23
+ * {@link writePlannedFiles}.
24
+ *
25
+ * This module imports only Node's own modules.
26
+ */
27
+ import { chmodSync, existsSync, mkdirSync, readdirSync, readFileSync, statSync, unlinkSync, writeFileSync } from "node:fs";
28
+ import { dirname, join } from "node:path";
29
+ /** The permission bits of the file at `path`, or undefined when there is none. */
30
+ function modeOf(path) {
31
+ try {
32
+ return statSync(path).mode & 0o777;
33
+ }
34
+ catch {
35
+ return undefined;
36
+ }
37
+ }
38
+ /**
39
+ * Plan `content` at `path`: `created` when there is no file, `unchanged`
40
+ * when the file holds the content (and, with `mode`, has that mode),
41
+ * `updated` otherwise. Writes nothing.
42
+ */
43
+ export function planFile(path, content, extra = {}) {
44
+ const own = { ...(extra.mode !== undefined ? { mode: extra.mode } : {}), ...(extra.local ? { local: true } : {}) };
45
+ if (!existsSync(path))
46
+ return { path, status: "created", content, ...own };
47
+ const same = readFileSync(path, "utf-8") === content && (extra.mode === undefined || modeOf(path) === extra.mode);
48
+ return { path, status: same ? "unchanged" : "updated", content, ...own };
49
+ }
50
+ /** Plan the removal of the file at `path`; undefined when there is nothing there to remove. */
51
+ export function planRemoval(path) {
52
+ return existsSync(path) ? { path, status: "removed", content: "" } : undefined;
53
+ }
54
+ /**
55
+ * Write a plan: each created or updated file written, its directory made
56
+ * and its mode set; each removed file unlinked; an unchanged file not
57
+ * touched. A removed file that is already gone is not an error.
58
+ */
59
+ export function writePlannedFiles(files) {
60
+ for (const f of files) {
61
+ if (f.status === "unchanged")
62
+ continue;
63
+ if (f.status === "removed") {
64
+ if (existsSync(f.path))
65
+ unlinkSync(f.path);
66
+ continue;
67
+ }
68
+ mkdirSync(dirname(f.path), { recursive: true });
69
+ writeFileSync(f.path, f.content);
70
+ if (f.mode !== undefined)
71
+ chmodSync(f.path, f.mode);
72
+ }
73
+ }
74
+ /**
75
+ * The files under `dirs` and among `files` that open with the product's
76
+ * header and that it does not render now, relative to `root`, in the order
77
+ * found (each directory's names sorted). A file without the header is the
78
+ * person's own and never listed.
79
+ */
80
+ export function staleGeneratedFiles(options) {
81
+ const { root } = options;
82
+ const header = options.header;
83
+ const isGenerated = typeof header === "string" ? (text) => text.split(/\r?\n/, 1)[0] === header : header;
84
+ const candidates = [...(options.files ?? [])];
85
+ for (const d of options.dirs ?? []) {
86
+ const abs = join(root, d);
87
+ if (!existsSync(abs))
88
+ continue;
89
+ const prefix = d.replace(/\/+$/, "");
90
+ for (const e of readdirSync(abs, { withFileTypes: true }).sort((a, b) => (a.name < b.name ? -1 : a.name > b.name ? 1 : 0))) {
91
+ if (e.isFile() && (!options.match || options.match.test(e.name)))
92
+ candidates.push(prefix === "" || prefix === "." ? e.name : `${prefix}/${e.name}`);
93
+ }
94
+ }
95
+ const rendered = new Set(options.rendered);
96
+ const out = [];
97
+ for (const p of candidates) {
98
+ if (rendered.has(p) || out.includes(p))
99
+ continue;
100
+ const abs = join(root, p);
101
+ if (!existsSync(abs) || !statSync(abs).isFile())
102
+ continue;
103
+ if (isGenerated(readFileSync(abs, "utf-8")))
104
+ out.push(p);
105
+ }
106
+ return out;
107
+ }
108
+ export { PLANNED_FILES_FLOOR } from "./release-floors.js";
@@ -0,0 +1,22 @@
1
+ /**
2
+ * The forge client a chant command in a CI job posts with (#4964): the
3
+ * pull request loop's {@link forgeFromEnv}, with each commit status for the
4
+ * run's own commit put on the pull request's head.
5
+ *
6
+ * A GitHub `pull_request` run checks out `GITHUB_SHA`, the merge preview
7
+ * (`refs/pull/<n>/merge`), and the loop's jobs plan, check and sign that
8
+ * commit, as a merge would make it. The forge shows no status of that commit
9
+ * on the pull request, and a required status is read from the head, so a
10
+ * status the plan note, the check evidence or the ref gate sets for it goes
11
+ * on `pull_request.head.sha` instead. Forgejo's run is of the head already,
12
+ * and so is a status for any other commit; both are posted as asked. GitLab
13
+ * is left as it is: its merge request pipeline runs on the head.
14
+ *
15
+ * Kept out of ./pr-forge.ts, whose bundle a product posts with.
16
+ */
17
+ import { forgeFromEnv, type ForgeKind, type PrForge } from "./pr-forge.js";
18
+ /** The pull request's head from a GitHub-style `pull_request` run's event payload, or undefined for any other run. */
19
+ export declare function pullRequestEventHead(env: Record<string, string | undefined>): string | undefined;
20
+ /** {@link forgeFromEnv}, whose statuses for the run's merge preview go on the pull request's head (#4964). */
21
+ export declare function forgeFromJobEnv(kind: ForgeKind, env?: Record<string, string | undefined>, fetchImpl?: Parameters<typeof forgeFromEnv>[2]): PrForge;
22
+ //# sourceMappingURL=pr-forge-job.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pr-forge-job.d.ts","sourceRoot":"","sources":["../src/pr-forge-job.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,OAAO,EAAE,YAAY,EAAE,KAAK,SAAS,EAAE,KAAK,OAAO,EAAE,MAAM,YAAY,CAAC;AAExE,sHAAsH;AACtH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,MAAM,GAAG,SAAS,CAShG;AAED,8GAA8G;AAC9G,wBAAgB,eAAe,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAe,EAAE,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAY/J"}
@@ -0,0 +1,46 @@
1
+ /**
2
+ * The forge client a chant command in a CI job posts with (#4964): the
3
+ * pull request loop's {@link forgeFromEnv}, with each commit status for the
4
+ * run's own commit put on the pull request's head.
5
+ *
6
+ * A GitHub `pull_request` run checks out `GITHUB_SHA`, the merge preview
7
+ * (`refs/pull/<n>/merge`), and the loop's jobs plan, check and sign that
8
+ * commit, as a merge would make it. The forge shows no status of that commit
9
+ * on the pull request, and a required status is read from the head, so a
10
+ * status the plan note, the check evidence or the ref gate sets for it goes
11
+ * on `pull_request.head.sha` instead. Forgejo's run is of the head already,
12
+ * and so is a status for any other commit; both are posted as asked. GitLab
13
+ * is left as it is: its merge request pipeline runs on the head.
14
+ *
15
+ * Kept out of ./pr-forge.ts, whose bundle a product posts with.
16
+ */
17
+ import { readFileSync } from "node:fs";
18
+ import { forgeFromEnv } from "./pr-forge.js";
19
+ /** The pull request's head from a GitHub-style `pull_request` run's event payload, or undefined for any other run. */
20
+ export function pullRequestEventHead(env) {
21
+ if (!env.GITHUB_EVENT_NAME?.startsWith("pull_request") || !env.GITHUB_EVENT_PATH)
22
+ return undefined;
23
+ try {
24
+ const event = JSON.parse(readFileSync(env.GITHUB_EVENT_PATH, "utf8"));
25
+ const sha = event.pull_request?.head?.sha;
26
+ return typeof sha === "string" && /^[0-9a-f]{40,64}$/.test(sha) ? sha : undefined;
27
+ }
28
+ catch {
29
+ return undefined;
30
+ }
31
+ }
32
+ /** {@link forgeFromEnv}, whose statuses for the run's merge preview go on the pull request's head (#4964). */
33
+ export function forgeFromJobEnv(kind, env = process.env, fetchImpl) {
34
+ const forge = forgeFromEnv(kind, env, fetchImpl);
35
+ const merge = env.GITHUB_SHA;
36
+ const head = kind === "gitlab" ? undefined : pullRequestEventHead(env);
37
+ if (!head || !merge || head === merge)
38
+ return forge;
39
+ const at = (sha) => (sha === merge ? head : sha);
40
+ const { setStatus, setCommitStatus } = forge;
41
+ return {
42
+ ...forge,
43
+ setStatus: (sha, status) => setStatus(at(sha), status),
44
+ ...(setCommitStatus ? { setCommitStatus: (sha, status) => setCommitStatus(at(sha), status) } : {}),
45
+ };
46
+ }
package/dist/pr-loop.d.ts CHANGED
@@ -6,8 +6,9 @@
6
6
  * `chant components pr-plan` and `chant components pr-apply` run it, and the
7
7
  * generated CI for GitHub, GitLab and Forgejo calls them
8
8
  * (`components/pr-pipeline.ts`). This module holds the parts that need no
9
- * runner: the gate's names, the report both commands write, the pull-request
10
- * note rendered from it and the status line. terragucci reads the report and
9
+ * runner: the gate's names, the report both commands write and the
10
+ * pull-request note rendered from it; the status line is in `./pr-status.ts`
11
+ * (#4966), outside the bundle. terragucci reads the report and
11
12
  * renders the note from one bundled file with no TypeScript toolchain
12
13
  * (#3421), so this imports `./change-set` and `./plan-summary` and nothing
13
14
  * else; `pr-loop-bundle.test.ts` holds that.
@@ -714,8 +715,4 @@ export declare function renderPrNote(report: PrReport, options?: {
714
715
  applyWord?: string;
715
716
  words?: CiProductWords;
716
717
  }): string;
717
- /** A commit status's description, at most 140 characters (GitHub's limit). */
718
- export declare function prStatusDescription(report: PrReport, words?: CiProductWords): string;
719
- /** The commit status state for a report: success, failure, or pending while it waits on approval. */
720
- export declare function prStatusState(report: PrReport): "success" | "failure" | "pending";
721
718
  //# sourceMappingURL=pr-loop.d.ts.map