@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,12 +6,12 @@
6
6
 
7
7
  # @wtf/release-cargo/stamp
8
8
 
9
- The versions of the trains written into the manifests of a workspace, by a line editor that reads
9
+ The versions of a plan written into the manifests of a workspace, by a line editor that reads
10
10
  the headers of the tables and the keys of the lines that matter, and no TOML parser: a parser
11
11
  writes the file again, and loses the comments and the layout of a manifest that people edit,
12
- which a release commit would then change. Each crate takes the version of its train: of the train
13
- of the release, the release's; of another train, its last release (`releasedVersions` of
14
- `@wtf/release-trains/packages`). What it writes:
12
+ which a release commit would then change. Each crate takes its version of `versions` of the plan
13
+ of the release (`Plan` of `@wtf/release/contract`): of a crate of the release, the release's; of
14
+ another, the last release of its own, as of another train. What it writes:
15
15
 
16
16
  - `version = "…"` of `[package]` of each crate that takes a version, and of `[workspace.package]`
17
17
  of the root manifest, the version of the crates that inherit it (`version.workspace = true`),
@@ -22,7 +22,7 @@ of the release, the release's; of another train, its last release (`releasedVers
22
22
  of a table of its own (`[dependencies.name]`): one that has none gets it, but a dev-dependency,
23
23
  which cargo drops of a package when it has none. Every manifest of the workspace is written, so
24
24
  the workspace still resolves: a dependency on a crate at a path is of the version of that crate.
25
- A dependency on a crate that takes no version, of no train or of a train with no release, is
25
+ A dependency on a crate that takes no version, as of no train or of a train with no release, is
26
26
  left, as its crate is.
27
27
 
28
28
  A manifest is the same after as before, but those values: `version.workspace = true` and
@@ -47,6 +47,7 @@ console.log(text)
47
47
  - [Stamped](interfaces/Stamped.md)
48
48
  - [StampedWorkspace](interfaces/StampedWorkspace.md)
49
49
  - [StampOptions](interfaces/StampOptions.md)
50
+ - [StampWorkspaceOptions](interfaces/StampWorkspaceOptions.md)
50
51
 
51
52
  ## Functions
52
53
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **checkVersions**(`crates`, `versions`): `void`
10
10
 
