@wtf/release-docs 9.0.2 → 10.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 (882) hide show
  1. package/README.md +6 -4
  2. package/api/.generated +291 -141
  3. package/api/@wtf/release/README.md +55 -0
  4. package/api/@wtf/release/contract/README.md +60 -0
  5. package/api/@wtf/release/contract/interfaces/Plan.md +46 -0
  6. package/api/@wtf/release/contract/interfaces/Release.md +96 -0
  7. package/api/@wtf/release/contract/interfaces/ReleaseSteps.md +203 -0
  8. package/api/@wtf/release/contract/type-aliases/OptionalStep.md +13 -0
  9. package/api/@wtf/release/contract/type-aliases/ReleasingEcosystem.md +44 -0
  10. package/api/@wtf/release/driver/README.md +43 -0
  11. package/api/@wtf/release/driver/functions/runStep.md +50 -0
  12. package/api/@wtf/release/driver/interfaces/StepOutcome.md +31 -0
  13. package/api/@wtf/release/driver/type-aliases/EcosystemsOf.md +14 -0
  14. package/api/@wtf/release/driver/type-aliases/Step.md +13 -0
  15. package/api/@wtf/release/driver/variables/STEPS.md +13 -0
  16. package/api/@wtf/{release-trains → release}/ecosystem/README.md +11 -11
  17. package/api/@wtf/release/ecosystem/functions/isEcosystem.md +27 -0
  18. package/api/@wtf/{release-trains → release}/ecosystem/functions/loadEcosystems.md +5 -5
  19. package/api/@wtf/release/ecosystem/functions/readPackages.md +33 -0
  20. package/api/@wtf/release/ecosystem/interfaces/Dependency.md +43 -0
  21. package/api/@wtf/{release-trains → release}/ecosystem/interfaces/Ecosystem.md +23 -14
  22. package/api/@wtf/release/ecosystem/interfaces/EcosystemContext.md +56 -0
  23. package/api/@wtf/release/ecosystem/interfaces/EcosystemPackages.md +35 -0
  24. package/api/@wtf/release/ecosystem/interfaces/Package.md +71 -0
  25. package/api/@wtf/release/ecosystem/type-aliases/DependencyKind.md +16 -0
  26. package/api/@wtf/{release-trains → release}/ecosystem/type-aliases/ModuleLoader.md +2 -2
  27. package/api/@wtf/release/ecosystem/variables/DEPENDENCY_KINDS.md +13 -0
  28. package/api/@wtf/release/errors/README.md +41 -0
  29. package/api/@wtf/{release-system → release}/errors/classes/ReleaseError.md +11 -19
  30. package/api/@wtf/release/errors/functions/isReleaseError.md +28 -0
  31. package/api/@wtf/release/errors/functions/throwAll.md +26 -0
  32. package/api/@wtf/{release-system → release}/errors/type-aliases/ErrorClass.md +2 -2
  33. package/api/@wtf/release/errors/type-aliases/ReleaseErrorCode.md +13 -0
  34. package/api/@wtf/release/errors/variables/RELEASE_ERRORS.md +35 -0
  35. package/api/@wtf/release/files/README.md +38 -0
  36. package/api/@wtf/release/files/functions/copy.md +45 -0
  37. package/api/@wtf/release/files/functions/exists.md +33 -0
  38. package/api/@wtf/release/files/functions/makeDir.md +33 -0
  39. package/api/@wtf/release/files/functions/readBytes.md +33 -0
  40. package/api/@wtf/release/files/functions/readDir.md +33 -0
  41. package/api/@wtf/release/files/functions/readFile.md +33 -0
  42. package/api/@wtf/release/files/functions/remove.md +34 -0
  43. package/api/@wtf/release/files/functions/writeFile.md +38 -0
  44. package/api/@wtf/release/files/interfaces/DirEntry.md +27 -0
  45. package/api/@wtf/release/forge/README.md +49 -0
  46. package/api/@wtf/release/forge/functions/linksOf.md +49 -0
  47. package/api/@wtf/release/forge/interfaces/Forge.md +113 -0
  48. package/api/@wtf/release/forge/interfaces/ForgeRun.md +41 -0
  49. package/api/@wtf/release/forge/interfaces/LinksOptions.md +43 -0
  50. package/api/@wtf/release/forge/interfaces/PackageRegistry.md +41 -0
  51. package/api/@wtf/release/forge/interfaces/ReleaseLink.md +41 -0
  52. package/api/@wtf/release/forge/interfaces/Released.md +91 -0
  53. package/api/@wtf/{release-trains → release}/generated/README.md +8 -8
  54. package/api/@wtf/{release-trains → release}/generated/functions/filesIn.md +4 -4
  55. package/api/@wtf/{release-trains → release}/generated/functions/formatGenerated.md +2 -2
  56. package/api/@wtf/release/generated/functions/listGenerated.md +35 -0
  57. package/api/@wtf/{release-trains → release}/generated/functions/parseGenerated.md +2 -2
  58. package/api/@wtf/release/generated/functions/readGenerated.md +33 -0
  59. package/api/@wtf/{release-trains → release}/generated/functions/stageGenerated.md +2 -2
  60. package/api/@wtf/release/generated/functions/stageGeneratedFolders.md +29 -0
  61. package/api/@wtf/release/generated/functions/unlistedIn.md +36 -0
  62. package/api/@wtf/release/generated/interfaces/GeneratedOptions.md +21 -0
  63. package/api/@wtf/release/generated/interfaces/StageOptions.md +76 -0
  64. package/api/@wtf/release/generated/variables/GENERATED.md +13 -0
  65. package/api/@wtf/{release-system → release}/git/README.md +11 -10
  66. package/api/@wtf/{release-system → release}/git/functions/commitsSince.md +3 -3
  67. package/api/@wtf/{release-system → release}/git/functions/filesOfCommits.md +3 -3
  68. package/api/@wtf/{release-system → release}/git/functions/git.md +3 -3
  69. package/api/@wtf/release/git/functions/revisionOf.md +33 -0
  70. package/api/@wtf/release/git/functions/tagsOfRepo.md +33 -0
  71. package/api/@wtf/{release-system → release}/git/functions/trackedFiles.md +3 -3
  72. package/api/@wtf/release/git/interfaces/GitContext.md +26 -0
  73. package/api/@wtf/release/git/interfaces/LogCommit.md +43 -0
  74. package/api/@wtf/release/interfaces/RepoContext.md +57 -0
  75. package/api/@wtf/release/order/README.md +37 -0
  76. package/api/@wtf/{release-trains/packages → release/order}/functions/normalizeDir.md +2 -2
  77. package/api/@wtf/{release-trains/packages → release/order}/functions/publishOrder.md +7 -6
  78. package/api/@wtf/release/order/interfaces/OrderFault.md +39 -0
  79. package/api/@wtf/release/order/interfaces/OrderPins.md +27 -0
  80. package/api/@wtf/release/order/interfaces/PublishOrder.md +35 -0
  81. package/api/@wtf/{release-system → release}/paths/README.md +4 -4
  82. package/api/@wtf/{release-system → release}/paths/functions/normalizePath.md +2 -2
  83. package/api/@wtf/{release-system → release}/paths/functions/pathMatcher.md +2 -2
  84. package/api/@wtf/{release-system → release}/paths/type-aliases/PathMatcher.md +2 -2
  85. package/api/@wtf/{release-system → release}/posix/README.md +5 -5
  86. package/api/@wtf/{release-system → release}/posix/functions/basenameOf.md +2 -2
  87. package/api/@wtf/{release-system → release}/posix/functions/dirnameOf.md +2 -2
  88. package/api/@wtf/{release-system → release}/posix/functions/joinPath.md +2 -2
  89. package/api/@wtf/{release-system → release}/posix/functions/relativePath.md +2 -2
  90. package/api/@wtf/{release-system → release}/posix/functions/resolvePath.md +3 -3
  91. package/api/@wtf/release/process/README.md +30 -0
  92. package/api/@wtf/release/process/functions/envOf.md +34 -0
  93. package/api/@wtf/release/process/functions/run.md +48 -0
  94. package/api/@wtf/release/process/interfaces/RunOptions.md +52 -0
  95. package/api/@wtf/release/process/interfaces/RunResult.md +35 -0
  96. package/api/@wtf/release/type-aliases/ReleasePlatform.md +22 -0
  97. package/api/@wtf/release/type-aliases/RepoPlatform.md +21 -0
  98. package/api/@wtf/{release-system → release}/validator/README.md +6 -5
  99. package/api/@wtf/{release-system → release}/validator/functions/allOf.md +2 -2
  100. package/api/@wtf/{release-system → release}/validator/functions/anyObject.md +3 -3
  101. package/api/@wtf/{release-system → release}/validator/functions/anyOf.md +2 -2
  102. package/api/@wtf/{release-system → release}/validator/functions/arrayOf.md +2 -2
  103. package/api/@wtf/{release-system → release}/validator/functions/booleanOf.md +2 -2
  104. package/api/@wtf/{release-system → release}/validator/functions/errorOf.md +2 -2
  105. package/api/@wtf/{release-system → release}/validator/functions/errorsOf.md +2 -2
  106. package/api/@wtf/{release-system → release}/validator/functions/exclusive.md +2 -2
  107. package/api/@wtf/release/validator/functions/issueOf.md +45 -0
  108. package/api/@wtf/{release-system → release}/validator/functions/issuesOf.md +2 -2
  109. package/api/@wtf/{release-system → release}/validator/functions/objectOf.md +2 -2
  110. package/api/@wtf/{release-system → release}/validator/functions/oneOf.md +2 -2
  111. package/api/@wtf/{release-system → release}/validator/functions/orFunction.md +2 -2
  112. package/api/@wtf/{release-system → release}/validator/functions/pathText.md +2 -2
  113. package/api/@wtf/{release-system → release}/validator/functions/recordOf.md +2 -2
  114. package/api/@wtf/{release-system → release}/validator/functions/refined.md +2 -2
  115. package/api/@wtf/{release-system → release}/validator/functions/stringOf.md +2 -2
  116. package/api/@wtf/{release-system → release}/validator/functions/tupleOf.md +2 -2
  117. package/api/@wtf/release/validator/functions/validatorOf.md +42 -0
  118. package/api/@wtf/{release-system → release}/validator/interfaces/ArrayOptions.md +6 -6
  119. package/api/@wtf/{release-system → release}/validator/interfaces/IssueOptions.md +5 -5
  120. package/api/@wtf/{release-system → release}/validator/interfaces/ObjectOptions.md +6 -6
  121. package/api/@wtf/release/validator/interfaces/OptionIssue.md +63 -0
  122. package/api/@wtf/release/validator/interfaces/Property.md +49 -0
  123. package/api/@wtf/{release-system → release}/validator/interfaces/RecordOptions.md +7 -7
  124. package/api/@wtf/{release-system → release}/validator/interfaces/StringOptions.md +7 -7
  125. package/api/@wtf/{release-system → release}/validator/interfaces/Validator.md +5 -5
  126. package/api/@wtf/release/validator/type-aliases/JsonSchema.md +17 -0
  127. package/api/@wtf/release/validator/type-aliases/Path.md +13 -0
  128. package/api/@wtf/release-cargo/README.md +11 -8
  129. package/api/@wtf/release-cargo/auth/README.md +1 -1
  130. package/api/@wtf/release-cargo/auth/functions/mask.md +1 -1
  131. package/api/@wtf/release-cargo/auth/functions/tokenVariableOf.md +1 -1
  132. package/api/@wtf/release-cargo/auth/functions/trustedPublishing.md +1 -1
  133. package/api/@wtf/release-cargo/auth/interfaces/HttpResponse.md +5 -5
  134. package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishing.md +5 -5
  135. package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishingOptions.md +6 -6
  136. package/api/@wtf/release-cargo/auth/type-aliases/HttpFetch.md +1 -1
  137. package/api/@wtf/release-cargo/auth/variables/CRATES_IO_API.md +1 -1
  138. package/api/@wtf/release-cargo/auth/variables/ID_TOKEN_VARIABLE.md +1 -1
  139. package/api/@wtf/release-cargo/auth/variables/USER_AGENT.md +3 -3
  140. package/api/@wtf/release-cargo/crates/README.md +11 -10
  141. package/api/@wtf/release-cargo/crates/functions/publishOrder.md +1 -1
  142. package/api/@wtf/release-cargo/crates/functions/publishable.md +1 -1
  143. package/api/@wtf/release-cargo/crates/functions/readWorkspace.md +9 -8
  144. package/api/@wtf/release-cargo/crates/functions/selectCrates.md +16 -16
  145. package/api/@wtf/release-cargo/crates/functions/selects.md +36 -0
  146. package/api/@wtf/release-cargo/crates/interfaces/Selection.md +15 -15
  147. package/api/@wtf/release-cargo/ecosystem/README.md +9 -6
  148. package/api/@wtf/release-cargo/ecosystem/functions/packagesAt.md +6 -6
  149. package/api/@wtf/release-cargo/ecosystem/functions/packagesOfTree.md +3 -3
  150. package/api/@wtf/release-cargo/ecosystem/functions/packagesOfWorkspace.md +2 -2
  151. package/api/@wtf/release-cargo/ecosystem/functions/resolveRequirement.md +1 -1
  152. package/api/@wtf/release-cargo/ecosystem/functions/satisfiesRequirement.md +1 -1
  153. package/api/@wtf/release-cargo/ecosystem/functions/semverRange.md +1 -1
  154. package/api/@wtf/release-cargo/ecosystem/interfaces/CargoPackage.md +17 -17
  155. package/api/@wtf/release-cargo/ecosystem/variables/cargoEcosystem.md +6 -4
  156. package/api/@wtf/release-cargo/errors/README.md +4 -5
  157. package/api/@wtf/release-cargo/errors/classes/CargoError.md +18 -33
  158. package/api/@wtf/release-cargo/errors/type-aliases/CargoErrorCode.md +1 -1
  159. package/api/@wtf/release-cargo/errors/variables/CARGO_ERRORS.md +8 -4
  160. package/api/@wtf/release-cargo/interfaces/Crate.md +6 -6
  161. package/api/@wtf/release-cargo/interfaces/CrateDependency.md +6 -6
  162. package/api/@wtf/release-cargo/interfaces/Workspace.md +3 -3
  163. package/api/@wtf/release-cargo/publish/README.md +4 -5
  164. package/api/@wtf/release-cargo/publish/functions/publishCrates.md +5 -4
  165. package/api/@wtf/release-cargo/publish/interfaces/PublishCratesOptions.md +33 -20
  166. package/api/@wtf/release-cargo/publish/interfaces/PublishedCrate.md +5 -5
  167. package/api/@wtf/release-cargo/publish/type-aliases/CrateStatus.md +1 -1
  168. package/api/@wtf/release-cargo/publish/variables/RECHECK_WAITS.md +1 -1
  169. package/api/@wtf/release-cargo/registry/README.md +5 -3
  170. package/api/@wtf/release-cargo/registry/functions/crateUrl.md +1 -1
  171. package/api/@wtf/release-cargo/registry/functions/indexHasVersion.md +1 -1
  172. package/api/@wtf/release-cargo/registry/functions/indexLookup.md +50 -0
  173. package/api/@wtf/release-cargo/registry/functions/indexPath.md +1 -1
  174. package/api/@wtf/release-cargo/registry/variables/CRATES_IO_INDEX.md +1 -1
  175. package/api/@wtf/release-cargo/release/README.md +54 -0
  176. package/api/@wtf/release-cargo/release/functions/prepareCrates.md +42 -0
  177. package/api/@wtf/release-cargo/release/functions/publishPlan.md +53 -0
  178. package/api/@wtf/release-cargo/release/functions/publishedOf.md +36 -0
  179. package/api/@wtf/release-cargo/release/functions/verifyCrates.md +44 -0
  180. package/api/@wtf/release-cargo/release/interfaces/CargoOptions.md +89 -0
  181. package/api/@wtf/release-cargo/release/type-aliases/CargoPlan.md +13 -0
  182. package/api/@wtf/release-cargo/stamp/README.md +6 -5
  183. package/api/@wtf/release-cargo/stamp/functions/checkVersions.md +1 -1
  184. package/api/@wtf/release-cargo/stamp/functions/inheritsVersion.md +1 -1
  185. package/api/@wtf/release-cargo/stamp/functions/stampManifest.md +1 -1
  186. package/api/@wtf/release-cargo/stamp/functions/stampWorkspace.md +19 -10
  187. package/api/@wtf/release-cargo/stamp/interfaces/StampOptions.md +4 -4
  188. package/api/@wtf/release-cargo/stamp/interfaces/StampWorkspaceOptions.md +21 -0
  189. package/api/@wtf/release-cargo/stamp/interfaces/Stamped.md +3 -3
  190. package/api/@wtf/release-cargo/stamp/interfaces/StampedWorkspace.md +4 -4
  191. package/api/@wtf/release-cargo/type-aliases/DependencyKind.md +1 -1
  192. package/api/@wtf/release-go/README.md +13 -9
  193. package/api/@wtf/release-go/ecosystem/README.md +13 -6
  194. package/api/@wtf/release-go/ecosystem/functions/packagesOfModules.md +2 -2
  195. package/api/@wtf/release-go/ecosystem/functions/packagesOfRepo.md +4 -4
  196. package/api/@wtf/release-go/ecosystem/functions/resolveVersion.md +2 -2
  197. package/api/@wtf/release-go/ecosystem/functions/satisfiesVersion.md +1 -1
  198. package/api/@wtf/release-go/ecosystem/interfaces/GoPackage.md +17 -17
  199. package/api/@wtf/release-go/ecosystem/variables/goEcosystem.md +6 -3
  200. package/api/@wtf/release-go/errors/README.md +4 -5
  201. package/api/@wtf/release-go/errors/classes/GoError.md +17 -32
  202. package/api/@wtf/release-go/errors/type-aliases/GoErrorCode.md +1 -1
  203. package/api/@wtf/release-go/errors/variables/GO_ERRORS.md +8 -4
  204. package/api/@wtf/release-go/gomod/functions/entriesOf.md +1 -1
  205. package/api/@wtf/release-go/gomod/functions/linesOf.md +1 -1
  206. package/api/@wtf/release-go/gomod/functions/readGoMod.md +1 -1
  207. package/api/@wtf/release-go/gomod/functions/tokensOf.md +1 -1
  208. package/api/@wtf/release-go/gomod/interfaces/Entry.md +4 -4
  209. package/api/@wtf/release-go/gomod/interfaces/GoMod.md +4 -4
  210. package/api/@wtf/release-go/gomod/interfaces/GoReplace.md +6 -6
  211. package/api/@wtf/release-go/gomod/interfaces/GoRequire.md +4 -4
  212. package/api/@wtf/release-go/gomod/interfaces/Token.md +5 -5
  213. package/api/@wtf/release-go/interfaces/GoIdentity.md +31 -0
  214. package/api/@wtf/release-go/interfaces/GoModule.md +6 -6
  215. package/api/@wtf/release-go/interfaces/GoOptions.md +86 -0
  216. package/api/@wtf/release-go/modules/README.md +9 -9
  217. package/api/@wtf/release-go/modules/functions/isFetchable.md +1 -1
  218. package/api/@wtf/release-go/modules/functions/isGoMod.md +1 -1
  219. package/api/@wtf/release-go/modules/functions/majorErrors.md +1 -1
  220. package/api/@wtf/release-go/modules/functions/majorOfPath.md +1 -1
  221. package/api/@wtf/release-go/modules/functions/modulesAt.md +3 -3
  222. package/api/@wtf/release-go/modules/functions/modulesOf.md +1 -1
  223. package/api/@wtf/release-go/modules/functions/readModules.md +4 -5
  224. package/api/@wtf/release-go/modules/functions/selectModules.md +13 -11
  225. package/api/@wtf/release-go/modules/interfaces/Selection.md +10 -11
  226. package/api/@wtf/release-go/release/README.md +45 -0
  227. package/api/@wtf/release-go/release/functions/isGoVersion.md +28 -0
  228. package/api/@wtf/release-go/release/functions/prepareModules.md +47 -0
  229. package/api/@wtf/release-go/release/functions/publishModules.md +54 -0
  230. package/api/@wtf/release-go/release/functions/releaseModules.md +48 -0
  231. package/api/@wtf/release-go/release/functions/releasedOf.md +41 -0
  232. package/api/@wtf/release-go/release/functions/verifyModules.md +44 -0
  233. package/api/@wtf/release-go/release/interfaces/ReleaseModules.md +31 -0
  234. package/api/@wtf/release-go/stamp/README.md +6 -5
  235. package/api/@wtf/release-go/stamp/functions/checkVersions.md +1 -1
  236. package/api/@wtf/release-go/stamp/functions/stampGoMod.md +1 -1
  237. package/api/@wtf/release-go/stamp/functions/stampModules.md +16 -10
  238. package/api/@wtf/release-go/stamp/interfaces/StampOptions.md +21 -0
  239. package/api/@wtf/release-go/stamp/interfaces/Stamped.md +3 -3
  240. package/api/@wtf/release-go/stamp/interfaces/StampedModules.md +13 -3
  241. package/api/@wtf/release-go/tags/README.md +3 -6
  242. package/api/@wtf/release-go/tags/functions/askProxy.md +6 -6
  243. package/api/@wtf/release-go/tags/functions/maskCredentials.md +1 -1
  244. package/api/@wtf/release-go/tags/functions/releaseCommit.md +16 -9
  245. package/api/@wtf/release-go/tags/functions/remoteTags.md +3 -3
  246. package/api/@wtf/release-go/tags/functions/tagModules.md +3 -3
  247. package/api/@wtf/release-go/tags/functions/tagOfModule.md +1 -1
  248. package/api/@wtf/release-go/tags/functions/tagPrefix.md +1 -1
  249. package/api/@wtf/release-go/tags/interfaces/CommitIdentity.md +35 -0
  250. package/api/@wtf/release-go/tags/interfaces/TagModulesOptions.md +42 -10
  251. package/api/@wtf/release-go/tags/interfaces/TaggedModule.md +5 -5
  252. package/api/@wtf/release-go/tags/interfaces/TagsContext.md +22 -0
  253. package/api/@wtf/release-go/tags/type-aliases/ModuleStatus.md +1 -1
  254. package/api/@wtf/release-maven/README.md +11 -8
  255. package/api/@wtf/release-maven/artifacts/README.md +11 -6
  256. package/api/@wtf/release-maven/artifacts/functions/groupIdOf.md +1 -1
  257. package/api/@wtf/release-maven/artifacts/functions/installsOf.md +1 -1
  258. package/api/@wtf/release-maven/artifacts/functions/isPomFile.md +1 -1
  259. package/api/@wtf/release-maven/artifacts/functions/isRange.md +1 -1
  260. package/api/@wtf/release-maven/artifacts/functions/modulesOf.md +1 -1
  261. package/api/@wtf/release-maven/artifacts/functions/nameOf.md +1 -1
  262. package/api/@wtf/release-maven/artifacts/functions/publishOrder.md +1 -1
  263. package/api/@wtf/release-maven/artifacts/functions/readModules.md +3 -3
  264. package/api/@wtf/release-maven/artifacts/functions/readPoms.md +4 -4
  265. package/api/@wtf/release-maven/artifacts/functions/selectArtifacts.md +1 -1
  266. package/api/@wtf/release-maven/artifacts/interfaces/Selection.md +8 -8
  267. package/api/@wtf/release-maven/ecosystem/README.md +28 -13
  268. package/api/@wtf/release-maven/ecosystem/functions/checkReleaseVersion.md +32 -0
  269. package/api/@wtf/release-maven/ecosystem/functions/compareVersions.md +1 -1
  270. package/api/@wtf/release-maven/ecosystem/functions/parseRange.md +1 -1
  271. package/api/@wtf/release-maven/ecosystem/functions/resolveVersion.md +1 -1
  272. package/api/@wtf/release-maven/ecosystem/functions/satisfiesVersion.md +1 -1
  273. package/api/@wtf/release-maven/ecosystem/interfaces/Bound.md +3 -3
  274. package/api/@wtf/release-maven/ecosystem/interfaces/MavenReleaseOptions.md +77 -0
  275. package/api/@wtf/release-maven/ecosystem/interfaces/Restriction.md +3 -3
  276. package/api/@wtf/release-maven/ecosystem/variables/mavenEcosystem.md +5 -3
  277. package/api/@wtf/release-maven/errors/README.md +3 -4
  278. package/api/@wtf/release-maven/errors/classes/MavenError.md +17 -32
  279. package/api/@wtf/release-maven/errors/type-aliases/MavenErrorCode.md +1 -1
  280. package/api/@wtf/release-maven/errors/variables/MAVEN_ERRORS.md +4 -4
  281. package/api/@wtf/release-maven/interfaces/MavenModule.md +24 -24
  282. package/api/@wtf/release-maven/pom/functions/childOf.md +1 -1
  283. package/api/@wtf/release-maven/pom/functions/childrenOf.md +1 -1
  284. package/api/@wtf/release-maven/pom/functions/dependencyOf.md +1 -1
  285. package/api/@wtf/release-maven/pom/functions/escapeXml.md +1 -1
  286. package/api/@wtf/release-maven/pom/functions/parseXml.md +1 -1
  287. package/api/@wtf/release-maven/pom/functions/readPom.md +1 -1
  288. package/api/@wtf/release-maven/pom/functions/textAt.md +1 -1
  289. package/api/@wtf/release-maven/pom/interfaces/Pom.md +15 -15
  290. package/api/@wtf/release-maven/pom/interfaces/PomDependency.md +5 -5
  291. package/api/@wtf/release-maven/pom/interfaces/PomParent.md +4 -4
  292. package/api/@wtf/release-maven/pom/interfaces/PomPlugin.md +5 -5
  293. package/api/@wtf/release-maven/pom/interfaces/PomRepository.md +3 -3
  294. package/api/@wtf/release-maven/pom/interfaces/Span.md +3 -3
  295. package/api/@wtf/release-maven/pom/interfaces/XmlElement.md +7 -7
  296. package/api/@wtf/release-maven/pom/variables/PLUGIN_GROUP.md +1 -1
  297. package/api/@wtf/release-maven/publish/README.md +9 -6
  298. package/api/@wtf/release-maven/publish/functions/deployModules.md +2 -2
  299. package/api/@wtf/release-maven/publish/functions/releasedModules.md +44 -0
  300. package/api/@wtf/release-maven/publish/interfaces/DeployModulesOptions.md +18 -27
  301. package/api/@wtf/release-maven/publish/interfaces/DeployedModule.md +4 -4
  302. package/api/@wtf/release-maven/publish/interfaces/ReleasedWhere.md +67 -0
  303. package/api/@wtf/release-maven/publish/type-aliases/ModuleStatus.md +1 -1
  304. package/api/@wtf/release-maven/repository/README.md +12 -6
  305. package/api/@wtf/release-maven/repository/functions/deployTargets.md +1 -1
  306. package/api/@wtf/release-maven/repository/functions/expandValues.md +1 -1
  307. package/api/@wtf/release-maven/repository/functions/hasPom.md +1 -1
  308. package/api/@wtf/release-maven/repository/functions/lookupHeaders.md +37 -0
  309. package/api/@wtf/release-maven/repository/functions/lookupPom.md +44 -0
  310. package/api/@wtf/release-maven/repository/functions/pomPath.md +1 -1
  311. package/api/@wtf/release-maven/repository/functions/pomUrl.md +1 -1
  312. package/api/@wtf/release-maven/repository/functions/releaseTargets.md +46 -0
  313. package/api/@wtf/release-maven/repository/interfaces/LookupAuth.md +32 -0
  314. package/api/@wtf/release-maven/repository/interfaces/ReleaseTargets.md +32 -0
  315. package/api/@wtf/release-maven/repository/interfaces/Repository.md +3 -3
  316. package/api/@wtf/release-maven/repository/interfaces/ValuesOf.md +3 -3
  317. package/api/@wtf/release-maven/repository/variables/MAVEN_CENTRAL.md +1 -1
  318. package/api/@wtf/release-maven/stamp/README.md +8 -8
  319. package/api/@wtf/release-maven/stamp/functions/checkVersions.md +1 -1
  320. package/api/@wtf/release-maven/stamp/functions/stampModules.md +15 -15
  321. package/api/@wtf/release-maven/stamp/functions/stampPom.md +1 -1
  322. package/api/@wtf/release-maven/stamp/interfaces/PomStampOptions.md +5 -5
  323. package/api/@wtf/release-maven/stamp/interfaces/Stamped.md +3 -3
  324. package/api/@wtf/release-maven/stamp/interfaces/StampedModules.md +4 -4
  325. package/api/@wtf/release-npm/README.md +20 -15
  326. package/api/@wtf/release-npm/check/README.md +1 -1
  327. package/api/@wtf/release-npm/check/functions/checkPackages.md +3 -3
  328. package/api/@wtf/release-npm/check/functions/formatIssue.md +1 -1
  329. package/api/@wtf/release-npm/check/interfaces/CheckOptions.md +7 -7
  330. package/api/@wtf/release-npm/check/interfaces/Issue.md +6 -6
  331. package/api/@wtf/release-npm/check/type-aliases/CheckedPackage.md +1 -1
  332. package/api/@wtf/release-npm/check/type-aliases/IssueCode.md +2 -2
  333. package/api/@wtf/release-npm/ecosystem/README.md +21 -11
  334. package/api/@wtf/release-npm/ecosystem/variables/npmEcosystem.md +17 -7
  335. package/api/@wtf/release-npm/errors/README.md +8 -4
  336. package/api/@wtf/release-npm/errors/classes/NpmError.md +253 -0
  337. package/api/@wtf/release-npm/errors/type-aliases/NpmErrorCode.md +1 -1
  338. package/api/@wtf/release-npm/errors/variables/NPM_ERRORS.md +7 -3
  339. package/api/@wtf/release-npm/interfaces/Lookup.md +3 -3
  340. package/api/@wtf/release-npm/interfaces/NpmAside.md +46 -0
  341. package/api/@wtf/release-npm/interfaces/NpmOptions.md +134 -0
  342. package/api/@wtf/release-npm/interfaces/PublishOptions.md +6 -6
  343. package/api/@wtf/release-npm/interfaces/PublishPackage.md +5 -5
  344. package/api/@wtf/release-npm/interfaces/Publisher.md +11 -11
  345. package/api/@wtf/release-npm/interfaces/PublisherContext.md +32 -23
  346. package/api/@wtf/release-npm/manifests/README.md +5 -5
  347. package/api/@wtf/release-npm/manifests/functions/concreteRange.md +1 -1
  348. package/api/@wtf/release-npm/manifests/functions/manifestsAt.md +3 -4
  349. package/api/@wtf/release-npm/manifests/functions/packageOf.md +1 -1
  350. package/api/@wtf/release-npm/manifests/functions/packagesOfManifests.md +1 -1
  351. package/api/@wtf/release-npm/manifests/functions/readManifests.md +7 -7
  352. package/api/@wtf/release-npm/manifests/functions/resolveSpecifier.md +1 -1
  353. package/api/@wtf/release-npm/manifests/functions/runtimeDependenciesOf.md +1 -1
  354. package/api/@wtf/release-npm/manifests/functions/satisfiesRange.md +1 -1
  355. package/api/@wtf/release-npm/manifests/interfaces/Manifest.md +5 -5
  356. package/api/@wtf/release-npm/manifests/interfaces/NpmPackage.md +16 -16
  357. package/api/@wtf/release-npm/manifests/type-aliases/DependencyField.md +1 -1
  358. package/api/@wtf/release-npm/manifests/variables/DEPENDENCY_FIELDS.md +1 -1
  359. package/api/@wtf/release-npm/manifests/variables/FIELD_KINDS.md +2 -2
  360. package/api/@wtf/release-npm/manifests/variables/RUNTIME_FIELDS.md +1 -1
  361. package/api/@wtf/release-npm/prepare/functions/isTypeScriptSource.md +1 -1
  362. package/api/@wtf/release-npm/prepare/functions/prepareManifest.md +1 -1
  363. package/api/@wtf/release-npm/prepare/functions/stripSourceConditions.md +1 -1
  364. package/api/@wtf/release-npm/prepare/interfaces/PrepareOptions.md +6 -6
  365. package/api/@wtf/release-npm/prepare/interfaces/PreparedManifest.md +6 -6
  366. package/api/@wtf/release-npm/prepare/variables/SOURCE_CONDITIONS.md +1 -1
  367. package/api/@wtf/release-npm/publishers/README.md +1 -1
  368. package/api/@wtf/release-npm/publishers/functions/builtInPublisher.md +1 -1
  369. package/api/@wtf/release-npm/publishers/functions/isPublisher.md +1 -1
  370. package/api/@wtf/release-npm/publishers/functions/registryOf.md +1 -1
  371. package/api/@wtf/release-npm/publishers/variables/NPM_REGISTRY.md +1 -1
  372. package/api/@wtf/release-npm/publishers/variables/PUBLISHERS.md +1 -1
  373. package/api/@wtf/release-npm/publishers/variables/npmPublisher.md +1 -1
  374. package/api/@wtf/release-npm/publishers/variables/pnpmPublisher.md +1 -1
  375. package/api/@wtf/release-npm/release/README.md +59 -37
  376. package/api/@wtf/release-npm/release/functions/checkPlan.md +44 -0
  377. package/api/@wtf/release-npm/release/functions/discardPacked.md +32 -0
  378. package/api/@wtf/release-npm/release/functions/moveRelease.md +47 -0
  379. package/api/@wtf/release-npm/release/functions/packRelease.md +39 -0
  380. package/api/@wtf/release-npm/release/functions/prepareRelease.md +46 -0
  381. package/api/@wtf/release-npm/release/functions/publishPacked.md +17 -11
  382. package/api/@wtf/release-npm/release/functions/publishRelease.md +44 -0
  383. package/api/@wtf/release-npm/release/functions/publishedOf.md +12 -11
  384. package/api/@wtf/release-npm/release/functions/resolvePlan.md +49 -0
  385. package/api/@wtf/release-npm/release/functions/smokeRelease.md +40 -0
  386. package/api/@wtf/release-npm/release/functions/verifyRelease.md +41 -0
  387. package/api/@wtf/release-npm/release/interfaces/MovedPackage.md +79 -0
  388. package/api/@wtf/release-npm/release/interfaces/MovedRelease.md +39 -0
  389. package/api/@wtf/release-npm/release/interfaces/NpmPlan.md +68 -0
  390. package/api/@wtf/release-npm/release/interfaces/PackOptions.md +35 -31
  391. package/api/@wtf/release-npm/release/interfaces/PackedRelease.md +107 -0
  392. package/api/@wtf/release-npm/release/interfaces/PublishRun.md +35 -50
  393. package/api/@wtf/release-npm/release/interfaces/PublishedOf.md +4 -14
  394. package/api/@wtf/release-npm/release/interfaces/PublishedPackage.md +13 -14
  395. package/api/@wtf/release-npm/release/interfaces/PublishedRelease.md +49 -0
  396. package/api/@wtf/release-npm/release/interfaces/ResolvedPackage.md +4 -4
  397. package/api/@wtf/release-npm/release/interfaces/ResolvedRelease.md +37 -0
  398. package/api/@wtf/release-npm/release/type-aliases/LookedUpRelease.md +13 -0
  399. package/api/@wtf/release-npm/release/variables/ID_TOKENS.md +1 -1
  400. package/api/@wtf/release-npm/release/variables/RUNNER_ENVIRONMENTS.md +1 -1
  401. package/api/@wtf/release-npm/release/variables/npmOptionsSchema.md +13 -0
  402. package/api/@wtf/release-npm/workspace/README.md +7 -3
  403. package/api/@wtf/release-npm/workspace/functions/pnpmWorkspaceGlobs.md +1 -1
  404. package/api/@wtf/release-npm/workspace/functions/publishableOf.md +1 -1
  405. package/api/@wtf/release-npm/workspace/functions/readWorkspace.md +3 -9
  406. package/api/@wtf/release-npm/workspace/functions/workspaceFolders.md +3 -9
  407. package/api/@wtf/release-npm/workspace/functions/workspaceGlobs.md +3 -9
  408. package/api/@wtf/release-npm/workspace/interfaces/WorkspaceGlobs.md +3 -3
  409. package/api/@wtf/release-oci/README.md +38 -0
  410. package/api/@wtf/release-oci/ecosystem/README.md +56 -0
  411. package/api/@wtf/release-oci/ecosystem/functions/packagesOfImages.md +29 -0
  412. package/api/@wtf/release-oci/ecosystem/functions/packagesOfRepo.md +32 -0
  413. package/api/@wtf/release-oci/ecosystem/functions/repositoriesOf.md +27 -0
  414. package/api/@wtf/release-oci/ecosystem/functions/resolveTag.md +35 -0
  415. package/api/@wtf/release-oci/ecosystem/functions/satisfiesTag.md +34 -0
  416. package/api/@wtf/release-oci/ecosystem/interfaces/OciOptions.md +64 -0
  417. package/api/@wtf/release-oci/ecosystem/interfaces/OciPackage.md +97 -0
  418. package/api/@wtf/release-oci/ecosystem/interfaces/OciSourceOptions.md +32 -0
  419. package/api/@wtf/release-oci/ecosystem/variables/ociEcosystem.md +29 -0
  420. package/api/@wtf/release-oci/errors/README.md +24 -0
  421. package/api/@wtf/release-oci/errors/classes/OciError.md +253 -0
  422. package/api/@wtf/release-oci/errors/type-aliases/OciErrorCode.md +13 -0
  423. package/api/@wtf/release-oci/errors/variables/OCI_ERRORS.md +51 -0
  424. package/api/@wtf/release-oci/images/README.md +35 -0
  425. package/api/@wtf/release-oci/images/functions/imageDirOf.md +28 -0
  426. package/api/@wtf/release-oci/images/functions/imagesAt.md +44 -0
  427. package/api/@wtf/release-oci/images/functions/imagesOf.md +34 -0
  428. package/api/@wtf/release-oci/images/functions/isImageManifest.md +27 -0
  429. package/api/@wtf/release-oci/images/functions/readImages.md +34 -0
  430. package/api/@wtf/release-oci/images/functions/registryImageOf.md +28 -0
  431. package/api/@wtf/release-oci/images/functions/repositoryOf.md +35 -0
  432. package/api/@wtf/release-oci/interfaces/OciImage.md +44 -0
  433. package/api/@wtf/release-oci/publish/README.md +65 -0
  434. package/api/@wtf/release-oci/publish/functions/digestOf.md +38 -0
  435. package/api/@wtf/release-oci/publish/functions/moveImages.md +32 -0
  436. package/api/@wtf/release-oci/publish/functions/platformsOf.md +44 -0
  437. package/api/@wtf/release-oci/publish/functions/publishImages.md +32 -0
  438. package/api/@wtf/release-oci/publish/functions/smokeImages.md +41 -0
  439. package/api/@wtf/release-oci/publish/interfaces/CraneContext.md +40 -0
  440. package/api/@wtf/release-oci/publish/interfaces/ImageToPublish.md +35 -0
  441. package/api/@wtf/release-oci/publish/interfaces/ImagesMove.md +84 -0
  442. package/api/@wtf/release-oci/publish/interfaces/ImagesRelease.md +84 -0
  443. package/api/@wtf/release-oci/publish/interfaces/MovedImage.md +41 -0
  444. package/api/@wtf/release-oci/publish/interfaces/OciSource.md +31 -0
  445. package/api/@wtf/release-oci/publish/interfaces/PublishedImage.md +91 -0
  446. package/api/@wtf/release-oci/publish/interfaces/SmokedImage.md +67 -0
  447. package/api/@wtf/release-oci/registry/README.md +50 -0
  448. package/api/@wtf/release-oci/registry/functions/checkRegistryAccess.md +28 -0
  449. package/api/@wtf/release-oci/registry/functions/registryPageOf.md +30 -0
  450. package/api/@wtf/release-oci/registry/interfaces/ContainerRegistry.md +35 -0
  451. package/api/@wtf/release-oci/registry/interfaces/RegistryProject.md +51 -0
  452. package/api/@wtf/release-oci/registry/interfaces/RegistryQuery.md +63 -0
  453. package/api/@wtf/release-oci/registry/interfaces/RegistryResponse.md +47 -0
  454. package/api/@wtf/release-oci/registry/type-aliases/RegistryAccess.md +13 -0
  455. package/api/@wtf/release-oci/registry/type-aliases/RegistryFetch.md +39 -0
  456. package/api/@wtf/release-oci/tags/README.md +28 -0
  457. package/api/@wtf/release-oci/tags/functions/checkReleaseTags.md +35 -0
  458. package/api/@wtf/release-oci/tags/functions/isImageTag.md +27 -0
  459. package/api/@wtf/release-oci/tags/interfaces/ReleaseTags.md +31 -0
  460. package/api/@wtf/release-replace/README.md +6 -5
  461. package/api/@wtf/release-replace/errors/README.md +3 -3
  462. package/api/@wtf/release-replace/errors/classes/ReplaceError.md +17 -32
  463. package/api/@wtf/release-replace/errors/type-aliases/ReplaceErrorCode.md +1 -1
  464. package/api/@wtf/release-replace/errors/variables/REPLACE_ERRORS.md +1 -1
  465. package/api/@wtf/release-replace/files/functions/filesMatcher.md +3 -3
  466. package/api/@wtf/release-replace/interfaces/ReplaceMatch.md +5 -5
  467. package/api/@wtf/release-replace/interfaces/ReplacementOf.md +5 -5
  468. package/api/@wtf/release-replace/replace/README.md +3 -3
  469. package/api/@wtf/release-replace/replace/functions/regExpOf.md +1 -1
  470. package/api/@wtf/release-replace/replace/functions/replaceFiles.md +3 -3
  471. package/api/@wtf/release-replace/replace/functions/replaceText.md +1 -1
  472. package/api/@wtf/release-replace/replace/interfaces/ReplaceOptions.md +35 -32
  473. package/api/@wtf/release-replace/replace/interfaces/TextOptions.md +5 -5
  474. package/api/@wtf/release-replace/replace/type-aliases/To.md +1 -1
  475. package/api/@wtf/release-replace/templates/functions/mergeTemplates.md +1 -1
  476. package/api/@wtf/release-replace/templates/functions/resolveReplacement.md +1 -1
  477. package/api/@wtf/release-replace/templates/functions/resolveReplacements.md +1 -1
  478. package/api/@wtf/release-replace/type-aliases/Escape.md +1 -1
  479. package/api/@wtf/release-replace/type-aliases/ReplaceFunction.md +1 -1
  480. package/api/@wtf/release-replace/type-aliases/Replacement.md +1 -1
  481. package/api/@wtf/release-replace/type-aliases/ReplacementSpec.md +1 -1
  482. package/api/@wtf/release-replace/type-aliases/TemplateUse.md +1 -1
  483. package/api/@wtf/release-replace/type-aliases/Templates.md +1 -1
  484. package/api/@wtf/release-replace/values/functions/escapeValue.md +1 -1
  485. package/api/@wtf/release-replace/values/functions/textOf.md +1 -1
  486. package/api/@wtf/release-replace/values/functions/valueAt.md +1 -1
  487. package/api/@wtf/release-replace/values/variables/ESCAPES.md +1 -1
  488. package/api/@wtf/release-replace/values/variables/VALUE.md +1 -1
  489. package/api/@wtf/release-trains/README.md +9 -8
  490. package/api/@wtf/release-trains/cascade/README.md +6 -5
  491. package/api/@wtf/release-trains/cascade/functions/cascadeNotes.md +1 -1
  492. package/api/@wtf/release-trains/cascade/functions/cascadeText.md +1 -1
  493. package/api/@wtf/release-trains/cascade/functions/cascadeType.md +1 -1
  494. package/api/@wtf/release-trains/cascade/functions/cascadesOf.md +2 -2
  495. package/api/@wtf/release-trains/cascade/functions/higherType.md +1 -1
  496. package/api/@wtf/release-trains/cascade/interfaces/Cascade.md +11 -11
  497. package/api/@wtf/release-trains/cascade/interfaces/CascadeCheck.md +30 -27
  498. package/api/@wtf/release-trains/cascade/type-aliases/CascadeKind.md +2 -2
  499. package/api/@wtf/release-trains/cascade/type-aliases/ReleaseType.md +1 -1
  500. package/api/@wtf/release-trains/cascade/variables/RELEASE_TYPES.md +1 -1
  501. package/api/@wtf/release-trains/errors/README.md +6 -5
  502. package/api/@wtf/release-trains/errors/classes/TrainsError.md +18 -32
  503. package/api/@wtf/release-trains/errors/type-aliases/TrainsErrorCode.md +1 -1
  504. package/api/@wtf/release-trains/errors/variables/TRAINS_ERRORS.md +1 -13
  505. package/api/@wtf/release-trains/git/README.md +4 -4
  506. package/api/@wtf/release-trains/git/functions/tagOf.md +1 -1
  507. package/api/@wtf/release-trains/git/functions/tagsOf.md +4 -4
  508. package/api/@wtf/release-trains/git/functions/versionOfTag.md +1 -1
  509. package/api/@wtf/release-trains/git/interfaces/TrainTag.md +3 -3
  510. package/api/@wtf/release-trains/gitlab/README.md +6 -3
  511. package/api/@wtf/release-trains/gitlab/functions/findPackage.md +1 -1
  512. package/api/@wtf/release-trains/gitlab/functions/gitlabForge.md +33 -0
  513. package/api/@wtf/release-trains/gitlab/functions/gitlabHeadersOf.md +1 -1
  514. package/api/@wtf/release-trains/gitlab/functions/gitlabProjectOf.md +1 -1
  515. package/api/@wtf/release-trains/gitlab/functions/gitlabRegistryOf.md +1 -1
  516. package/api/@wtf/release-trains/gitlab/functions/uploadGeneric.md +1 -1
  517. package/api/@wtf/release-trains/gitlab/interfaces/GenericUpload.md +8 -8
  518. package/api/@wtf/release-trains/gitlab/interfaces/GitLabForgeOptions.md +97 -0
  519. package/api/@wtf/release-trains/gitlab/interfaces/GitLabOptions.md +4 -4
  520. package/api/@wtf/release-trains/gitlab/interfaces/GitLabProject.md +6 -6
  521. package/api/@wtf/release-trains/gitlab/interfaces/GitLabRegistry.md +5 -5
  522. package/api/@wtf/release-trains/gitlab/interfaces/HttpResponse.md +4 -4
  523. package/api/@wtf/release-trains/gitlab/interfaces/PackageQuery.md +9 -9
  524. package/api/@wtf/release-trains/gitlab/type-aliases/HttpFetch.md +1 -1
  525. package/api/@wtf/release-trains/gitlab/variables/LISTING_WAITS.md +1 -1
  526. package/api/@wtf/release-trains/interfaces/Train.md +7 -7
  527. package/api/@wtf/release-trains/links/README.md +16 -20
  528. package/api/@wtf/release-trains/links/functions/releaseLinks.md +15 -13
  529. package/api/@wtf/release-trains/links/interfaces/LinkOptions.md +56 -33
  530. package/api/@wtf/release-trains/packages/README.md +11 -16
  531. package/api/@wtf/release-trains/packages/functions/dependencyEdges.md +2 -2
  532. package/api/@wtf/release-trains/packages/functions/dependencyText.md +1 -1
  533. package/api/@wtf/release-trains/packages/functions/dependsOnErrors.md +2 -2
  534. package/api/@wtf/release-trains/packages/functions/ownersOf.md +2 -2
  535. package/api/@wtf/release-trains/packages/functions/packagesOf.md +2 -2
  536. package/api/@wtf/release-trains/packages/functions/releasedVersions.md +2 -2
  537. package/api/@wtf/release-trains/packages/functions/trainDependencies.md +2 -2
  538. package/api/@wtf/release-trains/packages/functions/trainOrder.md +2 -2
  539. package/api/@wtf/release-trains/packages/functions/unsatisfiedErrors.md +5 -4
  540. package/api/@wtf/release-trains/packages/interfaces/DependencyEdge.md +6 -6
  541. package/api/@wtf/release-trains/packages/interfaces/TrainDependency.md +3 -3
  542. package/api/@wtf/release-trains/packages/interfaces/VersionsRelease.md +24 -21
  543. package/api/@wtf/release-trains/paths/README.md +5 -4
  544. package/api/@wtf/release-trains/paths/functions/filterCommits.md +1 -1
  545. package/api/@wtf/release-trains/paths/functions/gitFilesOf.md +4 -4
  546. package/api/@wtf/release-trains/paths/functions/overlapError.md +1 -1
  547. package/api/@wtf/release-trains/paths/functions/trainOfPath.md +1 -1
  548. package/api/@wtf/release-trains/paths/functions/trainsOfCommit.md +1 -1
  549. package/api/@wtf/release-trains/paths/functions/trainsOfPath.md +1 -1
  550. package/api/@wtf/release-trains/paths/type-aliases/FilesOf.md +1 -1
  551. package/api/@wtf/release-trains/plan/README.md +38 -0
  552. package/api/@wtf/release-trains/plan/functions/planOf.md +45 -0
  553. package/api/@wtf/release-trains/plan/interfaces/PlanRelease.md +113 -0
  554. package/api/@wtf/release-trains/plan/interfaces/TrainPlan.md +72 -0
  555. package/api/@wtf/release-trains/schema/README.md +1 -1
  556. package/api/@wtf/release-trains/schema/interfaces/ConfigPart.md +6 -6
  557. package/api/@wtf/release-trains/schema/interfaces/RootOptions.md +7 -17
  558. package/api/@wtf/release-trains/schema/type-aliases/DependencyRule.md +1 -1
  559. package/api/@wtf/release-trains/schema/variables/DEPENDENCY_RULES.md +1 -1
  560. package/api/@wtf/release-trains/schema/variables/TAG_FORMAT_PATTERN.md +1 -1
  561. package/api/@wtf/release-trains/schema/variables/TRAIN_NAME_PATTERN.md +1 -1
  562. package/api/@wtf/release-trains/schema/variables/configSchema.md +2 -2
  563. package/api/@wtf/release-trains/schema/variables/jsonSchema.md +2 -2
  564. package/api/@wtf/release-trains/schema/variables/rootOptionsSchema.md +4 -4
  565. package/api/@wtf/release-trains/schema/variables/trainSchema.md +2 -2
  566. package/api/@wtf/release-trains/schema/variables/trainsSchema.md +2 -2
  567. package/api/@wtf/release-trains/trains/functions/changelogOf.md +1 -1
  568. package/api/@wtf/release-trains/trains/functions/matchersOf.md +3 -3
  569. package/api/@wtf/release-trains/trains/functions/overlapErrors.md +1 -1
  570. package/api/@wtf/release-trains/trains/functions/selectTrain.md +1 -1
  571. package/api/@wtf/release-trains/trains/functions/tagFormatOf.md +1 -1
  572. package/api/@wtf/release-trains/trains/functions/trainHeadedNotes.md +1 -1
  573. package/api/@wtf/release-trains/trains/functions/trainOfRun.md +1 -1
  574. package/api/@wtf/release-trains/trains/functions/trainOfTag.md +1 -1
  575. package/api/@wtf/release-trains/trains/functions/trainsErrors.md +1 -1
  576. package/api/@wtf/release-trains/trains/functions/trainsOfOptions.md +4 -9
  577. package/api/@wtf/release-trains/trains/variables/TRAIN_VARIABLE.md +1 -1
  578. package/api/@wtf/release-trains/trains/variables/VERSION.md +1 -1
  579. package/api/@wtf/release-trains/type-aliases/BranchSpec.md +1 -1
  580. package/api/@wtf/release-trains/type-aliases/Trains.md +1 -1
  581. package/api/@wtf/release-trains/verify/README.md +8 -7
  582. package/api/@wtf/release-trains/verify/functions/unreleasedDependencies.md +3 -3
  583. package/api/@wtf/release-trains/verify/functions/verifyTrain.md +3 -3
  584. package/api/@wtf/release-trains/verify/interfaces/UnreleasedDependencies.md +33 -30
  585. package/api/@wtf/release-trains/verify/interfaces/VerifiedTrain.md +5 -5
  586. package/api/@wtf/release-trains/verify/interfaces/VerifyRelease.md +27 -24
  587. package/api/@wtf/release-validate/errors/README.md +3 -4
  588. package/api/@wtf/release-validate/errors/classes/ValidateError.md +29 -32
  589. package/api/@wtf/release-validate/errors/type-aliases/ValidateErrorCode.md +1 -1
  590. package/api/@wtf/release-validate/errors/variables/VALIDATE_ERRORS.md +1 -1
  591. package/api/@wtf/release-validate/interfaces/ConfigIssue.md +4 -4
  592. package/api/@wtf/release-validate/json-schema/functions/fromJsonSchema.md +1 -1
  593. package/api/@wtf/release-validate/json-schema/functions/pathOfPointer.md +1 -1
  594. package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaError.md +3 -3
  595. package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaValidator.md +3 -3
  596. package/api/@wtf/release-validate/validate/functions/configErrors.md +1 -1
  597. package/api/@wtf/release-validate/validate/functions/isStandardSchema.md +1 -1
  598. package/api/@wtf/release-validate/validate/functions/pathText.md +1 -1
  599. package/api/@wtf/release-validate/validate/functions/validateConfig.md +1 -1
  600. package/api/@wtf/semantic-release/README.md +36 -0
  601. package/api/@wtf/semantic-release/errors/README.md +32 -0
  602. package/api/@wtf/semantic-release/errors/functions/marked.md +29 -0
  603. package/api/@wtf/semantic-release/errors/functions/markedStep.md +36 -0
  604. package/api/@wtf/semantic-release/errors/variables/SEMANTIC_RELEASE_ERROR.md +13 -0
  605. package/api/@wtf/{release-system/node → semantic-release}/functions/realPathOf.md +3 -3
  606. package/api/@wtf/semantic-release/functions/runOf.md +31 -0
  607. package/api/@wtf/semantic-release/interfaces/RunContext.md +31 -0
  608. package/api/@wtf/semantic-release/links/README.md +38 -0
  609. package/api/@wtf/{release-trains → semantic-release}/links/functions/forgetReleased.md +2 -2
  610. package/api/@wtf/{release-trains → semantic-release}/links/functions/recordReleased.md +3 -3
  611. package/api/@wtf/semantic-release/links/functions/releasedOf.md +28 -0
  612. package/api/@wtf/semantic-release/links/interfaces/ReleaseRun.md +41 -0
  613. package/api/@wtf/semantic-release/release/README.md +47 -0
  614. package/api/@wtf/semantic-release/release/functions/inTrain.md +42 -0
  615. package/api/@wtf/semantic-release/release/functions/stepRelease.md +35 -0
  616. package/api/@wtf/semantic-release/release/functions/trainNamed.md +34 -0
  617. package/api/@wtf/semantic-release/release/functions/trainPrefix.md +27 -0
  618. package/api/@wtf/semantic-release/release/interfaces/StepContext.md +63 -0
  619. package/api/@wtf/semantic-release/release/interfaces/StepOf.md +63 -0
  620. package/api/@wtf/semantic-release/schema/README.md +23 -0
  621. package/api/@wtf/{release-system/validator → semantic-release/schema}/functions/pluginEntriesOf.md +5 -5
  622. package/api/@wtf/semantic-release-cargo/README.md +32 -26
  623. package/api/@wtf/semantic-release-cargo/functions/indexLookup.md +3 -3
  624. package/api/@wtf/semantic-release-cargo/interfaces/CargoPluginOptions.md +46 -23
  625. package/api/@wtf/semantic-release-cargo/interfaces/CargoRelease.md +3 -3
  626. package/api/@wtf/semantic-release-cargo/schema/README.md +2 -2
  627. package/api/@wtf/semantic-release-cargo/schema/type-aliases/CargoOptions.md +2 -2
  628. package/api/@wtf/semantic-release-cargo/schema/variables/cargoOptionsSchema.md +2 -2
  629. package/api/@wtf/semantic-release-cargo/schema/variables/cargoSchema.md +2 -2
  630. package/api/@wtf/semantic-release-cargo/schema/variables/configSchema.md +2 -2
  631. package/api/@wtf/semantic-release-cargo/schema/variables/jsonSchema.md +2 -2
  632. package/api/@wtf/semantic-release-cargo/variables/default.md +43 -14
  633. package/api/@wtf/semantic-release-cargo/{functions → variables}/prepare.md +7 -7
  634. package/api/@wtf/semantic-release-cargo/{functions → variables}/publish.md +6 -5
  635. package/api/@wtf/semantic-release-cargo/variables/verifyConditions.md +37 -0
  636. package/api/@wtf/semantic-release-cargo/variables/verifyRelease.md +37 -0
  637. package/api/@wtf/semantic-release-go/README.md +40 -36
  638. package/api/@wtf/semantic-release-go/interfaces/GoPluginOptions.md +7 -17
  639. package/api/@wtf/semantic-release-go/interfaces/GoRelease.md +3 -3
  640. package/api/@wtf/semantic-release-go/schema/README.md +2 -2
  641. package/api/@wtf/semantic-release-go/schema/type-aliases/GoOptions.md +2 -2
  642. package/api/@wtf/semantic-release-go/schema/variables/configSchema.md +2 -2
  643. package/api/@wtf/semantic-release-go/schema/variables/goOptionsSchema.md +2 -2
  644. package/api/@wtf/semantic-release-go/schema/variables/goSchema.md +2 -2
  645. package/api/@wtf/semantic-release-go/schema/variables/jsonSchema.md +2 -2
  646. package/api/@wtf/semantic-release-go/variables/default.md +26 -22
  647. package/api/@wtf/semantic-release-go/variables/prepare.md +40 -0
  648. package/api/@wtf/semantic-release-go/variables/publish.md +45 -0
  649. package/api/@wtf/semantic-release-go/{functions → variables}/verifyConditions.md +8 -7
  650. package/api/@wtf/semantic-release-go/variables/verifyRelease.md +40 -0
  651. package/api/@wtf/semantic-release-maven/README.md +38 -20
  652. package/api/@wtf/semantic-release-maven/functions/pomLookup.md +3 -3
  653. package/api/@wtf/semantic-release-maven/interfaces/MavenPluginOptions.md +12 -22
  654. package/api/@wtf/semantic-release-maven/interfaces/MavenRelease.md +2 -2
  655. package/api/@wtf/semantic-release-maven/schema/README.md +2 -2
  656. package/api/@wtf/semantic-release-maven/schema/type-aliases/MavenOptions.md +2 -2
  657. package/api/@wtf/semantic-release-maven/schema/variables/configSchema.md +2 -2
  658. package/api/@wtf/semantic-release-maven/schema/variables/jsonSchema.md +2 -2
  659. package/api/@wtf/semantic-release-maven/schema/variables/mavenOptionsSchema.md +2 -2
  660. package/api/@wtf/semantic-release-maven/schema/variables/mavenSchema.md +2 -2
  661. package/api/@wtf/semantic-release-maven/variables/default.md +45 -16
  662. package/api/@wtf/semantic-release-maven/variables/prepare.md +41 -0
  663. package/api/@wtf/semantic-release-maven/variables/publish.md +44 -0
  664. package/api/@wtf/semantic-release-maven/{functions → variables}/verifyConditions.md +6 -7
  665. package/api/@wtf/semantic-release-maven/variables/verifyRelease.md +36 -0
  666. package/api/@wtf/semantic-release-npm/README.md +39 -29
  667. package/api/@wtf/semantic-release-npm/functions/loadPublisher.md +1 -1
  668. package/api/@wtf/semantic-release-npm/interfaces/PublishPluginOptions.md +24 -82
  669. package/api/@wtf/semantic-release-npm/interfaces/PublishedRelease.md +4 -4
  670. package/api/@wtf/semantic-release-npm/interfaces/SmokeOption.md +2 -2
  671. package/api/@wtf/semantic-release-npm/schema/README.md +1 -1
  672. package/api/@wtf/semantic-release-npm/schema/type-aliases/PublishOptions.md +3 -3
  673. package/api/@wtf/semantic-release-npm/schema/variables/configSchema.md +2 -2
  674. package/api/@wtf/semantic-release-npm/schema/variables/jsonSchema.md +2 -2
  675. package/api/@wtf/semantic-release-npm/schema/variables/publishOptionsSchema.md +2 -2
  676. package/api/@wtf/semantic-release-npm/schema/variables/publishSchema.md +2 -2
  677. package/api/@wtf/semantic-release-npm/type-aliases/PublisherSpec.md +1 -1
  678. package/api/@wtf/semantic-release-npm/{functions → variables}/addChannel.md +7 -6
  679. package/api/@wtf/semantic-release-npm/variables/default.md +51 -15
  680. package/api/@wtf/semantic-release-npm/variables/fail.md +36 -0
  681. package/api/@wtf/semantic-release-npm/variables/prepare.md +37 -0
  682. package/api/@wtf/semantic-release-npm/{functions → variables}/publish.md +8 -6
  683. package/api/@wtf/semantic-release-npm/{functions → variables}/verifyConditions.md +6 -4
  684. package/api/@wtf/semantic-release-npm/variables/verifyRelease.md +35 -0
  685. package/api/@wtf/semantic-release-oci/README.md +64 -0
  686. package/api/@wtf/semantic-release-oci/interfaces/OciPluginOptions.md +119 -0
  687. package/api/@wtf/semantic-release-oci/interfaces/OciRelease.md +31 -0
  688. package/api/@wtf/semantic-release-oci/schema/README.md +38 -0
  689. package/api/@wtf/semantic-release-oci/schema/type-aliases/OciOptions.md +13 -0
  690. package/api/@wtf/semantic-release-oci/schema/variables/configSchema.md +13 -0
  691. package/api/@wtf/semantic-release-oci/schema/variables/jsonSchema.md +13 -0
  692. package/api/@wtf/semantic-release-oci/schema/variables/ociOptionsSchema.md +13 -0
  693. package/api/@wtf/semantic-release-oci/schema/variables/ociSchema.md +14 -0
  694. package/api/@wtf/semantic-release-oci/variables/default.md +112 -0
  695. package/api/@wtf/semantic-release-oci/variables/publish.md +47 -0
  696. package/api/@wtf/semantic-release-oci/variables/verifyConditions.md +38 -0
  697. package/api/@wtf/semantic-release-oci/variables/verifyRelease.md +35 -0
  698. package/api/@wtf/semantic-release-replace/README.md +4 -4
  699. package/api/@wtf/semantic-release-replace/functions/functionOf.md +1 -1
  700. package/api/@wtf/semantic-release-replace/functions/templatesOf.md +1 -1
  701. package/api/@wtf/semantic-release-replace/schema/README.md +1 -1
  702. package/api/@wtf/semantic-release-replace/schema/interfaces/ModuleExport.md +3 -3
  703. package/api/@wtf/semantic-release-replace/schema/interfaces/ReplaceOptions.md +4 -8
  704. package/api/@wtf/semantic-release-replace/schema/interfaces/RootTemplates.md +2 -2
  705. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacement.md +1 -1
  706. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacementSpec.md +1 -1
  707. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTemplates.md +1 -1
  708. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTo.md +1 -1
  709. package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplateSet.md +1 -1
  710. package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplatesOption.md +1 -1
  711. package/api/@wtf/semantic-release-replace/schema/variables/configSchema.md +2 -2
  712. package/api/@wtf/semantic-release-replace/schema/variables/exportedSetSchema.md +2 -2
  713. package/api/@wtf/semantic-release-replace/schema/variables/jsonSchema.md +2 -2
  714. package/api/@wtf/semantic-release-replace/schema/variables/replaceOptionsSchema.md +2 -2
  715. package/api/@wtf/semantic-release-replace/schema/variables/replacementSchema.md +2 -2
  716. package/api/@wtf/semantic-release-replace/schema/variables/rootTemplatesSchema.md +2 -2
  717. package/api/@wtf/semantic-release-replace/schema/variables/templateSchema.md +2 -2
  718. package/api/@wtf/semantic-release-replace/schema/variables/templatesSchema.md +2 -2
  719. package/api/@wtf/semantic-release-replace/type-aliases/ReplacePluginOptions.md +13 -0
  720. package/api/@wtf/semantic-release-replace/variables/default.md +5 -5
  721. package/api/@wtf/semantic-release-replace/{functions → variables}/prepare.md +6 -6
  722. package/api/@wtf/semantic-release-replace/{functions → variables}/verifyConditions.md +5 -5
  723. package/api/@wtf/semantic-release-trains/config/functions/skipPlugins.md +1 -1
  724. package/api/@wtf/semantic-release-trains/config/functions/stepId.md +1 -1
  725. package/api/@wtf/semantic-release-trains/config/functions/trainAssets.md +1 -1
  726. package/api/@wtf/semantic-release-trains/config/functions/trainChangelog.md +1 -1
  727. package/api/@wtf/semantic-release-trains/config/functions/trainOfTag.md +1 -1
  728. package/api/@wtf/semantic-release-trains/config/functions/trainTagFormat.md +1 -1
  729. package/api/@wtf/semantic-release-trains/config/interfaces/AssetsOptions.md +4 -4
  730. package/api/@wtf/semantic-release-trains/config/interfaces/SkipOptions.md +3 -3
  731. package/api/@wtf/semantic-release-trains/config/variables/BRANCHES.md +1 -1
  732. package/api/@wtf/semantic-release-trains/config/variables/BREAKING.md +1 -1
  733. package/api/@wtf/semantic-release-trains/config/variables/TITLE.md +1 -1
  734. package/api/@wtf/semantic-release-trains/defaults/functions/listingFetchOf.md +1 -1
  735. package/api/@wtf/semantic-release-trains/defaults/functions/skipRuleOf.md +1 -1
  736. package/api/@wtf/semantic-release-trains/defaults/functions/skips.md +3 -2
  737. package/api/@wtf/semantic-release-trains/defaults/functions/stepOptionsOf.md +1 -1
  738. package/api/@wtf/semantic-release-trains/defaults/functions/trainOptionsOf.md +1 -1
  739. package/api/@wtf/semantic-release-trains/defaults/interfaces/ListingRetry.md +3 -3
  740. package/api/@wtf/semantic-release-trains/defaults/interfaces/SkipContext.md +35 -12
  741. package/api/@wtf/semantic-release-trains/defaults/interfaces/StepOptionsContext.md +18 -7
  742. package/api/@wtf/semantic-release-trains/defaults/type-aliases/SkipCheck.md +3 -2
  743. package/api/@wtf/semantic-release-trains/defaults/type-aliases/StepOptions.md +1 -1
  744. package/api/@wtf/semantic-release-trains/defaults/type-aliases/TrainOptions.md +1 -1
  745. package/api/@wtf/semantic-release-trains/defaults/variables/SKIP_RULES.md +1 -1
  746. package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_OPTIONS.md +1 -1
  747. package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_SKIP.md +1 -1
  748. package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_STEP_OPTIONS.md +1 -1
  749. package/api/@wtf/semantic-release-trains/defaults/variables/releaseAssets.md +2 -2
  750. package/api/@wtf/semantic-release-trains/errors/type-aliases/PluginErrorCode.md +1 -1
  751. package/api/@wtf/semantic-release-trains/errors/variables/PLUGIN_ERRORS.md +1 -1
  752. package/api/@wtf/semantic-release-trains/info/README.md +3 -3
  753. package/api/@wtf/semantic-release-trains/info/functions/decideTrain.md +1 -1
  754. package/api/@wtf/semantic-release-trains/info/functions/dotenvOf.md +1 -1
  755. package/api/@wtf/semantic-release-trains/info/functions/infoOf.md +3 -2
  756. package/api/@wtf/semantic-release-trains/info/interfaces/DecideRun.md +4 -4
  757. package/api/@wtf/semantic-release-trains/info/interfaces/InfoRun.md +36 -33
  758. package/api/@wtf/semantic-release-trains/info/interfaces/TrainDecision.md +5 -5
  759. package/api/@wtf/semantic-release-trains/info/interfaces/TrainInfo.md +5 -5
  760. package/api/@wtf/semantic-release-trains/interfaces/TrainsEntryOptions.md +5 -5
  761. package/api/@wtf/semantic-release-trains/interfaces/TrainsOptions.md +7 -17
  762. package/api/@wtf/semantic-release-trains/schema/README.md +1 -1
  763. package/api/@wtf/semantic-release-trains/schema/variables/configSchema.md +2 -2
  764. package/api/@wtf/semantic-release-trains/schema/variables/jsonSchema.md +2 -2
  765. package/api/@wtf/semantic-release-trains/schema/variables/pluginSpecSchema.md +2 -2
  766. package/api/@wtf/semantic-release-trains/schema/variables/skipRuleSchema.md +2 -2
  767. package/api/@wtf/semantic-release-trains/schema/variables/trainsEntrySchema.md +2 -2
  768. package/api/@wtf/semantic-release-trains/schema/variables/trainsPluginSchema.md +2 -2
  769. package/api/@wtf/semantic-release-trains/type-aliases/PluginSpec.md +1 -1
  770. package/api/@wtf/semantic-release-trains/type-aliases/TrainsPluginOptions.md +1 -1
  771. package/api/@wtf/semantic-release-trains/variables/addChannel.md +1 -1
  772. package/api/@wtf/semantic-release-trains/variables/analyzeCommits.md +1 -1
  773. package/api/@wtf/semantic-release-trains/variables/default.md +1 -1
  774. package/api/@wtf/semantic-release-trains/variables/fail.md +1 -1
  775. package/api/@wtf/semantic-release-trains/variables/generateNotes.md +1 -1
  776. package/api/@wtf/semantic-release-trains/variables/prepare.md +1 -1
  777. package/api/@wtf/semantic-release-trains/variables/publish.md +1 -1
  778. package/api/@wtf/semantic-release-trains/variables/success.md +1 -1
  779. package/api/@wtf/semantic-release-trains/variables/verifyConditions.md +1 -1
  780. package/api/@wtf/semantic-release-trains/variables/verifyRelease.md +1 -1
  781. package/api/@wtf/semantic-release-validate/README.md +1 -1
  782. package/api/@wtf/semantic-release-validate/functions/configOf.md +1 -1
  783. package/api/@wtf/semantic-release-validate/functions/loadSchema.md +1 -1
  784. package/api/@wtf/semantic-release-validate/interfaces/ValidatePluginOptions.md +2 -2
  785. package/api/@wtf/semantic-release-validate/schema/interfaces/Validator.md +2 -2
  786. package/api/@wtf/semantic-release-validate/schema/variables/configSchema.md +1 -1
  787. package/api/@wtf/semantic-release-validate/schema/variables/jsonSchema.md +1 -1
  788. package/api/@wtf/semantic-release-validate/schema/variables/validateOptionsSchema.md +1 -1
  789. package/api/@wtf/semantic-release-validate/variables/default.md +2 -2
  790. package/api/@wtf/semantic-release-validate/{functions → variables}/verifyConditions.md +5 -5
  791. package/api/README.md +31 -10
  792. package/api/trains.json +32 -9
  793. package/guides/ci-recipes.md +29 -27
  794. package/guides/configuring-trains.md +24 -20
  795. package/guides/dependency-rules.md +17 -17
  796. package/guides/ecosystems.md +69 -32
  797. package/guides/getting-started.md +26 -21
  798. package/guides/platform.md +179 -0
  799. package/guides/publishing-crates.md +58 -17
  800. package/guides/publishing-go-modules.md +55 -11
  801. package/guides/publishing-maven.md +48 -10
  802. package/guides/publishing-oci.md +134 -0
  803. package/guides/publishing.md +105 -84
  804. package/guides/troubleshooting.md +13 -12
  805. package/guides/validating-a-config.md +1 -0
  806. package/package.json +24 -16
  807. package/api/@wtf/release-go/tags/variables/RELEASE_AUTHOR.md +0 -23
  808. package/api/@wtf/release-npm/interfaces/PublishTrainOptions.md +0 -144
  809. package/api/@wtf/release-npm/release/functions/checkTrain.md +0 -32
  810. package/api/@wtf/release-npm/release/functions/distTagOf.md +0 -31
  811. package/api/@wtf/release-npm/release/functions/packTrain.md +0 -39
  812. package/api/@wtf/release-npm/release/functions/publishTrain.md +0 -37
  813. package/api/@wtf/release-npm/release/functions/publishedOfResolved.md +0 -36
  814. package/api/@wtf/release-npm/release/functions/releaseTrain.md +0 -31
  815. package/api/@wtf/release-npm/release/functions/resolveManifests.md +0 -37
  816. package/api/@wtf/release-npm/release/functions/tagTrain.md +0 -36
  817. package/api/@wtf/release-npm/release/interfaces/CheckRelease.md +0 -222
  818. package/api/@wtf/release-npm/release/interfaces/PackedTrain.md +0 -125
  819. package/api/@wtf/release-npm/release/interfaces/PublishedTrain.md +0 -47
  820. package/api/@wtf/release-npm/release/interfaces/ResolveRelease.md +0 -220
  821. package/api/@wtf/release-npm/release/interfaces/ResolvedTrain.md +0 -55
  822. package/api/@wtf/release-npm/release/interfaces/TagRelease.md +0 -174
  823. package/api/@wtf/release-npm/release/type-aliases/LookedUpTrain.md +0 -13
  824. package/api/@wtf/release-npm/release/type-aliases/ReleaseRun.md +0 -13
  825. package/api/@wtf/release-npm/workspace/interfaces/WorkspaceOptions.md +0 -19
  826. package/api/@wtf/release-system/README.md +0 -71
  827. package/api/@wtf/release-system/errors/README.md +0 -42
  828. package/api/@wtf/release-system/errors/functions/throwAll.md +0 -26
  829. package/api/@wtf/release-system/errors/type-aliases/SystemErrorCode.md +0 -13
  830. package/api/@wtf/release-system/errors/variables/SYSTEM_ERRORS.md +0 -23
  831. package/api/@wtf/release-system/git/functions/gitOf.md +0 -39
  832. package/api/@wtf/release-system/git/interfaces/GitContext.md +0 -45
  833. package/api/@wtf/release-system/git/interfaces/LogCommit.md +0 -43
  834. package/api/@wtf/release-system/node/README.md +0 -25
  835. package/api/@wtf/release-system/node/functions/nodeSystem.md +0 -20
  836. package/api/@wtf/release-system/node/functions/systemOf.md +0 -29
  837. package/api/@wtf/release-system/system/README.md +0 -39
  838. package/api/@wtf/release-system/system/interfaces/DirEntry.md +0 -27
  839. package/api/@wtf/release-system/system/interfaces/ExecOptions.md +0 -41
  840. package/api/@wtf/release-system/system/interfaces/ExecResult.md +0 -35
  841. package/api/@wtf/release-system/system/interfaces/System.md +0 -73
  842. package/api/@wtf/release-system/system/interfaces/SystemFs.md +0 -184
  843. package/api/@wtf/release-system/system/type-aliases/Exec.md +0 -41
  844. package/api/@wtf/release-system/system/type-aliases/SystemInput.md +0 -20
  845. package/api/@wtf/release-system/validator/interfaces/OptionIssue.md +0 -63
  846. package/api/@wtf/release-system/validator/interfaces/Property.md +0 -49
  847. package/api/@wtf/release-system/validator/type-aliases/JsonSchema.md +0 -17
  848. package/api/@wtf/release-system/validator/type-aliases/Path.md +0 -13
  849. package/api/@wtf/release-trains/ecosystem/functions/isEcosystem.md +0 -27
  850. package/api/@wtf/release-trains/ecosystem/functions/readPackages.md +0 -33
  851. package/api/@wtf/release-trains/ecosystem/interfaces/Dependency.md +0 -43
  852. package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemContext.md +0 -68
  853. package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemPackages.md +0 -27
  854. package/api/@wtf/release-trains/ecosystem/interfaces/Package.md +0 -70
  855. package/api/@wtf/release-trains/ecosystem/type-aliases/DependencyKind.md +0 -16
  856. package/api/@wtf/release-trains/ecosystem/variables/DEPENDENCY_KINDS.md +0 -13
  857. package/api/@wtf/release-trains/generated/functions/listGenerated.md +0 -41
  858. package/api/@wtf/release-trains/generated/functions/readGenerated.md +0 -39
  859. package/api/@wtf/release-trains/generated/functions/stageGeneratedFolders.md +0 -29
  860. package/api/@wtf/release-trains/generated/functions/unlistedIn.md +0 -42
  861. package/api/@wtf/release-trains/generated/interfaces/GeneratedOptions.md +0 -19
  862. package/api/@wtf/release-trains/generated/interfaces/StageOptions.md +0 -73
  863. package/api/@wtf/release-trains/generated/variables/GENERATED.md +0 -13
  864. package/api/@wtf/release-trains/links/functions/releasedOf.md +0 -28
  865. package/api/@wtf/release-trains/links/interfaces/PackageRegistry.md +0 -41
  866. package/api/@wtf/release-trains/links/interfaces/ReleaseLink.md +0 -41
  867. package/api/@wtf/release-trains/links/interfaces/ReleaseRun.md +0 -41
  868. package/api/@wtf/release-trains/links/interfaces/ReleasedPackage.md +0 -92
  869. package/api/@wtf/release-trains/packages/interfaces/OrderFault.md +0 -39
  870. package/api/@wtf/release-trains/packages/interfaces/OrderPins.md +0 -27
  871. package/api/@wtf/release-trains/packages/interfaces/PublishOrder.md +0 -35
  872. package/api/@wtf/semantic-release-cargo/functions/verifyConditions.md +0 -39
  873. package/api/@wtf/semantic-release-go/functions/prepare.md +0 -41
  874. package/api/@wtf/semantic-release-go/functions/publish.md +0 -43
  875. package/api/@wtf/semantic-release-go/functions/verifyRelease.md +0 -38
  876. package/api/@wtf/semantic-release-maven/functions/prepare.md +0 -41
  877. package/api/@wtf/semantic-release-maven/functions/publish.md +0 -43
  878. package/api/@wtf/semantic-release-maven/interfaces/LookupAuth.md +0 -32
  879. package/api/@wtf/semantic-release-npm/functions/fail.md +0 -36
  880. package/api/@wtf/semantic-release-npm/functions/prepare.md +0 -34
  881. package/api/@wtf/semantic-release-replace/interfaces/ReplacePluginOptions.md +0 -71
  882. package/guides/system.md +0 -175