11
- Defined in: [packages/release-cargo/src/stamp.ts:526](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/stamp.ts#L526)
11
+ Defined in: [packages/release-cargo/src/stamp.ts:543](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L543)
12
12
 
13
13
  The crates that are not at the version they take, of their manifests read again by
14
14
  `cargo metadata`: what a stamp left wrong, as a crate that sets its version where this module
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **inheritsVersion**(`text`): `boolean`
10
10
 
11
- Defined in: [packages/release-cargo/src/stamp.ts:395](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/stamp.ts#L395)
11
+ Defined in: [packages/release-cargo/src/stamp.ts:403](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L403)
12
12
 
13
13
  Whether the manifest `text` takes the version of its `[package]` of the workspace:
14
14
  `version.workspace = true`, or `version = { workspace = true }`.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **stampManifest**(`text`, `options`, `file?`): [`Stamped`](../interfaces/Stamped.md)
10
10
 
11
- Defined in: [packages/release-cargo/src/stamp.ts:364](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/stamp.ts#L364)
11
+ Defined in: [packages/release-cargo/src/stamp.ts:366](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L366)
12
12
 
13
13
  The manifest `text` with the versions written, as the module says: the comments, the order and
14
14
  the layout of the file are as they were. Idempotent: stamped twice, the second changes nothing.
@@ -6,23 +6,26 @@
6
6
 
7
7
  # Function: stampWorkspace()
8
8
 
9
- > **stampWorkspace**(`system`, `workspace`, `versions`): `Promise`\<[`StampedWorkspace`](../interfaces/StampedWorkspace.md)\>
9
+ > **stampWorkspace**(`root`, `workspace`, `versions`, `options?`): `Promise`\<[`StampedWorkspace`](../interfaces/StampedWorkspace.md)\>
10
10
 
11
- Defined in: [packages/release-cargo/src/stamp.ts:471](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/stamp.ts#L471)
11
+ Defined in: [packages/release-cargo/src/stamp.ts:483](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L483)
12
12
 
13
13
  Writes `versions` into the manifests of `workspace`, as the module says: of each crate that takes
14
14
  a version, its `[package]`, and each dependency on it, of every crate of the workspace and of
15
15
  `[workspace.dependencies]`; and `[workspace.package]` of the root, of the version of the crates
16
16
  that inherit it. A crate that takes no version, as of no train, keeps its own, and the
17
- dependencies on it are left. A file of no change is not written.
17
+ dependencies on it are left. A file of no change is not written, and of a dry run none is. Each
18
+ manifest is read and written of `root`, the folder of the workspace, by its path from the folder
19
+ of the root manifest.
18
20
 
19
21
  ## Parameters
20
22
 
21
- ### system
23
+ ### root
22
24
 
23
- [`System`](../../../release-system/system/interfaces/System.md)
25
+ `FileSystemDirectoryHandle`
24
26
 
25
- The system the manifests are read and written by.
27
+ The folder of the workspace, the one its root Cargo.toml is in: the folder of the
28
+ repo, of a workspace at its root.
26
29
 
27
30
  ### workspace
28
31
 
@@ -34,15 +37,21 @@ The workspace, as `readWorkspace` of `./crates` gives it.
34
37
 
35
38
  `ReadonlyMap`\<`string`, `string`\>
36
39
 
37
- The version each crate takes, by its name: of the crates of the train of the
38
- release, the release's, and of each other train's, its last release (`releasedVersions` of
39
- `@wtf/release-trains/packages`).
40
+ The version each crate takes, by its name, as `versions` of the plan of the
41
+ release: of the crates of the release, the release's, and of each other, the last release of its
42
+ own.
43
+
44
+ ### options?
45
+
46
+ [`StampWorkspaceOptions`](../interfaces/StampWorkspaceOptions.md) = `{}`
47
+
48
+ Whether it writes nothing, of a dry run.
40
49
 
41
50
  ## Returns
42
51
 
43
52
  `Promise`\<[`StampedWorkspace`](../interfaces/StampedWorkspace.md)\>
44
53
 
45
- The manifests written, and how many values.
54
+ The manifests written, or that a dry run would write, and how many values.
46
55
 
47
56
  ## Throws
48
57
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: StampOptions
8
8
 
9
- Defined in: [packages/release-cargo/src/stamp.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/stamp.ts#L47)
9
+ Defined in: [packages/release-cargo/src/stamp.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L49)
10
10
 
11
11
  What to write into a manifest.
12
12
 
@@ -16,7 +16,7 @@ What to write into a manifest.
16
16
 
17
17
  > `readonly` **package**: `string` \| `undefined`
18
18
 
19
- Defined in: [packages/release-cargo/src/stamp.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/stamp.ts#L54)
19
+ Defined in: [packages/release-cargo/src/stamp.ts:56](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L56)
20
20
 
21
21
  The version of its `[package]`, of the manifest of a crate that takes one: none, it is left.
22
22
 
@@ -26,7 +26,7 @@ The version of its `[package]`, of the manifest of a crate that takes one: none,
26
26
 
27
27
  > `readonly` **versions**: `ReadonlyMap`\<`string`, `string`\>
28
28
 
29
- Defined in: [packages/release-cargo/src/stamp.ts:52](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/stamp.ts#L52)
29
+ Defined in: [packages/release-cargo/src/stamp.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L54)
30
30
 
31
31
  The version of each dependency on a crate that takes one, by the key of its table: the name of
32
32
  the crate, or a rename of it.
@@ -37,6 +37,6 @@ the crate, or a rename of it.
37
37
 
38
38
  > `readonly` **workspace**: `string` \| `undefined`
39
39
 
40
- Defined in: [packages/release-cargo/src/stamp.ts:56](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/stamp.ts#L56)
40
+ Defined in: [packages/release-cargo/src/stamp.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L58)
41
41
 
42
42
  The version of `[workspace.package]`, of the root manifest: none, it is left.
@@ -0,0 +1,21 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-cargo/stamp](../README.md) / StampWorkspaceOptions
6
+
7
+ # Interface: StampWorkspaceOptions
8
+
9
+ Defined in: [packages/release-cargo/src/stamp.ts:383](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L383)
10
+
11
+ What [stampWorkspace](../functions/stampWorkspace.md) takes besides the workspace and the versions.
12
+
13
+ ## Properties
14
+
15
+ ### dryRun?
16
+
17
+ > `readonly` `optional` **dryRun?**: `boolean`
18
+
19
+ Defined in: [packages/release-cargo/src/stamp.ts:385](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L385)
20
+
21
+ Whether it writes nothing, and gives the manifests it would write: `false` by default.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Stamped
8
8
 
9
- Defined in: [packages/release-cargo/src/stamp.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/stamp.ts#L60)
9
+ Defined in: [packages/release-cargo/src/stamp.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L62)
10
10
 
11
11
  A manifest stamped, and how many values it wrote.
12
12
 
@@ -16,7 +16,7 @@ A manifest stamped, and how many values it wrote.
16
16
 
17
17
  > `readonly` **changes**: `number`
18
18
 
19
- Defined in: [packages/release-cargo/src/stamp.ts:64](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/stamp.ts#L64)
19
+ Defined in: [packages/release-cargo/src/stamp.ts:66](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L66)
20
20
 
21
21
  The values that were another, or not there, and are of the versions now.
22
22
 
@@ -26,6 +26,6 @@ The values that were another, or not there, and are of the versions now.
26
26
 
27
27
  > `readonly` **text**: `string`
28
28
 
29
- Defined in: [packages/release-cargo/src/stamp.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/stamp.ts#L62)
29
+ Defined in: [packages/release-cargo/src/stamp.ts:64](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L64)
30
30
 
31
31
  The manifest, the versions written.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: StampedWorkspace
8
8
 
9
- Defined in: [packages/release-cargo/src/stamp.ts:381](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/stamp.ts#L381)
9
+ Defined in: [packages/release-cargo/src/stamp.ts:389](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L389)
10
10
 
11
11
  The result of stamping a workspace: the manifests written, and the values in them.
12
12
 
@@ -16,7 +16,7 @@ The result of stamping a workspace: the manifests written, and the values in the
16
16
 
17
17
  > `readonly` **changes**: `number`
18
18
 
19
- Defined in: [packages/release-cargo/src/stamp.ts:385](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/stamp.ts#L385)
19
+ Defined in: [packages/release-cargo/src/stamp.ts:393](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L393)
20
20
 
21
21
  The values written.
22
22
 
@@ -26,6 +26,6 @@ The values written.
26
26
 
27
27
  > `readonly` **files**: readonly `string`[]
28
28
 
29
- Defined in: [packages/release-cargo/src/stamp.ts:383](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/stamp.ts#L383)
29
+ Defined in: [packages/release-cargo/src/stamp.ts:391](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/stamp.ts#L391)
30
30
 
31
- The manifests whose text changed, absolute.
31
+ The manifests whose text changed, or would change of a dry run, absolute.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > **DependencyKind** = `"normal"` \| `"build"` \| `"dev"`
10
10
 
11
- Defined in: [packages/release-cargo/src/index.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/index.ts#L24)
11
+ Defined in: [packages/release-cargo/src/index.ts:27](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/index.ts#L27)
12
12
 
13
13
  How a crate depends on another: the dependencies of its build and its run, or its tests'.
@@ -6,15 +6,17 @@
6
6
 
7
7
  # @wtf/release-go
8
8
 
9
- The Go modules of a repo released in trains, of no release tool. Its default export is the
10
- ecosystem of Go, `goEcosystem` of `./ecosystem`, which a config of the trains names in
11
- `ecosystems` as `'@wtf/release-go'`, so the trains read the modules of the repo by it; and this
12
- module holds the type of a module, which the modules of this package do with: each go.mod of the
13
- repo, read, selected and checked against the major of a release (`./modules`), the line reader of
14
- a go.mod (`./gomod`), the versions of the trains written into each `require` (`./stamp`), and the
15
- tags of a release, on a commit of the stamped go.mod files, pushed to the remote and asked of the
16
- Go proxy (`./tags`). Each function takes the `System` it runs by, and runs `git` and `go` through
17
- it.
9
+ The Go modules of a repo released, of no release tool and of no train. Its default export is the
10
+ ecosystem of Go, `goEcosystem` of `./ecosystem`, a `ReleasingEcosystem` of
11
+ `@wtf/release/contract` of the options [GoOptions](interfaces/GoOptions.md): the read side, which a config names in
12
+ `ecosystems` as `'@wtf/release-go'`, and the steps of a release of the modules of the plan it is
13
+ given (`./release`). This module holds the types the modules of this package do with: each go.mod
14
+ of the repo, read, selected and checked against the major of a release (`./modules`), the line
15
+ reader of a go.mod (`./gomod`), the versions of the plan written into each `require`
16
+ (`./stamp`), and the tags of a release, on a commit of the stamped go.mod files, pushed to the
17
+ remote and asked of the Go proxy (`./tags`). Each function that runs `git` or `go` takes the
18
+ platform it runs by, of the folder of the repo as its working folder, and one that reads or writes
19
+ the go.mod files the folder of the repo, a handle of the File System standard.
18
20
 
19
21
  ```ts
20
22
  import type { GoModule } from '@wtf/release-go'
@@ -25,7 +27,9 @@ export const pathsOf = (modules: readonly GoModule[]): string[] => modules.map((
25
27
 
26
28
  ## Interfaces
27
29
 
30
+ - [GoIdentity](interfaces/GoIdentity.md)
28
31
  - [GoModule](interfaces/GoModule.md)
32
+ - [GoOptions](interfaces/GoOptions.md)
29
33
 
30
34
  ## References
31
35
 
@@ -6,12 +6,19 @@
6
6
 
7
7
  # @wtf/release-go/ecosystem
8
8
 
9
- The ecosystem of Go ([goEcosystem](variables/goEcosystem.md)), as the trains read it, and the default export of the
10
- package, which a config names in `ecosystems` as `'@wtf/release-go'`: the modules of the repo,
11
- each go.mod git tracks ([packagesOfModules](functions/packagesOfModules.md)), of the working tree or of a commit; a repo of
12
- no go.mod has none. A requirement of Go is a version, which minimal version selection reads as
13
- that version or a later one of the same major ([satisfiesVersion](functions/satisfiesVersion.md)); a release publishes the
14
- version itself, of a `v` ([resolveVersion](functions/resolveVersion.md)).
9
+ The ecosystem of Go ([goEcosystem](variables/goEcosystem.md)), a `ReleasingEcosystem` of `@wtf/release/contract`, and
10
+ the default export of the package, which a config names in `ecosystems` as `'@wtf/release-go'`.
11
+ Its read side: the modules of the repo, each go.mod git tracks ([packagesOfModules](functions/packagesOfModules.md)), of the
12
+ working tree or of a commit; a repo of no go.mod has none. A requirement of Go is a version, which
13
+ minimal version selection reads as that version or a later one of the same major
14
+ ([satisfiesVersion](functions/satisfiesVersion.md)); a release publishes the version itself, of a `v`
15
+ ([resolveVersion](functions/resolveVersion.md)). Its steps, of `./release`, each over the plan it is given:
16
+
17
+ | Step | What it does |
18
+ | --------- | -------------------------------------------------------------------------------- |
19
+ | `verify` | selects the modules to tag, and checks the version and the major of each path |
20
+ | `prepare` | writes the versions of the plan into each require of every go.mod, and checks it |
21
+ | `publish` | tags a commit of the stamped go.mod files, pushes the tags, and asks the proxy |
15
22
 
16
23
  ```js
17
24
  // release.config.mjs
@@ -8,9 +8,9 @@
8
8
 
9
9
  > **packagesOfModules**(`modules`): [`GoPackage`](../interfaces/GoPackage.md)[]
10
10
 
11
- Defined in: [packages/release-go/src/ecosystem.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/ecosystem.ts#L49)
11
+ Defined in: [packages/release-go/src/ecosystem.ts:53](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/ecosystem.ts#L53)
12
12
 
13
- The modules of the repo as the trains read them: each a package named by its module path, of its
13
+ The modules of the repo as a release reads them: each a package named by its module path, of its
14
14
  folder and its go.mod; published when Go can fetch it, as the first element of its path has a dot
15
15
  (`isFetchable` of `./modules`); and each `require` of another module of the repo a dependency of
16
16
  the kind `runtime`, Go's one kind, of the version it writes as its range.
@@ -8,18 +8,18 @@
8
8
 
9
9
  > **packagesOfRepo**(`context`): `Promise`\<[`GoPackage`](../interfaces/GoPackage.md)[]\>
10
10
 
11
- Defined in: [packages/release-go/src/ecosystem.ts:104](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/ecosystem.ts#L104)
11
+ Defined in: [packages/release-go/src/ecosystem.ts:108](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/ecosystem.ts#L108)
12
12
 
13
- The modules of the repo of `context` as the trains read them, of the commit `ref` where it names
13
+ The modules of the repo of `context` as a release reads them, of the commit `ref` where it names
14
14
  one, else of the working tree.
15
15
 
16
16
  ## Parameters
17
17
 
18
18
  ### context
19
19
 
20
- [`EcosystemContext`](../../../release-trains/ecosystem/interfaces/EcosystemContext.md)
20
+ [`EcosystemContext`](../../../release/ecosystem/interfaces/EcosystemContext.md)
21
21
 
22
- The folder of the repo, its environment, the system, and the commit.
22
+ The folder of the repo, the platform git runs by, and the commit.
23
23
 
24
24
  ## Returns
25
25
 
@@ -8,9 +8,9 @@
8
8
 
9
9
  > **resolveVersion**(`_requirement`, `version`): `string`
10
10
 
11
- Defined in: [packages/release-go/src/ecosystem.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/ecosystem.ts#L78)
11
+ Defined in: [packages/release-go/src/ecosystem.ts:82](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/ecosystem.ts#L82)
12
12
 
13
- The version a release requires of a module of `version`, the release of its train, as the stamp
13
+ The version a release requires of a module of `version`, its release, as the stamp
14
14
  writes it into each `require` of it: `v1.4.0` of `1.4.0`. The stamp writes it whatever the
15
15
  requirement was, so `requirement` names none of it.
16
16
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **satisfiesVersion**(`requirement`, `version`): `boolean`
10
10
 
11
- Defined in: [packages/release-go/src/ecosystem.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/ecosystem.ts#L89)
11
+ Defined in: [packages/release-go/src/ecosystem.ts:93](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/ecosystem.ts#L93)
12
12
 
13
13
  Whether `version` is within `requirement`, by Go's minimal version selection: of the major the
14
14
  requirement names, and the same or later, prereleases by the order of semver, as `1.5.0-beta.1`
@@ -6,27 +6,27 @@
6
6
 
7
7
  # Interface: GoPackage
8
8
 
9
- Defined in: [packages/release-go/src/ecosystem.ts:35](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/ecosystem.ts#L35)
9
+ Defined in: [packages/release-go/src/ecosystem.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/ecosystem.ts#L39)
10
10
 
11
- A module as the trains read it: a package of the trains, and the module it is of.
11
+ A module as a release reads it: a package of its ecosystem, and the module it is of.
12
12
 
13
13
  ## Extends
14
14
 
15
- - [`Package`](../../../release-trains/ecosystem/interfaces/Package.md)
15
+ - [`Package`](../../../release/ecosystem/interfaces/Package.md)
16
16
 
17
17
  ## Properties
18
18
 
19
19
  ### dependencies
20
20
 
21
- > `readonly` **dependencies**: readonly [`Dependency`](../../../release-trains/ecosystem/interfaces/Dependency.md)[]
21
+ > `readonly` **dependencies**: readonly [`Dependency`](../../../release/ecosystem/interfaces/Dependency.md)[]
22
22
 
23
- Defined in: [packages/release-trains/src/ecosystem.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-trains/src/ecosystem.ts#L76)
23
+ Defined in: [packages/release/src/ecosystem.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L74)
24
24
 
25
25
  Its dependencies on the other packages of its ecosystem in the repo.
26
26
 
27
27
  #### Inherited from
28
28
 
29
- [`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`dependencies`](../../../release-trains/ecosystem/interfaces/Package.md#dependencies)
29
+ [`Package`](../../../release/ecosystem/interfaces/Package.md).[`dependencies`](../../../release/ecosystem/interfaces/Package.md#dependencies)
30
30
 
31
31
  ***
32
32
 
@@ -34,14 +34,14 @@ Its dependencies on the other packages of its ecosystem in the repo.
34
34
 
35
35
  > `readonly` **dir**: `string`
36
36
 
37
- Defined in: [packages/release-trains/src/ecosystem.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-trains/src/ecosystem.ts#L67)
37
+ Defined in: [packages/release/src/ecosystem.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L65)
38
38
 
39
- Its folder, from the root of the repo, as `packages/core`; `.` of the root. A train holds it
40
- when the train's `paths` hold this folder.
39
+ Its folder, from the root of the repo, as `packages/core`; `.` of the root. A part of the repo,
40
+ as a train, holds it when its paths hold this folder.
41
41
 
42
42
  #### Inherited from
43
43
 
44
- [`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`dir`](../../../release-trains/ecosystem/interfaces/Package.md#dir)
44
+ [`Package`](../../../release/ecosystem/interfaces/Package.md).[`dir`](../../../release/ecosystem/interfaces/Package.md#dir)
45
45
 
46
46
  ***
47
47
 
@@ -49,13 +49,13 @@ when the train's `paths` hold this folder.
49
49
 
50
50
  > `readonly` **manifest**: `string`
51
51
 
52
- Defined in: [packages/release-trains/src/ecosystem.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-trains/src/ecosystem.ts#L69)
52
+ Defined in: [packages/release/src/ecosystem.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L67)
53
53
 
54
54
  Its manifest, from the root of the repo, as `packages/core/package.json`.
55
55
 
56
56
  #### Inherited from
57
57
 
58
- [`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`manifest`](../../../release-trains/ecosystem/interfaces/Package.md#manifest)
58
+ [`Package`](../../../release/ecosystem/interfaces/Package.md).[`manifest`](../../../release/ecosystem/interfaces/Package.md#manifest)
59
59
 
60
60
  ***
61
61
 
@@ -63,7 +63,7 @@ Its manifest, from the root of the repo, as `packages/core/package.json`.
63
63
 
64
64
  > `readonly` **module**: [`GoModule`](../../interfaces/GoModule.md)
65
65
 
66
- Defined in: [packages/release-go/src/ecosystem.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/ecosystem.ts#L37)
66
+ Defined in: [packages/release-go/src/ecosystem.ts:41](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/ecosystem.ts#L41)
67
67
 
68
68
  The module, as `readModules` of `./modules` gives it.
69
69
 
@@ -73,13 +73,13 @@ The module, as `readModules` of `./modules` gives it.
73
73
 
74
74
  > `readonly` **name**: `string`
75
75
 
76
- Defined in: [packages/release-trains/src/ecosystem.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-trains/src/ecosystem.ts#L62)
76
+ Defined in: [packages/release/src/ecosystem.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L60)
77
77
 
78
78
  Its name, the one its ecosystem's registry knows it by: unique of the ecosystem in the repo.
79
79
 
80
80
  #### Inherited from
81
81
 
82
- [`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`name`](../../../release-trains/ecosystem/interfaces/Package.md#name)
82
+ [`Package`](../../../release/ecosystem/interfaces/Package.md).[`name`](../../../release/ecosystem/interfaces/Package.md#name)
83
83
 
84
84
  ***
85
85
 
@@ -87,11 +87,11 @@ Its name, the one its ecosystem's registry knows it by: unique of the ecosystem
87
87
 
88
88
  > `readonly` **published**: `boolean`
89
89
 
90
- Defined in: [packages/release-trains/src/ecosystem.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-trains/src/ecosystem.ts#L74)
90
+ Defined in: [packages/release/src/ecosystem.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L72)
91
91
 
92
92
  Whether a release publishes it: not of an npm package that is private, nor of a crate of
93
93
  `publish = false`.
94
94
 
95
95
  #### Inherited from
96
96
 
97
- [`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`published`](../../../release-trains/ecosystem/interfaces/Package.md#published)
97
+ [`Package`](../../../release/ecosystem/interfaces/Package.md).[`published`](../../../release/ecosystem/interfaces/Package.md#published)
@@ -6,10 +6,13 @@
6
6
 
7
7
  # Variable: goEcosystem
8
8
 
9
- > `const` **goEcosystem**: [`Ecosystem`](../../../release-trains/ecosystem/interfaces/Ecosystem.md)
9
+ > `const` **goEcosystem**: [`ReleasingEcosystem`](../../../release/contract/type-aliases/ReleasingEcosystem.md)\<[`GoOptions`](../../interfaces/GoOptions.md), [`GoPackage`](../interfaces/GoPackage.md), `"verify"` \| `"prepare"`\>
10
10
 
11
- Defined in: [packages/release-go/src/ecosystem.ts:115](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/ecosystem.ts#L115)
11
+ Defined in: [packages/release-go/src/ecosystem.ts:122](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/ecosystem.ts#L122)
12
12
 
13
13
  The ecosystem of Go: its packages, the modules of the repo, of the working tree or of a commit
14
14
  ([packagesOfRepo](../functions/packagesOfRepo.md)); a requirement published as the stamp writes it
15
- ([resolveVersion](../functions/resolveVersion.md)); and Go's rules of requirements ([satisfiesVersion](../functions/satisfiesVersion.md)).
15
+ ([resolveVersion](../functions/resolveVersion.md)); Go's rules of requirements ([satisfiesVersion](../functions/satisfiesVersion.md)); and the steps of
16
+ a release of its modules, of the options `GoOptions` of the root of the package: `verify`
17
+ (`verifyModules` of `./release`), `prepare` (`prepareModules`) and `publish` (`publishModules`).
18
+ It has no `move`, as Go has no moving name of a version.
@@ -6,11 +6,10 @@
6
6
 
7
7
  # @wtf/release-go/errors
8
8
 
9
- What the release of Go modules throws: [GoError](classes/GoError.md), a `ReleaseError` of
10
- `@wtf/release-system/errors` of the codes of [GO\_ERRORS](variables/GO_ERRORS.md), which semantic-release prints by
11
- its mark, beside the codes of the options of a plugin, its `SYSTEM_ERRORS` (`EOPTIONS`). What is
12
- the same of every ecosystem, as a dependency on a module of no train or of a train with no
13
- release, is the trains' own, `TRAINS_ERRORS` of `@wtf/release-trains/errors`.
9
+ What the release of Go modules throws: [GoError](classes/GoError.md), a `ReleaseError` of `@wtf/release/errors`
10
+ of the codes of [GO\_ERRORS](variables/GO_ERRORS.md), beside the codes of the options of a plugin, its
11
+ `RELEASE_ERRORS` (`EOPTIONS`). What is the same of every ecosystem, as a dependency on a module
12
+ the plan gives no version, is its driver's own, as the plan of a train is the trains'.
14
13
 
15
14
  ## Classes
16
15