@@ -6,20 +6,20 @@
6
6
 
7
7
  # Function: stampModules()
8
8
 
9
- > **stampModules**(`context`, `modules`, `versions`): `Promise`\<[`StampedModules`](../interfaces/StampedModules.md)\>
9
+ > **stampModules**(`root`, `modules`, `versions`, `options?`): `Promise`\<[`StampedModules`](../interfaces/StampedModules.md)\>
10
10
 
11
- Defined in: [packages/release-go/src/stamp.ts:117](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/stamp.ts#L117)
11
+ Defined in: [packages/release-go/src/stamp.ts:127](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/stamp.ts#L127)
12
12
 
13
13
  Writes `versions` into the go.mod of each of `modules`, as the module says. A file of no change
14
- is not written.
14
+ is not written, and of `dryRun` none is.
15
15
 
16
16
  ## Parameters
17
17
 
18
- ### context
18
+ ### root
19
19
 
20
- [`GitContext`](../../../release-system/git/interfaces/GitContext.md)
20
+ `FileSystemDirectoryHandle`
21
21
 
22
- The folder of the repo and the system the files are read and written by.
22
+ The folder of the repo, whose files are read and written.
23
23
 
24
24
  ### modules
25
25
 
@@ -31,12 +31,18 @@ Every module of the repo, as `readModules` of `./modules` gives them.
31
31
 
32
32
  `ReadonlyMap`\<`string`, `string`\>
33
33
 
34
- The version each module takes, by its path: of the modules of the train of the
35
- release, the release's, and of each other train's, its last release (`releasedVersions` of
36
- `@wtf/release-trains/packages`).
34
+ The version each module takes, by its path, as `versions` of the plan of the
35
+ release gives it: of the modules of the release, the release's, and of each other, the last
36
+ release of its own.
37
+
38
+ ### options?
39
+
40
+ [`StampOptions`](../interfaces/StampOptions.md) = `{}`
41
+
42
+ Whether it writes nothing.
37
43
 
38
44
  ## Returns
39
45
 
40
46
  `Promise`\<[`StampedModules`](../interfaces/StampedModules.md)\>
41
47
 
42
- The go.mod files written, and how many values.
48
+ The go.mod files written, or that would be, how many values, and the modules stamped.
@@ -0,0 +1,21 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-go/stamp](../README.md) / StampOptions
6
+
7
+ # Interface: StampOptions
8
+
9
+ Defined in: [packages/release-go/src/stamp.ts:110](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/stamp.ts#L110)
10
+
11
+ How [stampModules](../functions/stampModules.md) stamps.
12
+
13
+ ## Properties
14
+
15
+ ### dryRun?
16
+
17
+ > `readonly` `optional` **dryRun?**: `boolean`
18
+
19
+ Defined in: [packages/release-go/src/stamp.ts:112](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/stamp.ts#L112)
20
+
21
+ Whether it writes nothing, and only says what it would write: `false` by default.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Stamped
8
8
 
9
- Defined in: [packages/release-go/src/stamp.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/stamp.ts#L39)
9
+ Defined in: [packages/release-go/src/stamp.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/stamp.ts#L40)
10
10
 
11
11
  A go.mod stamped, and how many values it wrote.
12
12
 
@@ -16,7 +16,7 @@ A go.mod stamped, and how many values it wrote.
16
16
 
17
17
  > `readonly` **changes**: `number`
18
18
 
19
- Defined in: [packages/release-go/src/stamp.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/stamp.ts#L43)
19
+ Defined in: [packages/release-go/src/stamp.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/stamp.ts#L44)
20
20
 
21
21
  The values that were another, and are of the versions now.
22
22
 
@@ -26,6 +26,6 @@ The values that were another, and are of the versions now.
26
26
 
27
27
  > `readonly` **text**: `string`
28
28
 
29
- Defined in: [packages/release-go/src/stamp.ts:41](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/stamp.ts#L41)
29
+ Defined in: [packages/release-go/src/stamp.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/stamp.ts#L42)
30
30
 
31
31
  The go.mod, the versions written.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: StampedModules
8
8
 
9
- Defined in: [packages/release-go/src/stamp.ts:99](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/stamp.ts#L99)
9
+ Defined in: [packages/release-go/src/stamp.ts:100](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/stamp.ts#L100)
10
10
 
11
11
  The result of stamping the modules of a repo: the go.mod files written, and the values.
12
12
 
@@ -16,7 +16,7 @@ The result of stamping the modules of a repo: the go.mod files written, and the
16
16
 
17
17
  > `readonly` **changes**: `number`
18
18
 
19
- Defined in: [packages/release-go/src/stamp.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/stamp.ts#L103)
19
+ Defined in: [packages/release-go/src/stamp.ts:104](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/stamp.ts#L104)
20
20
 
21
21
  The values written.
22
22
 
@@ -26,6 +26,16 @@ The values written.
26
26
 
27
27
  > `readonly` **files**: readonly `string`[]
28
28
 
29
- Defined in: [packages/release-go/src/stamp.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/stamp.ts#L101)
29
+ Defined in: [packages/release-go/src/stamp.ts:102](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/stamp.ts#L102)
30
30
 
31
31
  The go.mod files whose text changed, from the root of the repo.
32
+
33
+ ***
34
+
35
+ ### modules
36
+
37
+ > `readonly` **modules**: readonly [`GoModule`](../../interfaces/GoModule.md)[]
38
+
39
+ Defined in: [packages/release-go/src/stamp.ts:106](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/stamp.ts#L106)
40
+
41
+ Every module of `modules`, as its go.mod reads stamped, written or not.
@@ -20,23 +20,20 @@ once and listed.
20
20
  ```ts
21
21
  import { tagOfModule } from '@wtf/release-go/tags'
22
22
 
23
- const module = { path: 'example.com/repo/lib/v2', dir: 'lib/v2', manifest: 'lib/v2/go.mod' }
24
- console.log(tagOfModule({ ...module, requires: [], replaces: [] }, '2.1.0')) // lib/v2.1.0
23
+ console.log(tagOfModule({ path: 'example.com/repo/lib/v2', dir: 'lib/v2' }, '2.1.0')) // lib/v2.1.0
25
24
  ```
26
25
 
27
26
  ## Interfaces
28
27
 
28
+ - [CommitIdentity](interfaces/CommitIdentity.md)
29
29
  - [TaggedModule](interfaces/TaggedModule.md)
30
30
  - [TagModulesOptions](interfaces/TagModulesOptions.md)
31
+ - [TagsContext](interfaces/TagsContext.md)
31
32
 
32
33
  ## Type Aliases
33
34
 
34
35
  - [ModuleStatus](type-aliases/ModuleStatus.md)
35
36
 
36
- ## Variables
37
-
38
- - [RELEASE\_AUTHOR](variables/RELEASE_AUTHOR.md)
39
-
40
37
  ## Functions
41
38
 
42
39
  - [askProxy](functions/askProxy.md)
@@ -8,20 +8,20 @@
8
8
 
9
9
  > **askProxy**(`context`, `modules`, `version`): `Promise`\<`void`\>
10
10
 
11
- Defined in: [packages/release-go/src/tags.ts:293](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L293)
11
+ Defined in: [packages/release-go/src/tags.ts:317](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L317)
12
12
 
13
13
  Asks the Go proxy for each of `modules` at `version`, by `go list -m -json <path>@v<version>`
14
- in the system's temporary folder, of no workspace (`GOWORK=off`, `GOFLAGS=-mod=mod`), and
15
- `GOPROXY` of the environment, Go's own by default: the proxy fetches it once, and lists it. Each
16
- that fails is an error, together.
14
+ in the platform's temporary folder, `dirs.temp`, of no workspace (`GOWORK=off`,
15
+ `GOFLAGS=-mod=mod`), and `GOPROXY` of the environment, Go's own by default: the proxy fetches it
16
+ once, and lists it. Each that fails is an error, together.
17
17
 
18
18
  ## Parameters
19
19
 
20
20
  ### context
21
21
 
22
- [`GitContext`](../../../release-system/git/interfaces/GitContext.md)
22
+ [`TagsContext`](../interfaces/TagsContext.md)
23
23
 
24
- The environment, and the system `go` runs by.
24
+ The platform `go` runs by, of its environment and its temporary folder.
25
25
 
26
26
  ### modules
27
27
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **maskCredentials**(`text`): `string`
10
10
 
11
- Defined in: [packages/release-go/src/tags.ts:73](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L73)
11
+ Defined in: [packages/release-go/src/tags.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L69)
12
12
 
13
13
  A text of no credentials of a URL: `https://user:token@host` as `https://[secure]@host`, as a
14
14
  remote of a CI holds its token.
@@ -6,24 +6,25 @@
6
6
 
7
7
  # Function: releaseCommit()
8
8
 
9
- > **releaseCommit**(`context`, `files`, `message`): `Promise`\<`string`\>
9
+ > **releaseCommit**(`context`, `files`, `message`, `identity`): `Promise`\<`string`\>
10
10
 
11
- Defined in: [packages/release-go/src/tags.ts:114](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L114)
11
+ Defined in: [packages/release-go/src/tags.ts:126](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L126)
12
12
 
13
13
  A commit of `files`, the go.mod files stamped in the working tree, on top of `HEAD`, on no branch,
14
- as `git commit` would make it but by a temporary index of the system's temporary files: `HEAD`,
15
- the index and the working tree are left as they are. Its author and committer are those of
16
- `GIT_AUTHOR_*` and `GIT_COMMITTER_*` of the environment, else [RELEASE\_AUTHOR](../variables/RELEASE_AUTHOR.md). A tree the
17
- same as `HEAD`'s, as of go.mod files that require no module of the repo, is no commit: it gives
18
- `HEAD` itself.
14
+ as `git commit` would make it but by a temporary index, in a temporary folder of the platform:
15
+ `HEAD`, the index and the working tree are left as they are. Its author and committer are those
16
+ of `identity`, in place of any of the environment, as `GIT_AUTHOR_NAME`. A tree the same as
17
+ `HEAD`'s, as of go.mod files that require no module of the repo, is no commit: it gives `HEAD`
18
+ itself.
19
19
 
20
20
  ## Parameters
21
21
 
22
22
  ### context
23
23
 
24
- [`GitContext`](../../../release-system/git/interfaces/GitContext.md)
24
+ [`TagsContext`](../interfaces/TagsContext.md)
25
25
 
26
- The folder of the repo, its environment, and the system git runs by.
26
+ The platform git runs by, of the folder of the repo, which makes the temporary
27
+ folder.
27
28
 
28
29
  ### files
29
30
 
@@ -37,6 +38,12 @@ The go.mod files, from the root of the repo.
37
38
 
38
39
  The message of the commit.
39
40
 
41
+ ### identity
42
+
43
+ [`CommitIdentity`](../interfaces/CommitIdentity.md)
44
+
45
+ Its author, and its committer.
46
+
40
47
  ## Returns
41
48
 
42
49
  `Promise`\<`string`\>
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **remoteTags**(`context`, `remote`, `tags`): `Promise`\<`Set`\<`string`\>\>
10
10
 
11
- Defined in: [packages/release-go/src/tags.ts:173](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L173)
11
+ Defined in: [packages/release-go/src/tags.ts:197](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L197)
12
12
 
13
13
  The tags of `tags` the remote has, of one `git ls-remote`.
14
14
 
@@ -16,9 +16,9 @@ The tags of `tags` the remote has, of one `git ls-remote`.
16
16
 
17
17
  ### context
18
18
 
19
- [`GitContext`](../../../release-system/git/interfaces/GitContext.md)
19
+ [`GitContext`](../../../release/git/interfaces/GitContext.md)
20
20
 
21
- The folder of the repo, its environment, and the system git runs by.
21
+ The platform git runs by, of the folder of the repo.
22
22
 
23
23
  ### remote
24
24
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **tagModules**(`options`): `Promise`\<[`TaggedModule`](../interfaces/TaggedModule.md)[]\>
10
10
 
11
- Defined in: [packages/release-go/src/tags.ts:247](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L247)
11
+ Defined in: [packages/release-go/src/tags.ts:271](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L271)
12
12
 
13
13
  Tags the modules of a release and pushes the tags: asks the remote which tags it has first, so a
14
14
  remote that cannot be asked stops before anything is made; skips each it has; makes the commit of
@@ -22,8 +22,8 @@ none.
22
22
 
23
23
  [`TagModulesOptions`](../interfaces/TagModulesOptions.md)
24
24
 
25
- The repo, the remote, the modules and the version, the files of the commit and
26
- its message, and the log.
25
+ The repo, the remote, the modules and the version, the files of the commit, its
26
+ message, its author and its committer, and the log.
27
27
 
28
28
  ## Returns
29
29
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **tagOfModule**(`module`, `version`): `string`
10
10
 
11
- Defined in: [packages/release-go/src/tags.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L61)
11
+ Defined in: [packages/release-go/src/tags.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L57)
12
12
 
13
13
  The tag of `module` at `version`, as Go looks it up: `<prefix>/v<version>`, `v<version>` of a
14
14
  module whose prefix is the root ([tagPrefix](tagPrefix.md)).
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **tagPrefix**(`module`): `string`
10
10
 
11
- Defined in: [packages/release-go/src/tags.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L45)
11
+ Defined in: [packages/release-go/src/tags.ts:41](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L41)
12
12
 
13
13
  The prefix of the tags of `module`, as Go looks them up: its folder, `.` at the root; of a module
14
14
  in a folder of its major (a path that ends in `/vN`, in the folder `vN` or one that ends in
@@ -0,0 +1,35 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-go/tags](../README.md) / CommitIdentity
6
+
7
+ # Interface: CommitIdentity
8
+
9
+ Defined in: [packages/release-go/src/tags.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L103)
10
+
11
+ Who makes a release commit: its author, and its committer, the author by default.
12
+
13
+ ## Extended by
14
+
15
+ - [`TagModulesOptions`](TagModulesOptions.md)
16
+
17
+ ## Properties
18
+
19
+ ### author
20
+
21
+ > `readonly` **author**: [`GoIdentity`](../../interfaces/GoIdentity.md)
22
+
23
+ Defined in: [packages/release-go/src/tags.ts:105](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L105)
24
+
25
+ The author of the commit.
26
+
27
+ ***
28
+
29
+ ### committer?
30
+
31
+ > `readonly` `optional` **committer?**: [`GoIdentity`](../../interfaces/GoIdentity.md)
32
+
33
+ Defined in: [packages/release-go/src/tags.ts:107](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L107)
34
+
35
+ The committer of the commit: the author by default.
@@ -6,19 +6,51 @@
6
6
 
7
7
  # Interface: TagModulesOptions
8
8
 
9
- Defined in: [packages/release-go/src/tags.ts:214](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L214)
9
+ Defined in: [packages/release-go/src/tags.ts:238](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L238)
10
10
 
11
11
  What a release of tags needs.
12
12
 
13
+ ## Extends
14
+
15
+ - [`CommitIdentity`](CommitIdentity.md)
16
+
13
17
  ## Properties
14
18
 
19
+ ### author
20
+
21
+ > `readonly` **author**: [`GoIdentity`](../../interfaces/GoIdentity.md)
22
+
23
+ Defined in: [packages/release-go/src/tags.ts:105](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L105)
24
+
25
+ The author of the commit.
26
+
27
+ #### Inherited from
28
+
29
+ [`CommitIdentity`](CommitIdentity.md).[`author`](CommitIdentity.md#author)
30
+
31
+ ***
32
+
33
+ ### committer?
34
+
35
+ > `readonly` `optional` **committer?**: [`GoIdentity`](../../interfaces/GoIdentity.md)
36
+
37
+ Defined in: [packages/release-go/src/tags.ts:107](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L107)
38
+
39
+ The committer of the commit: the author by default.
40
+
41
+ #### Inherited from
42
+
43
+ [`CommitIdentity`](CommitIdentity.md).[`committer`](CommitIdentity.md#committer)
44
+
45
+ ***
46
+
15
47
  ### context
16
48
 
17
- > `readonly` **context**: [`GitContext`](../../../release-system/git/interfaces/GitContext.md)
49
+ > `readonly` **context**: [`TagsContext`](TagsContext.md)
18
50
 
19
- Defined in: [packages/release-go/src/tags.ts:216](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L216)
51
+ Defined in: [packages/release-go/src/tags.ts:240](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L240)
20
52
 
21
- The folder of the repo, its environment, and the system git runs by.
53
+ The platform git runs by, of the folder of the repo, which makes the temporary folder.
22
54
 
23
55
  ***
24
56
 
@@ -26,7 +58,7 @@ The folder of the repo, its environment, and the system git runs by.
26
58
 
27
59
  > `readonly` **files**: readonly `string`[]
28
60
 
29
- Defined in: [packages/release-go/src/tags.ts:224](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L224)
61
+ Defined in: [packages/release-go/src/tags.ts:248](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L248)
30
62
 
31
63
  The go.mod files the stamp wrote, from the root of the repo, which the commit holds.
32
64
 
@@ -36,7 +68,7 @@ The go.mod files the stamp wrote, from the root of the repo, which the commit ho
36
68
 
37
69
  > `readonly` **log**: (`line`) => `void`
38
70
 
39
- Defined in: [packages/release-go/src/tags.ts:232](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L232)
71
+ Defined in: [packages/release-go/src/tags.ts:256](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L256)
40
72
 
41
73
  Says a line of what is done.
42
74
 
@@ -58,7 +90,7 @@ The line.
58
90
 
59
91
  > `readonly` **message**: `string`
60
92
 
61
- Defined in: [packages/release-go/src/tags.ts:226](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L226)
93
+ Defined in: [packages/release-go/src/tags.ts:250](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L250)
62
94
 
63
95
  The message of the commit the tags name.
64
96
 
@@ -68,7 +100,7 @@ The message of the commit the tags name.
68
100
 
69
101
  > `readonly` **modules**: readonly [`GoModule`](../../interfaces/GoModule.md)[]
70
102
 
71
- Defined in: [packages/release-go/src/tags.ts:220](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L220)
103
+ Defined in: [packages/release-go/src/tags.ts:244](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L244)
72
104
 
73
105
  The modules of the release.
74
106
 
@@ -78,7 +110,7 @@ The modules of the release.
78
110
 
79
111
  > `readonly` **remote**: `string`
80
112
 
81
- Defined in: [packages/release-go/src/tags.ts:218](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L218)
113
+ Defined in: [packages/release-go/src/tags.ts:242](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L242)
82
114
 
83
115
  The remote the tags are pushed to, by its name or its URL, of its credentials.
84
116
 
@@ -88,6 +120,6 @@ The remote the tags are pushed to, by its name or its URL, of its credentials.
88
120
 
89
121
  > `readonly` **version**: `string`
90
122
 
91
- Defined in: [packages/release-go/src/tags.ts:222](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L222)
123
+ Defined in: [packages/release-go/src/tags.ts:246](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L246)
92
124
 
93
125
  The version of the release, as `1.2.3`.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: TaggedModule
8
8
 
9
- Defined in: [packages/release-go/src/tags.ts:202](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L202)
9
+ Defined in: [packages/release-go/src/tags.ts:226](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L226)
10
10
 
11
11
  A module of the release, its tag, and what became of it.
12
12
 
@@ -16,7 +16,7 @@ A module of the release, its tag, and what became of it.
16
16
 
17
17
  > `readonly` **path**: `string`
18
18
 
19
- Defined in: [packages/release-go/src/tags.ts:204](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L204)
19
+ Defined in: [packages/release-go/src/tags.ts:228](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L228)
20
20
 
21
21
  The path of the module.
22
22
 
@@ -26,7 +26,7 @@ The path of the module.
26
26
 
27
27
  > `readonly` **status**: [`ModuleStatus`](../type-aliases/ModuleStatus.md)
28
28
 
29
- Defined in: [packages/release-go/src/tags.ts:210](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L210)
29
+ Defined in: [packages/release-go/src/tags.ts:234](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L234)
30
30
 
31
31
  Whether it was tagged and pushed, or skipped as the remote has its tag.
32
32
 
@@ -36,7 +36,7 @@ Whether it was tagged and pushed, or skipped as the remote has its tag.
36
36
 
37
37
  > `readonly` **tag**: `string`
38
38
 
39
- Defined in: [packages/release-go/src/tags.ts:208](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L208)
39
+ Defined in: [packages/release-go/src/tags.ts:232](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L232)
40
40
 
41
41
  Its tag, as `lib/v1.2.3`.
42
42
 
@@ -46,6 +46,6 @@ Its tag, as `lib/v1.2.3`.
46
46
 
47
47
  > `readonly` **version**: `string`
48
48
 
49
- Defined in: [packages/release-go/src/tags.ts:206](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L206)
49
+ Defined in: [packages/release-go/src/tags.ts:230](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L230)
50
50
 
51
51
  The version of the release, of the module.
@@ -0,0 +1,22 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-go/tags](../README.md) / TagsContext
6
+
7
+ # Interface: TagsContext
8
+
9
+ Defined in: [packages/release-go/src/tags.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L97)
10
+
11
+ Where a release of tags runs git: the platform, whose working folder, `dirs.cwd`, is the folder of
12
+ the repo, and which makes the temporary folder of the index of a release commit.
13
+
14
+ ## Properties
15
+
16
+ ### platform
17
+
18
+ > `readonly` **platform**: [`ReleasePlatform`](../../../release/type-aliases/ReleasePlatform.md)
19
+
20
+ Defined in: [packages/release-go/src/tags.ts:99](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L99)
21
+
22
+ The platform git runs by, a release's.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > **ModuleStatus** = `"tagged"` \| `"skipped"`
10
10
 
11
- Defined in: [packages/release-go/src/tags.ts:199](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/tags.ts#L199)
11
+ Defined in: [packages/release-go/src/tags.ts:223](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/tags.ts#L223)
12
12
 
13
13
  What happened to a module of the release.
@@ -6,14 +6,17 @@
6
6
 
7
7
  # @wtf/release-maven
8
8
 
9
- The modules of a Maven repo released in trains, of no release tool. Its default export is the
10
- ecosystem of Maven, `mavenEcosystem` of `./ecosystem`, which a config of the trains names in
11
- `ecosystems` as `'@wtf/release-maven'`, so the trains read the modules of the repo by it; and this
12
- module holds the types of the modules, which the modules of this package do with: each pom.xml
13
- read by a small reader of XML (`./pom`), the modules of a train in the order they deploy in
14
- (`./artifacts`), the versions of the trains written into the poms (`./stamp`), where a repository
15
- serves a pom (`./repository`), and each module it lacks deployed (`./publish`). Each function
16
- takes the `System` it runs by, and runs `git` and `mvn` through it.
9
+ The modules of a Maven repo released, of no release tool and of no train. Its default export is
10
+ the ecosystem of Maven, `mavenEcosystem` of `./ecosystem`, which a config names in `ecosystems` as
11
+ `'@wtf/release-maven'`, and a `ReleasingEcosystem` of `@wtf/release/contract`: it reads the
12
+ modules of the repo, and releases the modules of the plan its caller gives it, in the steps
13
+ `verify`, `prepare` and `publish`. This module holds the types of the modules, which the modules
14
+ of this package do with: each pom.xml read by a small reader of XML (`./pom`), the modules of a
15
+ release in the order they deploy in (`./artifacts`), the versions of a release written into the
16
+ poms (`./stamp`), where a repository serves a pom (`./repository`), and each module it lacks
17
+ deployed (`./publish`). Each function takes what it runs by of the folder of the repo, a handle of
18
+ the File System standard, whose poms it reads and writes, and of the platform, of that folder as
19
+ its working folder, by which it runs `git` and `mvn`, and asks a repository.
17
20
 
18
21
  ```ts
19
22
  import type { MavenModule } from '@wtf/release-maven'
@@ -9,16 +9,21 @@
9
9
  The modules of a Maven repo: [readPoms](functions/readPoms.md) reads each pom.xml git tracks, of the working tree
10
10
  or of a commit; [modulesOf](functions/modulesOf.md) makes the modules of them, each of what it inherits of its
11
11
  parents in the repo and of its dependencies on the other modules; [selectArtifacts](functions/selectArtifacts.md) takes
12
- those a release of a train deploys; and [publishOrder](functions/publishOrder.md) puts them in the order of their
13
- dependencies, each after the modules it depends on, as a repository needs them deployed.
12
+ those a release deploys, of the modules it is of, as a train's; [installsOf](functions/installsOf.md) those it
13
+ installs; and [publishOrder](functions/publishOrder.md) puts them in the order of their dependencies, each after the
14
+ modules it depends on, as a repository needs them deployed. A caller makes the `own` of the plan
15
+ of a release of them.
14
16
 
15
17
  ```ts
18
+ import type { EcosystemContext } from '@wtf/release/ecosystem'
16
19
  import { publishOrder, readModules, selectArtifacts } from '@wtf/release-maven/artifacts'
17
- import type { System } from '@wtf/release-system'
18
20
 
19
- // The names of the modules a release of the train of `train` deploys, in order.
20
- export async function names(system: System, train: ReadonlySet<string>): Promise<string[]> {
21
- const modules = await readModules({ system })
21
+ // The names of the modules a release of the modules of `train` deploys, in order.
22
+ export async function names(
23
+ repo: EcosystemContext,
24
+ train: ReadonlySet<string>
25
+ ): Promise<string[]> {
26
+ const modules = await readModules(repo)
22
27
  return publishOrder(selectArtifacts(modules, { train })).map(({ name }) => name)
23
28
  }
24
29
  ```
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **groupIdOf**(`groupId`, `own`): `string` \| `undefined`
10
10
 
11
- Defined in: [packages/release-maven/src/artifacts.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-maven/src/artifacts.ts#L85)
11
+ Defined in: [packages/release-maven/src/artifacts.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-maven/src/artifacts.ts#L88)
12
12
 
13
13
  A groupId as a pom writes it, of `${project.groupId}` read as the groupId of the module.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **installsOf**(`modules`, `release`, `served`): [`MavenModule`](../../interfaces/MavenModule.md)[]
10
10
 
11
- Defined in: [packages/release-maven/src/artifacts.ts:373](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-maven/src/artifacts.ts#L373)
11
+ Defined in: [packages/release-maven/src/artifacts.ts:376](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-maven/src/artifacts.ts#L376)
12
12
 
13
13
  The modules of the repo a release installs before it deploys, as `mvn` of one module finds the
14
14
  modules it depends on in the local repository, or in the remote one: each module the modules of
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isPomFile**(`file`): `boolean`
10
10
 
11
- Defined in: [packages/release-maven/src/artifacts.ts:41](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-maven/src/artifacts.ts#L41)
11
+ Defined in: [packages/release-maven/src/artifacts.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-maven/src/artifacts.ts#L47)
12
12
 
13
13
  Whether `file` is the pom of a module: a `pom.xml` in no `src` or `target` folder, as the fixtures
14
14
  of the tests of a plugin and the output of a build are.