@wtf/release-docs 8.1.0 → 8.2.1

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 (606) hide show
  1. package/README.md +12 -4
  2. package/api/.generated +155 -29
  3. package/api/@wtf/release-cargo/auth/functions/mask.md +1 -1
  4. package/api/@wtf/release-cargo/auth/functions/tokenVariableOf.md +1 -1
  5. package/api/@wtf/release-cargo/auth/functions/trustedPublishing.md +1 -1
  6. package/api/@wtf/release-cargo/auth/interfaces/HttpResponse.md +5 -5
  7. package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishing.md +5 -5
  8. package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishingOptions.md +6 -6
  9. package/api/@wtf/release-cargo/auth/type-aliases/HttpFetch.md +1 -1
  10. package/api/@wtf/release-cargo/auth/variables/CRATES_IO_API.md +1 -1
  11. package/api/@wtf/release-cargo/auth/variables/ID_TOKEN_VARIABLE.md +1 -1
  12. package/api/@wtf/release-cargo/auth/variables/USER_AGENT.md +1 -1
  13. package/api/@wtf/release-cargo/crates/functions/publishOrder.md +1 -1
  14. package/api/@wtf/release-cargo/crates/functions/publishable.md +1 -1
  15. package/api/@wtf/release-cargo/crates/functions/readWorkspace.md +1 -1
  16. package/api/@wtf/release-cargo/crates/functions/selectCrates.md +5 -4
  17. package/api/@wtf/release-cargo/crates/interfaces/Selection.md +5 -5
  18. package/api/@wtf/release-cargo/ecosystem/functions/packagesAt.md +1 -1
  19. package/api/@wtf/release-cargo/ecosystem/functions/packagesOfTree.md +1 -1
  20. package/api/@wtf/release-cargo/ecosystem/functions/packagesOfWorkspace.md +1 -1
  21. package/api/@wtf/release-cargo/ecosystem/functions/resolveRequirement.md +1 -1
  22. package/api/@wtf/release-cargo/ecosystem/functions/satisfiesRequirement.md +1 -1
  23. package/api/@wtf/release-cargo/ecosystem/functions/semverRange.md +1 -1
  24. package/api/@wtf/release-cargo/ecosystem/interfaces/CargoPackage.md +7 -7
  25. package/api/@wtf/release-cargo/ecosystem/variables/cargoEcosystem.md +1 -1
  26. package/api/@wtf/release-cargo/errors/classes/CargoError.md +5 -5
  27. package/api/@wtf/release-cargo/errors/type-aliases/CargoErrorCode.md +1 -1
  28. package/api/@wtf/release-cargo/errors/variables/CARGO_ERRORS.md +2 -2
  29. package/api/@wtf/release-cargo/interfaces/Crate.md +6 -6
  30. package/api/@wtf/release-cargo/interfaces/CrateDependency.md +6 -6
  31. package/api/@wtf/release-cargo/interfaces/Workspace.md +3 -3
  32. package/api/@wtf/release-cargo/publish/functions/publishCrates.md +1 -1
  33. package/api/@wtf/release-cargo/publish/interfaces/PublishCratesOptions.md +11 -11
  34. package/api/@wtf/release-cargo/publish/interfaces/PublishedCrate.md +5 -5
  35. package/api/@wtf/release-cargo/publish/type-aliases/CrateStatus.md +1 -1
  36. package/api/@wtf/release-cargo/publish/variables/RECHECK_WAITS.md +1 -1
  37. package/api/@wtf/release-cargo/registry/functions/crateUrl.md +1 -1
  38. package/api/@wtf/release-cargo/registry/functions/indexHasVersion.md +1 -1
  39. package/api/@wtf/release-cargo/registry/functions/indexPath.md +1 -1
  40. package/api/@wtf/release-cargo/registry/variables/CRATES_IO_INDEX.md +1 -1
  41. package/api/@wtf/release-cargo/stamp/functions/checkVersions.md +1 -1
  42. package/api/@wtf/release-cargo/stamp/functions/inheritsVersion.md +1 -1
  43. package/api/@wtf/release-cargo/stamp/functions/stampManifest.md +1 -1
  44. package/api/@wtf/release-cargo/stamp/functions/stampWorkspace.md +1 -1
  45. package/api/@wtf/release-cargo/stamp/interfaces/StampOptions.md +4 -4
  46. package/api/@wtf/release-cargo/stamp/interfaces/Stamped.md +3 -3
  47. package/api/@wtf/release-cargo/stamp/interfaces/StampedWorkspace.md +3 -3
  48. package/api/@wtf/release-cargo/type-aliases/DependencyKind.md +1 -1
  49. package/api/@wtf/release-go/README.md +34 -0
  50. package/api/@wtf/release-go/ecosystem/README.md +40 -0
  51. package/api/@wtf/release-go/ecosystem/functions/packagesOfModules.md +30 -0
  52. package/api/@wtf/release-go/ecosystem/functions/packagesOfRepo.md +32 -0
  53. package/api/@wtf/release-go/ecosystem/functions/resolveVersion.md +35 -0
  54. package/api/@wtf/release-go/ecosystem/functions/satisfiesVersion.md +35 -0
  55. package/api/@wtf/release-go/ecosystem/interfaces/GoPackage.md +97 -0
  56. package/api/@wtf/release-go/ecosystem/variables/goEcosystem.md +15 -0
  57. package/api/@wtf/release-go/errors/README.md +25 -0
  58. package/api/@wtf/release-go/errors/classes/GoError.md +268 -0
  59. package/api/@wtf/release-go/errors/type-aliases/GoErrorCode.md +13 -0
  60. package/api/@wtf/release-go/errors/variables/GO_ERRORS.md +47 -0
  61. package/api/@wtf/release-go/gomod/README.md +39 -0
  62. package/api/@wtf/release-go/gomod/functions/entriesOf.md +29 -0
  63. package/api/@wtf/release-go/gomod/functions/linesOf.md +27 -0
  64. package/api/@wtf/release-go/gomod/functions/readGoMod.md +28 -0
  65. package/api/@wtf/release-go/gomod/functions/tokensOf.md +29 -0
  66. package/api/@wtf/release-go/gomod/interfaces/Entry.md +41 -0
  67. package/api/@wtf/release-go/gomod/interfaces/GoMod.md +41 -0
  68. package/api/@wtf/release-go/gomod/interfaces/GoReplace.md +61 -0
  69. package/api/@wtf/release-go/gomod/interfaces/GoRequire.md +41 -0
  70. package/api/@wtf/release-go/gomod/interfaces/Token.md +51 -0
  71. package/api/@wtf/release-go/interfaces/GoModule.md +61 -0
  72. package/api/@wtf/release-go/modules/README.md +39 -0
  73. package/api/@wtf/release-go/modules/functions/isFetchable.md +28 -0
  74. package/api/@wtf/release-go/modules/functions/isGoMod.md +28 -0
  75. package/api/@wtf/release-go/modules/functions/majorErrors.md +37 -0
  76. package/api/@wtf/release-go/modules/functions/majorOfPath.md +28 -0
  77. package/api/@wtf/release-go/modules/functions/modulesAt.md +39 -0
  78. package/api/@wtf/release-go/modules/functions/modulesOf.md +29 -0
  79. package/api/@wtf/release-go/modules/functions/readModules.md +33 -0
  80. package/api/@wtf/release-go/modules/functions/selectModules.md +44 -0
  81. package/api/@wtf/release-go/modules/interfaces/Selection.md +43 -0
  82. package/api/@wtf/release-go/stamp/README.md +44 -0
  83. package/api/@wtf/release-go/stamp/functions/checkVersions.md +38 -0
  84. package/api/@wtf/release-go/stamp/functions/stampGoMod.md +35 -0
  85. package/api/@wtf/release-go/stamp/functions/stampModules.md +42 -0
  86. package/api/@wtf/release-go/stamp/interfaces/Stamped.md +31 -0
  87. package/api/@wtf/release-go/stamp/interfaces/StampedModules.md +31 -0
  88. package/api/@wtf/release-go/tags/README.md +48 -0
  89. package/api/@wtf/release-go/tags/functions/askProxy.md +44 -0
  90. package/api/@wtf/release-go/tags/functions/maskCredentials.md +28 -0
  91. package/api/@wtf/release-go/tags/functions/releaseCommit.md +48 -0
  92. package/api/@wtf/release-go/tags/functions/remoteTags.md +43 -0
  93. package/api/@wtf/release-go/tags/functions/tagModules.md +36 -0
  94. package/api/@wtf/release-go/tags/functions/tagOfModule.md +34 -0
  95. package/api/@wtf/release-go/tags/functions/tagPrefix.md +29 -0
  96. package/api/@wtf/release-go/tags/interfaces/TagModulesOptions.md +93 -0
  97. package/api/@wtf/release-go/tags/interfaces/TaggedModule.md +51 -0
  98. package/api/@wtf/release-go/tags/type-aliases/ModuleStatus.md +13 -0
  99. package/api/@wtf/release-go/tags/variables/RELEASE_AUTHOR.md +23 -0
  100. package/api/@wtf/release-maven/README.md +33 -0
  101. package/api/@wtf/release-maven/artifacts/README.md +41 -0
  102. package/api/@wtf/release-maven/artifacts/functions/groupIdOf.md +33 -0
  103. package/api/@wtf/release-maven/artifacts/functions/installsOf.md +44 -0
  104. package/api/@wtf/release-maven/artifacts/functions/isPomFile.md +28 -0
  105. package/api/@wtf/release-maven/artifacts/functions/isRange.md +27 -0
  106. package/api/@wtf/release-maven/artifacts/functions/modulesOf.md +44 -0
  107. package/api/@wtf/release-maven/artifacts/functions/nameOf.md +33 -0
  108. package/api/@wtf/release-maven/artifacts/functions/publishOrder.md +34 -0
  109. package/api/@wtf/release-maven/artifacts/functions/readModules.md +31 -0
  110. package/api/@wtf/release-maven/artifacts/functions/readPoms.md +32 -0
  111. package/api/@wtf/release-maven/artifacts/functions/selectArtifacts.md +44 -0
  112. package/api/@wtf/release-maven/artifacts/interfaces/Selection.md +42 -0
  113. package/api/@wtf/release-maven/ecosystem/README.md +41 -0
  114. package/api/@wtf/release-maven/ecosystem/functions/compareVersions.md +38 -0
  115. package/api/@wtf/release-maven/ecosystem/functions/parseRange.md +28 -0
  116. package/api/@wtf/release-maven/ecosystem/functions/resolveVersion.md +36 -0
  117. package/api/@wtf/release-maven/ecosystem/functions/satisfiesVersion.md +36 -0
  118. package/api/@wtf/release-maven/ecosystem/interfaces/Bound.md +31 -0
  119. package/api/@wtf/release-maven/ecosystem/interfaces/Restriction.md +31 -0
  120. package/api/@wtf/release-maven/ecosystem/variables/mavenEcosystem.md +15 -0
  121. package/api/@wtf/release-maven/errors/README.md +25 -0
  122. package/api/@wtf/release-maven/errors/classes/MavenError.md +268 -0
  123. package/api/@wtf/release-maven/errors/type-aliases/MavenErrorCode.md +13 -0
  124. package/api/@wtf/release-maven/errors/variables/MAVEN_ERRORS.md +51 -0
  125. package/api/@wtf/release-maven/interfaces/MavenModule.md +169 -0
  126. package/api/@wtf/release-maven/pom/README.md +48 -0
  127. package/api/@wtf/release-maven/pom/functions/childOf.md +33 -0
  128. package/api/@wtf/release-maven/pom/functions/childrenOf.md +33 -0
  129. package/api/@wtf/release-maven/pom/functions/dependencyOf.md +27 -0
  130. package/api/@wtf/release-maven/pom/functions/escapeXml.md +27 -0
  131. package/api/@wtf/release-maven/pom/functions/parseXml.md +39 -0
  132. package/api/@wtf/release-maven/pom/functions/readPom.md +39 -0
  133. package/api/@wtf/release-maven/pom/functions/textAt.md +34 -0
  134. package/api/@wtf/release-maven/pom/interfaces/Pom.md +151 -0
  135. package/api/@wtf/release-maven/pom/interfaces/PomDependency.md +51 -0
  136. package/api/@wtf/release-maven/pom/interfaces/PomParent.md +41 -0
  137. package/api/@wtf/release-maven/pom/interfaces/PomPlugin.md +51 -0
  138. package/api/@wtf/release-maven/pom/interfaces/PomRepository.md +31 -0
  139. package/api/@wtf/release-maven/pom/interfaces/Span.md +35 -0
  140. package/api/@wtf/release-maven/pom/interfaces/XmlElement.md +83 -0
  141. package/api/@wtf/release-maven/pom/variables/PLUGIN_GROUP.md +13 -0
  142. package/api/@wtf/release-maven/publish/README.md +45 -0
  143. package/api/@wtf/release-maven/publish/functions/deployModules.md +35 -0
  144. package/api/@wtf/release-maven/publish/interfaces/DeployModulesOptions.md +146 -0
  145. package/api/@wtf/release-maven/publish/interfaces/DeployedModule.md +42 -0
  146. package/api/@wtf/release-maven/publish/type-aliases/ModuleStatus.md +13 -0
  147. package/api/@wtf/release-maven/repository/README.md +38 -0
  148. package/api/@wtf/release-maven/repository/functions/deployTargets.md +46 -0
  149. package/api/@wtf/release-maven/repository/functions/expandValues.md +42 -0
  150. package/api/@wtf/release-maven/repository/functions/hasPom.md +38 -0
  151. package/api/@wtf/release-maven/repository/functions/pomPath.md +40 -0
  152. package/api/@wtf/release-maven/repository/functions/pomUrl.md +45 -0
  153. package/api/@wtf/release-maven/repository/interfaces/Repository.md +31 -0
  154. package/api/@wtf/release-maven/repository/interfaces/ValuesOf.md +31 -0
  155. package/api/@wtf/release-maven/repository/variables/MAVEN_CENTRAL.md +13 -0
  156. package/api/@wtf/release-maven/stamp/README.md +50 -0
  157. package/api/@wtf/release-maven/stamp/functions/checkVersions.md +36 -0
  158. package/api/@wtf/release-maven/stamp/functions/stampModules.md +55 -0
  159. package/api/@wtf/release-maven/stamp/functions/stampPom.md +45 -0
  160. package/api/@wtf/release-maven/stamp/interfaces/PomStampOptions.md +51 -0
  161. package/api/@wtf/release-maven/stamp/interfaces/Stamped.md +31 -0
  162. package/api/@wtf/release-maven/stamp/interfaces/StampedModules.md +31 -0
  163. package/api/@wtf/release-npm/check/functions/checkPackages.md +1 -1
  164. package/api/@wtf/release-npm/check/functions/formatIssue.md +1 -1
  165. package/api/@wtf/release-npm/check/interfaces/CheckOptions.md +6 -6
  166. package/api/@wtf/release-npm/check/interfaces/Issue.md +5 -5
  167. package/api/@wtf/release-npm/check/type-aliases/CheckedPackage.md +1 -1
  168. package/api/@wtf/release-npm/check/type-aliases/IssueCode.md +1 -1
  169. package/api/@wtf/release-npm/ecosystem/variables/npmEcosystem.md +1 -1
  170. package/api/@wtf/release-npm/errors/type-aliases/NpmErrorCode.md +1 -1
  171. package/api/@wtf/release-npm/errors/variables/NPM_ERRORS.md +1 -1
  172. package/api/@wtf/release-npm/interfaces/Lookup.md +3 -3
  173. package/api/@wtf/release-npm/interfaces/PublishOptions.md +6 -6
  174. package/api/@wtf/release-npm/interfaces/PublishPackage.md +5 -5
  175. package/api/@wtf/release-npm/interfaces/PublishTrainOptions.md +13 -13
  176. package/api/@wtf/release-npm/interfaces/Publisher.md +7 -7
  177. package/api/@wtf/release-npm/interfaces/PublisherContext.md +7 -7
  178. package/api/@wtf/release-npm/manifests/functions/concreteRange.md +1 -1
  179. package/api/@wtf/release-npm/manifests/functions/manifestsAt.md +1 -1
  180. package/api/@wtf/release-npm/manifests/functions/packageOf.md +1 -1
  181. package/api/@wtf/release-npm/manifests/functions/packagesOfManifests.md +1 -1
  182. package/api/@wtf/release-npm/manifests/functions/readManifests.md +1 -1
  183. package/api/@wtf/release-npm/manifests/functions/resolveSpecifier.md +1 -1
  184. package/api/@wtf/release-npm/manifests/functions/runtimeDependenciesOf.md +1 -1
  185. package/api/@wtf/release-npm/manifests/functions/satisfiesRange.md +1 -1
  186. package/api/@wtf/release-npm/manifests/interfaces/Manifest.md +5 -5
  187. package/api/@wtf/release-npm/manifests/interfaces/NpmPackage.md +7 -7
  188. package/api/@wtf/release-npm/manifests/type-aliases/DependencyField.md +1 -1
  189. package/api/@wtf/release-npm/manifests/variables/DEPENDENCY_FIELDS.md +1 -1
  190. package/api/@wtf/release-npm/manifests/variables/FIELD_KINDS.md +1 -1
  191. package/api/@wtf/release-npm/manifests/variables/RUNTIME_FIELDS.md +1 -1
  192. package/api/@wtf/release-npm/prepare/functions/isTypeScriptSource.md +1 -1
  193. package/api/@wtf/release-npm/prepare/functions/prepareManifest.md +1 -1
  194. package/api/@wtf/release-npm/prepare/functions/stripSourceConditions.md +1 -1
  195. package/api/@wtf/release-npm/prepare/interfaces/PrepareOptions.md +5 -5
  196. package/api/@wtf/release-npm/prepare/interfaces/PreparedManifest.md +6 -6
  197. package/api/@wtf/release-npm/prepare/variables/SOURCE_CONDITIONS.md +1 -1
  198. package/api/@wtf/release-npm/publishers/functions/builtInPublisher.md +1 -1
  199. package/api/@wtf/release-npm/publishers/functions/isPublisher.md +1 -1
  200. package/api/@wtf/release-npm/publishers/variables/NPM_REGISTRY.md +1 -1
  201. package/api/@wtf/release-npm/publishers/variables/PUBLISHERS.md +1 -1
  202. package/api/@wtf/release-npm/publishers/variables/npmPublisher.md +1 -1
  203. package/api/@wtf/release-npm/publishers/variables/pnpmPublisher.md +1 -1
  204. package/api/@wtf/release-npm/release/functions/checkTrain.md +1 -1
  205. package/api/@wtf/release-npm/release/functions/distTagOf.md +1 -1
  206. package/api/@wtf/release-npm/release/functions/packTrain.md +1 -1
  207. package/api/@wtf/release-npm/release/functions/publishPacked.md +1 -1
  208. package/api/@wtf/release-npm/release/functions/publishTrain.md +1 -1
  209. package/api/@wtf/release-npm/release/functions/publishedOf.md +1 -1
  210. package/api/@wtf/release-npm/release/functions/publishedOfResolved.md +1 -1
  211. package/api/@wtf/release-npm/release/functions/releaseTrain.md +1 -1
  212. package/api/@wtf/release-npm/release/functions/resolveManifests.md +1 -1
  213. package/api/@wtf/release-npm/release/functions/tagTrain.md +1 -1
  214. package/api/@wtf/release-npm/release/interfaces/CheckRelease.md +16 -16
  215. package/api/@wtf/release-npm/release/interfaces/PackOptions.md +8 -8
  216. package/api/@wtf/release-npm/release/interfaces/PackedTrain.md +12 -12
  217. package/api/@wtf/release-npm/release/interfaces/PublishRun.md +11 -11
  218. package/api/@wtf/release-npm/release/interfaces/PublishedOf.md +4 -4
  219. package/api/@wtf/release-npm/release/interfaces/PublishedPackage.md +7 -7
  220. package/api/@wtf/release-npm/release/interfaces/PublishedTrain.md +5 -5
  221. package/api/@wtf/release-npm/release/interfaces/ResolveRelease.md +17 -17
  222. package/api/@wtf/release-npm/release/interfaces/ResolvedPackage.md +4 -4
  223. package/api/@wtf/release-npm/release/interfaces/ResolvedTrain.md +6 -6
  224. package/api/@wtf/release-npm/release/interfaces/TagRelease.md +14 -14
  225. package/api/@wtf/release-npm/release/type-aliases/LookedUpTrain.md +1 -1
  226. package/api/@wtf/release-npm/release/type-aliases/ReleaseRun.md +1 -1
  227. package/api/@wtf/release-npm/release/variables/ID_TOKENS.md +1 -1
  228. package/api/@wtf/release-npm/release/variables/RUNNER_ENVIRONMENTS.md +1 -1
  229. package/api/@wtf/release-npm/workspace/functions/pnpmWorkspaceGlobs.md +1 -1
  230. package/api/@wtf/release-npm/workspace/functions/publishableOf.md +1 -1
  231. package/api/@wtf/release-npm/workspace/functions/readWorkspace.md +1 -1
  232. package/api/@wtf/release-npm/workspace/functions/workspaceFolders.md +1 -1
  233. package/api/@wtf/release-npm/workspace/functions/workspaceGlobs.md +1 -1
  234. package/api/@wtf/release-npm/workspace/interfaces/WorkspaceGlobs.md +3 -3
  235. package/api/@wtf/release-npm/workspace/interfaces/WorkspaceOptions.md +2 -2
  236. package/api/@wtf/release-replace/errors/classes/ReplaceError.md +5 -5
  237. package/api/@wtf/release-replace/errors/type-aliases/ReplaceErrorCode.md +1 -1
  238. package/api/@wtf/release-replace/errors/variables/REPLACE_ERRORS.md +1 -1
  239. package/api/@wtf/release-replace/files/functions/filesMatcher.md +1 -1
  240. package/api/@wtf/release-replace/interfaces/ReplaceMatch.md +5 -5
  241. package/api/@wtf/release-replace/interfaces/ReplacementOf.md +5 -5
  242. package/api/@wtf/release-replace/replace/functions/regExpOf.md +1 -1
  243. package/api/@wtf/release-replace/replace/functions/replaceFiles.md +1 -1
  244. package/api/@wtf/release-replace/replace/functions/replaceText.md +1 -1
  245. package/api/@wtf/release-replace/replace/interfaces/ReplaceOptions.md +10 -10
  246. package/api/@wtf/release-replace/replace/interfaces/TextOptions.md +5 -5
  247. package/api/@wtf/release-replace/replace/type-aliases/To.md +1 -1
  248. package/api/@wtf/release-replace/templates/functions/mergeTemplates.md +1 -1
  249. package/api/@wtf/release-replace/templates/functions/resolveReplacement.md +1 -1
  250. package/api/@wtf/release-replace/templates/functions/resolveReplacements.md +1 -1
  251. package/api/@wtf/release-replace/type-aliases/Escape.md +1 -1
  252. package/api/@wtf/release-replace/type-aliases/ReplaceFunction.md +1 -1
  253. package/api/@wtf/release-replace/type-aliases/Replacement.md +1 -1
  254. package/api/@wtf/release-replace/type-aliases/ReplacementSpec.md +1 -1
  255. package/api/@wtf/release-replace/type-aliases/TemplateUse.md +1 -1
  256. package/api/@wtf/release-replace/type-aliases/Templates.md +1 -1
  257. package/api/@wtf/release-replace/values/functions/escapeValue.md +1 -1
  258. package/api/@wtf/release-replace/values/functions/textOf.md +1 -1
  259. package/api/@wtf/release-replace/values/functions/valueAt.md +1 -1
  260. package/api/@wtf/release-replace/values/variables/ESCAPES.md +1 -1
  261. package/api/@wtf/release-replace/values/variables/VALUE.md +1 -1
  262. package/api/@wtf/release-system/errors/classes/ReleaseError.md +7 -5
  263. package/api/@wtf/release-system/errors/functions/throwAll.md +1 -1
  264. package/api/@wtf/release-system/errors/type-aliases/ErrorClass.md +1 -1
  265. package/api/@wtf/release-system/errors/type-aliases/SystemErrorCode.md +1 -1
  266. package/api/@wtf/release-system/errors/variables/SYSTEM_ERRORS.md +1 -1
  267. package/api/@wtf/release-system/git/functions/commitsSince.md +1 -1
  268. package/api/@wtf/release-system/git/functions/filesOfCommits.md +1 -1
  269. package/api/@wtf/release-system/git/functions/git.md +1 -1
  270. package/api/@wtf/release-system/git/functions/gitOf.md +1 -1
  271. package/api/@wtf/release-system/git/functions/trackedFiles.md +1 -1
  272. package/api/@wtf/release-system/git/interfaces/GitContext.md +4 -4
  273. package/api/@wtf/release-system/git/interfaces/LogCommit.md +5 -5
  274. package/api/@wtf/release-system/node/functions/nodeSystem.md +1 -1
  275. package/api/@wtf/release-system/node/functions/realPathOf.md +1 -1
  276. package/api/@wtf/release-system/node/functions/systemOf.md +1 -1
  277. package/api/@wtf/release-system/paths/functions/normalizePath.md +1 -1
  278. package/api/@wtf/release-system/paths/functions/pathMatcher.md +1 -1
  279. package/api/@wtf/release-system/paths/type-aliases/PathMatcher.md +1 -1
  280. package/api/@wtf/release-system/posix/functions/basenameOf.md +1 -1
  281. package/api/@wtf/release-system/posix/functions/dirnameOf.md +1 -1
  282. package/api/@wtf/release-system/posix/functions/joinPath.md +1 -1
  283. package/api/@wtf/release-system/posix/functions/relativePath.md +1 -1
  284. package/api/@wtf/release-system/posix/functions/resolvePath.md +1 -1
  285. package/api/@wtf/release-system/system/interfaces/DirEntry.md +3 -3
  286. package/api/@wtf/release-system/system/interfaces/ExecOptions.md +4 -4
  287. package/api/@wtf/release-system/system/interfaces/ExecResult.md +4 -4
  288. package/api/@wtf/release-system/system/interfaces/System.md +7 -7
  289. package/api/@wtf/release-system/system/interfaces/SystemFs.md +8 -8
  290. package/api/@wtf/release-system/system/type-aliases/Exec.md +1 -1
  291. package/api/@wtf/release-system/system/type-aliases/SystemInput.md +1 -1
  292. package/api/@wtf/release-system/validator/functions/allOf.md +1 -1
  293. package/api/@wtf/release-system/validator/functions/anyObject.md +1 -1
  294. package/api/@wtf/release-system/validator/functions/anyOf.md +1 -1
  295. package/api/@wtf/release-system/validator/functions/arrayOf.md +1 -1
  296. package/api/@wtf/release-system/validator/functions/booleanOf.md +1 -1
  297. package/api/@wtf/release-system/validator/functions/errorOf.md +1 -1
  298. package/api/@wtf/release-system/validator/functions/errorsOf.md +1 -1
  299. package/api/@wtf/release-system/validator/functions/exclusive.md +1 -1
  300. package/api/@wtf/release-system/validator/functions/issuesOf.md +1 -1
  301. package/api/@wtf/release-system/validator/functions/objectOf.md +1 -1
  302. package/api/@wtf/release-system/validator/functions/oneOf.md +1 -1
  303. package/api/@wtf/release-system/validator/functions/orFunction.md +1 -1
  304. package/api/@wtf/release-system/validator/functions/pathText.md +1 -1
  305. package/api/@wtf/release-system/validator/functions/pluginEntriesOf.md +1 -1
  306. package/api/@wtf/release-system/validator/functions/recordOf.md +1 -1
  307. package/api/@wtf/release-system/validator/functions/refined.md +1 -1
  308. package/api/@wtf/release-system/validator/functions/stringOf.md +1 -1
  309. package/api/@wtf/release-system/validator/functions/tupleOf.md +1 -1
  310. package/api/@wtf/release-system/validator/interfaces/ArrayOptions.md +5 -5
  311. package/api/@wtf/release-system/validator/interfaces/IssueOptions.md +4 -4
  312. package/api/@wtf/release-system/validator/interfaces/ObjectOptions.md +5 -5
  313. package/api/@wtf/release-system/validator/interfaces/OptionIssue.md +4 -4
  314. package/api/@wtf/release-system/validator/interfaces/Property.md +4 -4
  315. package/api/@wtf/release-system/validator/interfaces/RecordOptions.md +6 -6
  316. package/api/@wtf/release-system/validator/interfaces/StringOptions.md +6 -6
  317. package/api/@wtf/release-system/validator/interfaces/Validator.md +4 -4
  318. package/api/@wtf/release-system/validator/type-aliases/JsonSchema.md +1 -1
  319. package/api/@wtf/release-system/validator/type-aliases/Path.md +1 -1
  320. package/api/@wtf/release-trains/cascade/functions/cascadeNotes.md +1 -1
  321. package/api/@wtf/release-trains/cascade/functions/cascadeText.md +1 -1
  322. package/api/@wtf/release-trains/cascade/functions/cascadeType.md +1 -1
  323. package/api/@wtf/release-trains/cascade/functions/cascadesOf.md +1 -1
  324. package/api/@wtf/release-trains/cascade/functions/higherType.md +1 -1
  325. package/api/@wtf/release-trains/cascade/interfaces/Cascade.md +11 -11
  326. package/api/@wtf/release-trains/cascade/interfaces/CascadeCheck.md +8 -8
  327. package/api/@wtf/release-trains/cascade/type-aliases/CascadeKind.md +1 -1
  328. package/api/@wtf/release-trains/cascade/type-aliases/ReleaseType.md +1 -1
  329. package/api/@wtf/release-trains/cascade/variables/RELEASE_TYPES.md +1 -1
  330. package/api/@wtf/release-trains/ecosystem/functions/isEcosystem.md +1 -1
  331. package/api/@wtf/release-trains/ecosystem/functions/loadEcosystems.md +1 -1
  332. package/api/@wtf/release-trains/ecosystem/functions/readPackages.md +1 -1
  333. package/api/@wtf/release-trains/ecosystem/interfaces/Dependency.md +4 -4
  334. package/api/@wtf/release-trains/ecosystem/interfaces/Ecosystem.md +5 -5
  335. package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemContext.md +5 -5
  336. package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemPackages.md +3 -3
  337. package/api/@wtf/release-trains/ecosystem/interfaces/Package.md +8 -6
  338. package/api/@wtf/release-trains/ecosystem/type-aliases/DependencyKind.md +1 -1
  339. package/api/@wtf/release-trains/ecosystem/type-aliases/ModuleLoader.md +1 -1
  340. package/api/@wtf/release-trains/ecosystem/variables/DEPENDENCY_KINDS.md +1 -1
  341. package/api/@wtf/release-trains/errors/classes/TrainsError.md +5 -5
  342. package/api/@wtf/release-trains/errors/type-aliases/TrainsErrorCode.md +1 -1
  343. package/api/@wtf/release-trains/errors/variables/TRAINS_ERRORS.md +1 -1
  344. package/api/@wtf/release-trains/generated/functions/filesIn.md +1 -1
  345. package/api/@wtf/release-trains/generated/functions/formatGenerated.md +1 -1
  346. package/api/@wtf/release-trains/generated/functions/listGenerated.md +1 -1
  347. package/api/@wtf/release-trains/generated/functions/parseGenerated.md +1 -1
  348. package/api/@wtf/release-trains/generated/functions/readGenerated.md +1 -1
  349. package/api/@wtf/release-trains/generated/functions/stageGenerated.md +1 -1
  350. package/api/@wtf/release-trains/generated/functions/stageGeneratedFolders.md +1 -1
  351. package/api/@wtf/release-trains/generated/functions/unlistedIn.md +1 -1
  352. package/api/@wtf/release-trains/generated/interfaces/GeneratedOptions.md +2 -2
  353. package/api/@wtf/release-trains/generated/interfaces/StageOptions.md +6 -6
  354. package/api/@wtf/release-trains/generated/variables/GENERATED.md +1 -1
  355. package/api/@wtf/release-trains/git/functions/tagOf.md +1 -1
  356. package/api/@wtf/release-trains/git/functions/tagsOf.md +1 -1
  357. package/api/@wtf/release-trains/git/functions/versionOfTag.md +1 -1
  358. package/api/@wtf/release-trains/git/interfaces/TrainTag.md +3 -3
  359. package/api/@wtf/release-trains/interfaces/Train.md +7 -7
  360. package/api/@wtf/release-trains/packages/functions/dependencyEdges.md +1 -1
  361. package/api/@wtf/release-trains/packages/functions/dependencyText.md +1 -1
  362. package/api/@wtf/release-trains/packages/functions/dependsOnErrors.md +1 -1
  363. package/api/@wtf/release-trains/packages/functions/normalizeDir.md +1 -1
  364. package/api/@wtf/release-trains/packages/functions/ownersOf.md +1 -1
  365. package/api/@wtf/release-trains/packages/functions/packagesOf.md +1 -1
  366. package/api/@wtf/release-trains/packages/functions/publishOrder.md +1 -1
  367. package/api/@wtf/release-trains/packages/functions/releasedVersions.md +1 -1
  368. package/api/@wtf/release-trains/packages/functions/trainDependencies.md +1 -1
  369. package/api/@wtf/release-trains/packages/functions/trainOrder.md +1 -1
  370. package/api/@wtf/release-trains/packages/functions/unsatisfiedErrors.md +1 -1
  371. package/api/@wtf/release-trains/packages/interfaces/DependencyEdge.md +6 -6
  372. package/api/@wtf/release-trains/packages/interfaces/OrderFault.md +4 -4
  373. package/api/@wtf/release-trains/packages/interfaces/OrderPins.md +3 -3
  374. package/api/@wtf/release-trains/packages/interfaces/PublishOrder.md +3 -3
  375. package/api/@wtf/release-trains/packages/interfaces/TrainDependency.md +3 -3
  376. package/api/@wtf/release-trains/packages/interfaces/VersionsRelease.md +7 -7
  377. package/api/@wtf/release-trains/paths/functions/filterCommits.md +1 -1
  378. package/api/@wtf/release-trains/paths/functions/gitFilesOf.md +1 -1
  379. package/api/@wtf/release-trains/paths/functions/overlapError.md +1 -1
  380. package/api/@wtf/release-trains/paths/functions/trainOfPath.md +1 -1
  381. package/api/@wtf/release-trains/paths/functions/trainsOfCommit.md +1 -1
  382. package/api/@wtf/release-trains/paths/functions/trainsOfPath.md +1 -1
  383. package/api/@wtf/release-trains/paths/type-aliases/FilesOf.md +1 -1
  384. package/api/@wtf/release-trains/schema/interfaces/ConfigPart.md +6 -6
  385. package/api/@wtf/release-trains/schema/interfaces/RootOptions.md +7 -7
  386. package/api/@wtf/release-trains/schema/type-aliases/DependencyRule.md +1 -1
  387. package/api/@wtf/release-trains/schema/variables/DEPENDENCY_RULES.md +1 -1
  388. package/api/@wtf/release-trains/schema/variables/TAG_FORMAT_PATTERN.md +1 -1
  389. package/api/@wtf/release-trains/schema/variables/TRAIN_NAME_PATTERN.md +1 -1
  390. package/api/@wtf/release-trains/schema/variables/configSchema.md +1 -1
  391. package/api/@wtf/release-trains/schema/variables/jsonSchema.md +1 -1
  392. package/api/@wtf/release-trains/schema/variables/rootOptionsSchema.md +1 -1
  393. package/api/@wtf/release-trains/schema/variables/trainSchema.md +1 -1
  394. package/api/@wtf/release-trains/schema/variables/trainsSchema.md +1 -1
  395. package/api/@wtf/release-trains/trains/functions/changelogOf.md +1 -1
  396. package/api/@wtf/release-trains/trains/functions/matchersOf.md +1 -1
  397. package/api/@wtf/release-trains/trains/functions/overlapErrors.md +1 -1
  398. package/api/@wtf/release-trains/trains/functions/selectTrain.md +1 -1
  399. package/api/@wtf/release-trains/trains/functions/tagFormatOf.md +1 -1
  400. package/api/@wtf/release-trains/trains/functions/trainHeadedNotes.md +1 -1
  401. package/api/@wtf/release-trains/trains/functions/trainOfRun.md +1 -1
  402. package/api/@wtf/release-trains/trains/functions/trainOfTag.md +1 -1
  403. package/api/@wtf/release-trains/trains/functions/trainsErrors.md +1 -1
  404. package/api/@wtf/release-trains/trains/functions/trainsOfOptions.md +1 -1
  405. package/api/@wtf/release-trains/trains/variables/TRAIN_VARIABLE.md +1 -1
  406. package/api/@wtf/release-trains/trains/variables/VERSION.md +1 -1
  407. package/api/@wtf/release-trains/type-aliases/BranchSpec.md +1 -1
  408. package/api/@wtf/release-trains/type-aliases/Trains.md +1 -1
  409. package/api/@wtf/release-trains/verify/functions/unreleasedDependencies.md +1 -1
  410. package/api/@wtf/release-trains/verify/functions/verifyTrain.md +1 -1
  411. package/api/@wtf/release-trains/verify/interfaces/UnreleasedDependencies.md +10 -10
  412. package/api/@wtf/release-trains/verify/interfaces/VerifiedTrain.md +5 -5
  413. package/api/@wtf/release-trains/verify/interfaces/VerifyRelease.md +8 -8
  414. package/api/@wtf/release-validate/errors/classes/ValidateError.md +5 -5
  415. package/api/@wtf/release-validate/errors/type-aliases/ValidateErrorCode.md +1 -1
  416. package/api/@wtf/release-validate/errors/variables/VALIDATE_ERRORS.md +1 -1
  417. package/api/@wtf/release-validate/interfaces/ConfigIssue.md +4 -4
  418. package/api/@wtf/release-validate/json-schema/functions/fromJsonSchema.md +1 -1
  419. package/api/@wtf/release-validate/json-schema/functions/pathOfPointer.md +1 -1
  420. package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaError.md +3 -3
  421. package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaValidator.md +3 -3
  422. package/api/@wtf/release-validate/validate/functions/configErrors.md +1 -1
  423. package/api/@wtf/release-validate/validate/functions/isStandardSchema.md +1 -1
  424. package/api/@wtf/release-validate/validate/functions/pathText.md +1 -1
  425. package/api/@wtf/release-validate/validate/functions/validateConfig.md +1 -1
  426. package/api/@wtf/semantic-release-cargo/functions/indexLookup.md +1 -1
  427. package/api/@wtf/semantic-release-cargo/functions/prepare.md +1 -1
  428. package/api/@wtf/semantic-release-cargo/functions/publish.md +1 -1
  429. package/api/@wtf/semantic-release-cargo/functions/verifyConditions.md +1 -1
  430. package/api/@wtf/semantic-release-cargo/interfaces/CargoPluginOptions.md +12 -12
  431. package/api/@wtf/semantic-release-cargo/interfaces/CargoRelease.md +3 -3
  432. package/api/@wtf/semantic-release-cargo/schema/type-aliases/CargoOptions.md +1 -1
  433. package/api/@wtf/semantic-release-cargo/schema/variables/cargoOptionsSchema.md +1 -1
  434. package/api/@wtf/semantic-release-cargo/schema/variables/cargoSchema.md +1 -1
  435. package/api/@wtf/semantic-release-cargo/schema/variables/configSchema.md +1 -1
  436. package/api/@wtf/semantic-release-cargo/schema/variables/jsonSchema.md +1 -1
  437. package/api/@wtf/semantic-release-cargo/variables/default.md +1 -1
  438. package/api/@wtf/semantic-release-go/README.md +73 -0
  439. package/api/@wtf/semantic-release-go/functions/prepare.md +41 -0
  440. package/api/@wtf/semantic-release-go/functions/publish.md +43 -0
  441. package/api/@wtf/semantic-release-go/functions/verifyConditions.md +37 -0
  442. package/api/@wtf/semantic-release-go/functions/verifyRelease.md +38 -0
  443. package/api/@wtf/semantic-release-go/interfaces/GoPluginOptions.md +84 -0
  444. package/api/@wtf/semantic-release-go/interfaces/GoRelease.md +31 -0
  445. package/api/@wtf/semantic-release-go/schema/README.md +37 -0
  446. package/api/@wtf/semantic-release-go/schema/type-aliases/GoOptions.md +13 -0
  447. package/api/@wtf/{semantic-release-trains-changelog → semantic-release-go}/schema/variables/configSchema.md +2 -2
  448. package/api/@wtf/semantic-release-go/schema/variables/goOptionsSchema.md +13 -0
  449. package/api/@wtf/semantic-release-go/schema/variables/goSchema.md +14 -0
  450. package/api/@wtf/{semantic-release-trains-changelog → semantic-release-go}/schema/variables/jsonSchema.md +2 -2
  451. package/api/@wtf/semantic-release-go/variables/default.md +144 -0
  452. package/api/@wtf/semantic-release-maven/README.md +74 -0
  453. package/api/@wtf/semantic-release-maven/functions/pomLookup.md +38 -0
  454. package/api/@wtf/semantic-release-maven/functions/prepare.md +41 -0
  455. package/api/@wtf/semantic-release-maven/functions/publish.md +43 -0
  456. package/api/@wtf/semantic-release-maven/functions/verifyConditions.md +40 -0
  457. package/api/@wtf/semantic-release-maven/interfaces/LookupAuth.md +32 -0
  458. package/api/@wtf/semantic-release-maven/interfaces/MavenPluginOptions.md +129 -0
  459. package/api/@wtf/semantic-release-maven/interfaces/MavenRelease.md +21 -0
  460. package/api/@wtf/semantic-release-maven/schema/README.md +38 -0
  461. package/api/@wtf/semantic-release-maven/schema/type-aliases/MavenOptions.md +13 -0
  462. package/api/@wtf/semantic-release-maven/schema/variables/configSchema.md +13 -0
  463. package/api/@wtf/semantic-release-maven/schema/variables/jsonSchema.md +13 -0
  464. package/api/@wtf/semantic-release-maven/schema/variables/mavenOptionsSchema.md +13 -0
  465. package/api/@wtf/semantic-release-maven/schema/variables/mavenSchema.md +14 -0
  466. package/api/@wtf/semantic-release-maven/variables/default.md +116 -0
  467. package/api/@wtf/semantic-release-npm/functions/addChannel.md +1 -1
  468. package/api/@wtf/semantic-release-npm/functions/fail.md +1 -1
  469. package/api/@wtf/semantic-release-npm/functions/loadPublisher.md +1 -1
  470. package/api/@wtf/semantic-release-npm/functions/prepare.md +1 -1
  471. package/api/@wtf/semantic-release-npm/functions/publish.md +1 -1
  472. package/api/@wtf/semantic-release-npm/functions/verifyConditions.md +1 -1
  473. package/api/@wtf/semantic-release-npm/interfaces/PublishPluginOptions.md +18 -18
  474. package/api/@wtf/semantic-release-npm/interfaces/PublishedRelease.md +4 -4
  475. package/api/@wtf/semantic-release-npm/interfaces/SmokeOption.md +2 -2
  476. package/api/@wtf/semantic-release-npm/schema/type-aliases/PublishOptions.md +1 -1
  477. package/api/@wtf/semantic-release-npm/schema/variables/configSchema.md +1 -1
  478. package/api/@wtf/semantic-release-npm/schema/variables/jsonSchema.md +1 -1
  479. package/api/@wtf/semantic-release-npm/schema/variables/publishOptionsSchema.md +1 -1
  480. package/api/@wtf/semantic-release-npm/schema/variables/publishSchema.md +1 -1
  481. package/api/@wtf/semantic-release-npm/type-aliases/PublisherSpec.md +1 -1
  482. package/api/@wtf/semantic-release-npm/variables/default.md +1 -1
  483. package/api/@wtf/semantic-release-replace/functions/functionOf.md +1 -1
  484. package/api/@wtf/semantic-release-replace/functions/prepare.md +1 -1
  485. package/api/@wtf/semantic-release-replace/functions/templatesOf.md +1 -1
  486. package/api/@wtf/semantic-release-replace/functions/verifyConditions.md +1 -1
  487. package/api/@wtf/semantic-release-replace/interfaces/ReplacePluginOptions.md +5 -5
  488. package/api/@wtf/semantic-release-replace/schema/interfaces/ModuleExport.md +3 -3
  489. package/api/@wtf/semantic-release-replace/schema/interfaces/ReplaceOptions.md +4 -4
  490. package/api/@wtf/semantic-release-replace/schema/interfaces/RootTemplates.md +2 -2
  491. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacement.md +1 -1
  492. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacementSpec.md +1 -1
  493. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTemplates.md +1 -1
  494. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTo.md +1 -1
  495. package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplateSet.md +1 -1
  496. package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplatesOption.md +1 -1
  497. package/api/@wtf/semantic-release-replace/schema/variables/configSchema.md +1 -1
  498. package/api/@wtf/semantic-release-replace/schema/variables/exportedSetSchema.md +1 -1
  499. package/api/@wtf/semantic-release-replace/schema/variables/jsonSchema.md +1 -1
  500. package/api/@wtf/semantic-release-replace/schema/variables/replaceOptionsSchema.md +1 -1
  501. package/api/@wtf/semantic-release-replace/schema/variables/replacementSchema.md +1 -1
  502. package/api/@wtf/semantic-release-replace/schema/variables/rootTemplatesSchema.md +1 -1
  503. package/api/@wtf/semantic-release-replace/schema/variables/templateSchema.md +1 -1
  504. package/api/@wtf/semantic-release-replace/schema/variables/templatesSchema.md +1 -1
  505. package/api/@wtf/semantic-release-replace/variables/default.md +1 -1
  506. package/api/@wtf/semantic-release-trains/config/README.md +11 -3
  507. package/api/@wtf/semantic-release-trains/config/functions/skipPlugins.md +1 -1
  508. package/api/@wtf/semantic-release-trains/config/functions/stepId.md +1 -1
  509. package/api/@wtf/semantic-release-trains/config/functions/trainAssets.md +1 -1
  510. package/api/@wtf/semantic-release-trains/config/functions/trainChangelog.md +3 -4
  511. package/api/@wtf/semantic-release-trains/config/functions/trainOfTag.md +1 -1
  512. package/api/@wtf/semantic-release-trains/config/functions/trainTagFormat.md +1 -1
  513. package/api/@wtf/semantic-release-trains/config/interfaces/AssetsOptions.md +4 -4
  514. package/api/@wtf/semantic-release-trains/config/interfaces/SkipOptions.md +3 -3
  515. package/api/@wtf/semantic-release-trains/config/variables/BRANCHES.md +1 -1
  516. package/api/@wtf/semantic-release-trains/config/variables/BREAKING.md +1 -1
  517. package/api/@wtf/semantic-release-trains/config/variables/TITLE.md +14 -0
  518. package/api/@wtf/semantic-release-trains/defaults/README.md +42 -0
  519. package/api/@wtf/semantic-release-trains/defaults/functions/skipRuleOf.md +40 -0
  520. package/api/@wtf/semantic-release-trains/defaults/functions/skips.md +42 -0
  521. package/api/@wtf/semantic-release-trains/defaults/functions/trainOptionsOf.md +40 -0
  522. package/api/@wtf/semantic-release-trains/defaults/interfaces/SkipContext.md +59 -0
  523. package/api/@wtf/semantic-release-trains/defaults/type-aliases/SkipCheck.md +35 -0
  524. package/api/@wtf/semantic-release-trains/defaults/type-aliases/TrainOptions.md +33 -0
  525. package/api/@wtf/semantic-release-trains/defaults/variables/SKIP_RULES.md +13 -0
  526. package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_OPTIONS.md +20 -0
  527. package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_SKIP.md +17 -0
  528. package/api/@wtf/semantic-release-trains/errors/type-aliases/PluginErrorCode.md +1 -1
  529. package/api/@wtf/semantic-release-trains/errors/variables/PLUGIN_ERRORS.md +1 -1
  530. package/api/@wtf/semantic-release-trains/info/functions/decideTrain.md +1 -1
  531. package/api/@wtf/semantic-release-trains/info/functions/dotenvOf.md +1 -1
  532. package/api/@wtf/semantic-release-trains/info/functions/infoOf.md +1 -1
  533. package/api/@wtf/semantic-release-trains/info/interfaces/DecideRun.md +4 -4
  534. package/api/@wtf/semantic-release-trains/info/interfaces/InfoRun.md +8 -8
  535. package/api/@wtf/semantic-release-trains/info/interfaces/TrainDecision.md +5 -5
  536. package/api/@wtf/semantic-release-trains/info/interfaces/TrainInfo.md +5 -5
  537. package/api/@wtf/semantic-release-trains/interfaces/TrainsEntryOptions.md +15 -8
  538. package/api/@wtf/semantic-release-trains/interfaces/TrainsOptions.md +7 -7
  539. package/api/@wtf/semantic-release-trains/schema/README.md +1 -0
  540. package/api/@wtf/semantic-release-trains/schema/variables/configSchema.md +1 -1
  541. package/api/@wtf/semantic-release-trains/schema/variables/jsonSchema.md +1 -1
  542. package/api/@wtf/semantic-release-trains/schema/variables/pluginSpecSchema.md +1 -1
  543. package/api/@wtf/semantic-release-trains/schema/variables/skipRuleSchema.md +13 -0
  544. package/api/@wtf/semantic-release-trains/schema/variables/trainsEntrySchema.md +1 -1
  545. package/api/@wtf/semantic-release-trains/schema/variables/trainsPluginSchema.md +1 -1
  546. package/api/@wtf/semantic-release-trains/type-aliases/PluginSpec.md +1 -1
  547. package/api/@wtf/semantic-release-trains/type-aliases/TrainsPluginOptions.md +1 -1
  548. package/api/@wtf/semantic-release-trains/variables/addChannel.md +1 -1
  549. package/api/@wtf/semantic-release-trains/variables/analyzeCommits.md +1 -1
  550. package/api/@wtf/semantic-release-trains/variables/default.md +1 -1
  551. package/api/@wtf/semantic-release-trains/variables/fail.md +1 -1
  552. package/api/@wtf/semantic-release-trains/variables/generateNotes.md +1 -1
  553. package/api/@wtf/semantic-release-trains/variables/prepare.md +1 -1
  554. package/api/@wtf/semantic-release-trains/variables/publish.md +1 -1
  555. package/api/@wtf/semantic-release-trains/variables/success.md +1 -1
  556. package/api/@wtf/semantic-release-trains/variables/verifyConditions.md +1 -1
  557. package/api/@wtf/semantic-release-trains/variables/verifyRelease.md +1 -1
  558. package/api/@wtf/semantic-release-validate/functions/configOf.md +1 -1
  559. package/api/@wtf/semantic-release-validate/functions/loadSchema.md +1 -1
  560. package/api/@wtf/semantic-release-validate/functions/verifyConditions.md +1 -1
  561. package/api/@wtf/semantic-release-validate/interfaces/ValidatePluginOptions.md +2 -2
  562. package/api/@wtf/semantic-release-validate/schema/interfaces/Validator.md +2 -2
  563. package/api/@wtf/semantic-release-validate/schema/variables/configSchema.md +1 -1
  564. package/api/@wtf/semantic-release-validate/schema/variables/jsonSchema.md +1 -1
  565. package/api/@wtf/semantic-release-validate/schema/variables/validateOptionsSchema.md +1 -1
  566. package/api/@wtf/semantic-release-validate/variables/default.md +1 -1
  567. package/api/README.md +20 -5
  568. package/api/trains.json +9 -3
  569. package/guides/changelogs.md +30 -123
  570. package/guides/ci-recipes.md +16 -13
  571. package/guides/configuring-trains.md +7 -4
  572. package/guides/ecosystems.md +46 -23
  573. package/guides/getting-started.md +4 -6
  574. package/guides/publishing-go-modules.md +208 -0
  575. package/guides/publishing-maven.md +293 -0
  576. package/guides/publishing.md +6 -5
  577. package/guides/system.md +2 -2
  578. package/guides/validating-a-config.md +7 -9
  579. package/package.json +12 -10
  580. package/api/@wtf/release-trains-changelog/README.md +0 -58
  581. package/api/@wtf/release-trains-changelog/render/README.md +0 -44
  582. package/api/@wtf/release-trains-changelog/render/functions/changelogSection.md +0 -35
  583. package/api/@wtf/release-trains-changelog/render/functions/parseCommit.md +0 -28
  584. package/api/@wtf/release-trains-changelog/render/functions/prependSection.md +0 -40
  585. package/api/@wtf/release-trains-changelog/render/functions/renderSection.md +0 -37
  586. package/api/@wtf/release-trains-changelog/render/interfaces/ChangelogCommit.md +0 -27
  587. package/api/@wtf/release-trains-changelog/render/interfaces/ParsedCommit.md +0 -53
  588. package/api/@wtf/release-trains-changelog/render/interfaces/RenderOptions.md +0 -65
  589. package/api/@wtf/release-trains-changelog/render/variables/DEFAULT_TYPES.md +0 -13
  590. package/api/@wtf/release-trains-changelog/render/variables/TITLE.md +0 -13
  591. package/api/@wtf/release-trains-changelog/write/README.md +0 -48
  592. package/api/@wtf/release-trains-changelog/write/functions/changelogErrors.md +0 -33
  593. package/api/@wtf/release-trains-changelog/write/functions/commitUrlOf.md +0 -29
  594. package/api/@wtf/release-trains-changelog/write/functions/writeChangelogs.md +0 -35
  595. package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogOptions.md +0 -68
  596. package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogRelease.md +0 -176
  597. package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogTarget.md +0 -146
  598. package/api/@wtf/release-trains-changelog/write/interfaces/WrittenChangelog.md +0 -37
  599. package/api/@wtf/semantic-release-trains-changelog/README.md +0 -47
  600. package/api/@wtf/semantic-release-trains-changelog/functions/prepare.md +0 -33
  601. package/api/@wtf/semantic-release-trains-changelog/functions/verifyConditions.md +0 -36
  602. package/api/@wtf/semantic-release-trains-changelog/interfaces/ChangelogPluginOptions.md +0 -126
  603. package/api/@wtf/semantic-release-trains-changelog/schema/README.md +0 -24
  604. package/api/@wtf/semantic-release-trains-changelog/schema/variables/changelogOptionsSchema.md +0 -13
  605. package/api/@wtf/semantic-release-trains-changelog/schema/variables/changelogSchema.md +0 -13
  606. package/api/@wtf/semantic-release-trains-changelog/variables/default.md +0 -68
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **trainsPluginSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`RootOptions`](../../../release-trains/schema/interfaces/RootOptions.md) & [`TrainsEntryOptions`](../../interfaces/TrainsEntryOptions.md)\>
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/schema.ts:133](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/schema.ts#L133)
11
+ Defined in: [packages/semantic-release-trains/src/schema.ts:184](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/schema.ts#L184)
12
12
 
13
13
  The validator of the options the plugin is given: the root's, and the entry's own.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **PluginSpec** = `string` \| readonly \[`string`\] \| readonly \[`string`, `Readonly`\<`Record`\<`string`, `unknown`\>\>\]
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/types.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/types.ts#L15)
11
+ Defined in: [packages/semantic-release-trains/src/types.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/types.ts#L15)
12
12
 
13
13
  A plugin, as an entry of `plugins` names one: its name, as `'@semantic-release/commit-analyzer'`,
14
14
  or its name and its options, as `['@semantic-release/commit-analyzer', { preset:
@@ -8,6 +8,6 @@
8
8
 
9
9
  > **TrainsPluginOptions** = [`TrainsOptions`](../interfaces/TrainsOptions.md) & [`TrainsEntryOptions`](../interfaces/TrainsEntryOptions.md)
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/types.ts:71](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/types.ts#L71)
11
+ Defined in: [packages/semantic-release-trains/src/types.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/types.ts#L96)
12
12
 
13
13
  The options the plugin is given: the root's, and the entry's own.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **addChannel**: `Step` = `plugin.addChannel`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/index.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/index.ts#L69)
11
+ Defined in: [packages/semantic-release-trains/src/index.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/index.ts#L69)
12
12
 
13
13
  The wrapped plugin's `addChannel`, of the train's commits: `false` of an entry of none.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **analyzeCommits**: `Step` = `plugin.analyzeCommits`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/index.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/index.ts#L59)
11
+ Defined in: [packages/semantic-release-trains/src/index.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/index.ts#L59)
12
12
 
13
13
  The wrapped plugin's `analyzeCommits`, of the train's commits, after the rule `dependencies`.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **default**: `object`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/index.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/index.ts#L76)
11
+ Defined in: [packages/semantic-release-trains/src/index.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/index.ts#L76)
12
12
 
13
13
  The plugin: every step of semantic-release, each of the role of its entry.
14
14
 
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **fail**: `Step` = `plugin.fail`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/index.ts:73](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/index.ts#L73)
11
+ Defined in: [packages/semantic-release-trains/src/index.ts:73](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/index.ts#L73)
12
12
 
13
13
  The wrapped plugin's `fail`, of the train's commits.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **generateNotes**: `Step` = `plugin.generateNotes`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/index.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/index.ts#L63)
11
+ Defined in: [packages/semantic-release-trains/src/index.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/index.ts#L63)
12
12
 
13
13
  The wrapped plugin's `generateNotes`, of the train's commits: `''` of an entry of none.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **prepare**: `Step` = `plugin.prepare`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/index.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/index.ts#L65)
11
+ Defined in: [packages/semantic-release-trains/src/index.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/index.ts#L65)
12
12
 
13
13
  The train's generated folders staged, of `generated`; the wrapped plugin's `prepare`.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **publish**: `Step` = `plugin.publish`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/index.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/index.ts#L67)
11
+ Defined in: [packages/semantic-release-trains/src/index.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/index.ts#L67)
12
12
 
13
13
  The wrapped plugin's `publish`, of the train's commits: `false` of an entry of none.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **success**: `Step` = `plugin.success`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/index.ts:71](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/index.ts#L71)
11
+ Defined in: [packages/semantic-release-trains/src/index.ts:71](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/index.ts#L71)
12
12
 
13
13
  The wrapped plugin's `success`, of the train's commits.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **verifyConditions**: `Step` = `plugin.verifyConditions`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/index.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/index.ts#L57)
11
+ Defined in: [packages/semantic-release-trains/src/index.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/index.ts#L57)
12
12
 
13
13
  Each entry's check of the trains, and the wrapped plugin's `verifyConditions`.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **verifyRelease**: `Step` = `plugin.verifyRelease`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/index.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/index.ts#L61)
11
+ Defined in: [packages/semantic-release-trains/src/index.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/index.ts#L61)
12
12
 
13
13
  The wrapped plugin's `verifyRelease`, of the train's commits.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **configOf**(`options`): `Record`\<`string`, `unknown`\>
10
10
 
11
- Defined in: [packages/semantic-release-validate/src/index.ts:83](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-validate/src/index.ts#L83)
11
+ Defined in: [packages/semantic-release-validate/src/index.ts:83](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/index.ts#L83)
12
12
 
13
13
  The config of a run as it was written, of the options semantic-release gives a plugin in
14
14
  `context.options`, which are the config, with its defaults, and what semantic-release adds:
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **loadSchema**(`spec`, `cwd`): `Promise`\<`StandardSchemaV1`\<`unknown`, `unknown`\>\>
10
10
 
11
- Defined in: [packages/semantic-release-validate/src/index.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-validate/src/index.ts#L113)
11
+ Defined in: [packages/semantic-release-validate/src/index.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/index.ts#L113)
12
12
 
13
13
  The schema of `spec`: a Standard Schema itself, or the default export of a module, by its path
14
14
  from `cwd` or the name of a package the repo installs. Throws `ESCHEMA` of one that cannot be
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **verifyConditions**(`pluginConfig`, `context`): `Promise`\<`void`\>
10
10
 
11
- Defined in: [packages/semantic-release-validate/src/index.ts:160](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-validate/src/index.ts#L160)
11
+ Defined in: [packages/semantic-release-validate/src/index.ts:160](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/index.ts#L160)
12
12
 
13
13
  Validates the config of the run, as it was written ([configOf](configOf.md)), `plugins` too, by the
14
14
  plugin's `schema`: its own options first (`EOPTIONS` of its `./schema`), then the config, each
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: ValidatePluginOptions
8
8
 
9
- Defined in: [packages/semantic-release-validate/src/index.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-validate/src/index.ts#L42)
9
+ Defined in: [packages/semantic-release-validate/src/index.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/index.ts#L42)
10
10
 
11
11
  The options of the plugin.
12
12
 
@@ -16,7 +16,7 @@ The options of the plugin.
16
16
 
17
17
  > `readonly` **schema**: `string` \| `StandardSchemaV1`\<`unknown`, `unknown`\>
18
18
 
19
- Defined in: [packages/semantic-release-validate/src/index.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-validate/src/index.ts#L47)
19
+ Defined in: [packages/semantic-release-validate/src/index.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/index.ts#L47)
20
20
 
21
21
  The schema the config satisfies: a Standard Schema, or a module whose default export is one, by
22
22
  its path from the root of the repo or the name of a package.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Validator
8
8
 
9
- Defined in: [packages/semantic-release-validate/src/schema.ts:13](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-validate/src/schema.ts#L13)
9
+ Defined in: [packages/semantic-release-validate/src/schema.ts:13](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/schema.ts#L13)
10
10
 
11
11
  A validator of this package: a Standard Schema, and a Standard JSON Schema of draft 2020-12.
12
12
 
@@ -16,6 +16,6 @@ A validator of this package: a Standard Schema, and a Standard JSON Schema of dr
16
16
 
17
17
  > `readonly` **~standard**: `Props`\<`unknown`, `unknown`\> & `Props`\<`unknown`, `unknown`\>
18
18
 
19
- Defined in: [packages/semantic-release-validate/src/schema.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-validate/src/schema.ts#L15)
19
+ Defined in: [packages/semantic-release-validate/src/schema.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/schema.ts#L15)
20
20
 
21
21
  The properties of both standards.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **configSchema**: [`Validator`](../interfaces/Validator.md)
10
10
 
11
- Defined in: [packages/semantic-release-validate/src/schema.ts:118](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-validate/src/schema.ts#L118)
11
+ Defined in: [packages/semantic-release-validate/src/schema.ts:118](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/schema.ts#L118)
12
12
 
13
13
  The validator of this package's part of a whole config: each entry of `plugins` of the plugin.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **jsonSchema**: `Readonly`\<`Record`\<`string`, `unknown`\>\>
10
10
 
11
- Defined in: [packages/semantic-release-validate/src/schema.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-validate/src/schema.ts#L121)
11
+ Defined in: [packages/semantic-release-validate/src/schema.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/schema.ts#L121)
12
12
 
13
13
  The JSON Schema of [configSchema](configSchema.md), as the package publishes it, `schema.json`.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **validateOptionsSchema**: [`Validator`](../interfaces/Validator.md)
10
10
 
11
- Defined in: [packages/semantic-release-validate/src/schema.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-validate/src/schema.ts#L113)
11
+ Defined in: [packages/semantic-release-validate/src/schema.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/schema.ts#L113)
12
12
 
13
13
  The validator of the options of an entry of the plugin: `schema`, required.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **default**: `object`
10
10
 
11
- Defined in: [packages/semantic-release-validate/src/index.ts:181](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-validate/src/index.ts#L181)
11
+ Defined in: [packages/semantic-release-validate/src/index.ts:181](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/index.ts#L181)
12
12
 
13
13
  ## Type Declaration
14
14
 
package/api/README.md CHANGED
@@ -14,6 +14,21 @@
14
14
  - [@wtf/release-cargo/publish](@wtf/release-cargo/publish/README.md)
15
15
  - [@wtf/release-cargo/registry](@wtf/release-cargo/registry/README.md)
16
16
  - [@wtf/release-cargo/stamp](@wtf/release-cargo/stamp/README.md)
17
+ - [@wtf/release-go](@wtf/release-go/README.md)
18
+ - [@wtf/release-go/ecosystem](@wtf/release-go/ecosystem/README.md)
19
+ - [@wtf/release-go/errors](@wtf/release-go/errors/README.md)
20
+ - [@wtf/release-go/gomod](@wtf/release-go/gomod/README.md)
21
+ - [@wtf/release-go/modules](@wtf/release-go/modules/README.md)
22
+ - [@wtf/release-go/stamp](@wtf/release-go/stamp/README.md)
23
+ - [@wtf/release-go/tags](@wtf/release-go/tags/README.md)
24
+ - [@wtf/release-maven](@wtf/release-maven/README.md)
25
+ - [@wtf/release-maven/artifacts](@wtf/release-maven/artifacts/README.md)
26
+ - [@wtf/release-maven/ecosystem](@wtf/release-maven/ecosystem/README.md)
27
+ - [@wtf/release-maven/errors](@wtf/release-maven/errors/README.md)
28
+ - [@wtf/release-maven/pom](@wtf/release-maven/pom/README.md)
29
+ - [@wtf/release-maven/publish](@wtf/release-maven/publish/README.md)
30
+ - [@wtf/release-maven/repository](@wtf/release-maven/repository/README.md)
31
+ - [@wtf/release-maven/stamp](@wtf/release-maven/stamp/README.md)
17
32
  - [@wtf/release-npm](@wtf/release-npm/README.md)
18
33
  - [@wtf/release-npm/check](@wtf/release-npm/check/README.md)
19
34
  - [@wtf/release-npm/ecosystem](@wtf/release-npm/ecosystem/README.md)
@@ -38,9 +53,6 @@
38
53
  - [@wtf/release-system/system](@wtf/release-system/system/README.md)
39
54
  - [@wtf/release-system/validator](@wtf/release-system/validator/README.md)
40
55
  - [@wtf/release-trains](@wtf/release-trains/README.md)
41
- - [@wtf/release-trains-changelog](@wtf/release-trains-changelog/README.md)
42
- - [@wtf/release-trains-changelog/render](@wtf/release-trains-changelog/render/README.md)
43
- - [@wtf/release-trains-changelog/write](@wtf/release-trains-changelog/write/README.md)
44
56
  - [@wtf/release-trains/cascade](@wtf/release-trains/cascade/README.md)
45
57
  - [@wtf/release-trains/ecosystem](@wtf/release-trains/ecosystem/README.md)
46
58
  - [@wtf/release-trains/errors](@wtf/release-trains/errors/README.md)
@@ -57,14 +69,17 @@
57
69
  - [@wtf/release-validate/validate](@wtf/release-validate/validate/README.md)
58
70
  - [@wtf/semantic-release-cargo](@wtf/semantic-release-cargo/README.md)
59
71
  - [@wtf/semantic-release-cargo/schema](@wtf/semantic-release-cargo/schema/README.md)
72
+ - [@wtf/semantic-release-go](@wtf/semantic-release-go/README.md)
73
+ - [@wtf/semantic-release-go/schema](@wtf/semantic-release-go/schema/README.md)
74
+ - [@wtf/semantic-release-maven](@wtf/semantic-release-maven/README.md)
75
+ - [@wtf/semantic-release-maven/schema](@wtf/semantic-release-maven/schema/README.md)
60
76
  - [@wtf/semantic-release-npm](@wtf/semantic-release-npm/README.md)
61
77
  - [@wtf/semantic-release-npm/schema](@wtf/semantic-release-npm/schema/README.md)
62
78
  - [@wtf/semantic-release-replace](@wtf/semantic-release-replace/README.md)
63
79
  - [@wtf/semantic-release-replace/schema](@wtf/semantic-release-replace/schema/README.md)
64
80
  - [@wtf/semantic-release-trains](@wtf/semantic-release-trains/README.md)
65
- - [@wtf/semantic-release-trains-changelog](@wtf/semantic-release-trains-changelog/README.md)
66
- - [@wtf/semantic-release-trains-changelog/schema](@wtf/semantic-release-trains-changelog/schema/README.md)
67
81
  - [@wtf/semantic-release-trains/config](@wtf/semantic-release-trains/config/README.md)
82
+ - [@wtf/semantic-release-trains/defaults](@wtf/semantic-release-trains/defaults/README.md)
68
83
  - [@wtf/semantic-release-trains/errors](@wtf/semantic-release-trains/errors/README.md)
69
84
  - [@wtf/semantic-release-trains/info](@wtf/semantic-release-trains/info/README.md)
70
85
  - [@wtf/semantic-release-trains/schema](@wtf/semantic-release-trains/schema/README.md)
package/api/trains.json CHANGED
@@ -5,9 +5,7 @@
5
5
  ],
6
6
  "trains": [
7
7
  "@wtf/release-trains",
8
- "@wtf/release-trains-changelog",
9
- "@wtf/semantic-release-trains",
10
- "@wtf/semantic-release-trains-changelog"
8
+ "@wtf/semantic-release-trains"
11
9
  ],
12
10
  "npm": [
13
11
  "@wtf/release-npm",
@@ -25,6 +23,14 @@
25
23
  "@wtf/release-cargo",
26
24
  "@wtf/semantic-release-cargo"
27
25
  ],
26
+ "go": [
27
+ "@wtf/release-go",
28
+ "@wtf/semantic-release-go"
29
+ ],
30
+ "maven": [
31
+ "@wtf/release-maven",
32
+ "@wtf/semantic-release-maven"
33
+ ],
28
34
  "docs": [
29
35
  "@wtf/release-docs"
30
36
  ]
@@ -1,16 +1,19 @@
1
1
  # Changelogs
2
2
 
3
- By default a train has one changelog, which `@semantic-release/changelog` writes from the notes of
4
- the release. `@wtf/semantic-release-trains-changelog` writes one changelog for each package of the
5
- train, from the commits that change the folder of that package:
3
+ Each train has its own changelog, written by `@semantic-release/changelog` from the notes of the
4
+ release. The trains plugin that wraps the release notes generator gives it the train's commits
5
+ alone, so the notes, and the changelog, are of that train. Wrap the changelog plugin too, and the
6
+ train gives it its file and title: the train's `changelog`, or the `CHANGELOG.md` of its first
7
+ path, under `# Changelog`. Wrap `@semantic-release/git`, and the train gives it the assets of its
8
+ release commit, the changelog among them, and a message of its name:
6
9
 
7
10
  ```js train=trains
8
11
  // release.config.mjs
9
- import { BREAKING, trainAssets, trainTagFormat } from '@wtf/semantic-release-trains/config'
12
+ import { BREAKING, trainTagFormat } from '@wtf/semantic-release-trains/config'
10
13
 
11
14
  const trains = {
12
15
  trains: {
13
- paths: ['packages/release-trains', 'packages/release-trains-*'],
16
+ paths: ['packages/release-trains', 'packages/semantic-release-trains'],
14
17
  changelog: 'CHANGELOG-trains.md'
15
18
  }
16
19
  }
@@ -24,84 +27,30 @@ export default {
24
27
  plugins: [
25
28
  ['@wtf/semantic-release-trains', { wrap: '@semantic-release/commit-analyzer' }],
26
29
  ['@wtf/semantic-release-trains', { wrap: '@semantic-release/release-notes-generator' }],
27
- ['@wtf/semantic-release-trains-changelog', { trainChangelog: 'CHANGELOG-trains.md' }],
28
- [
29
- '@semantic-release/git',
30
- { assets: trainAssets(trains, train, { changelogs: 'CHANGELOG.md' }) }
31
- ]
30
+ // CHANGELOG-trains.md, under `# Changelog`.
31
+ ['@wtf/semantic-release-trains', { wrap: '@semantic-release/changelog' }],
32
+ // The changelog and the generated folders, in `chore(release): trains <version>`.
33
+ ['@wtf/semantic-release-trains', { wrap: '@semantic-release/git' }]
32
34
  ]
33
35
  }
34
36
  ```
35
37
 
36
- In the `prepare` step, before the release commit, the plugin writes:
37
-
38
- - for each package of the train, the section of the release at the top of `<package>/CHANGELOG.md`,
39
- with only the commits that change the folder of the package. A package that no commit of the
40
- release changes gets no section;
41
- - of `trainChangelog`, the section of all the commits of the train in that file. The file of the
42
- train cannot be the changelog of one of its packages (`ECHANGELOG`).
43
-
44
- `trainAssets` of `@wtf/semantic-release-trains/config`, with `changelogs`, gives
45
- `@semantic-release/git` the changelogs to commit.
46
-
47
- With `file: false`, it writes the train's changelog alone, and no package gets one, as
48
- `@semantic-release/changelog` does, but a release run again, after a publish that failed, adds no
49
- section twice. Give it `trainChangelog`, or it has nothing to write (`ECHANGELOG`). Of one train
50
- of every package, as this repo releases:
51
-
52
- ```js train=release
53
- // release.config.mjs
54
- import { BREAKING, trainAssets } from '@wtf/semantic-release-trains/config'
55
-
56
- const trains = { release: { paths: ['packages/*'], changelog: 'CHANGELOG.md' } }
57
-
58
- export default {
59
- trains,
60
- ecosystems: ['@wtf/semantic-release-npm/ecosystem'],
61
- train: 'release',
62
- tagFormat: 'v${version}',
63
- ...BREAKING,
64
- plugins: [
65
- '@semantic-release/commit-analyzer',
66
- '@semantic-release/release-notes-generator',
67
- ['@wtf/semantic-release-trains-changelog', { file: false, trainChangelog: 'CHANGELOG.md' }],
68
- // With no `changelogs`, the train's changelog alone.
69
- ['@semantic-release/git', { assets: trainAssets(trains, 'release') }]
70
- ]
71
- }
72
- ```
73
-
74
- A section groups the commits by type. The breaking changes come first:
75
-
76
- ```md
77
- ## 2.0.0 (2026-10-30)
78
-
79
- ### BREAKING CHANGES
80
-
81
- - **release-trains:** Node 24 is the least. ([c1b2c3d](https://gitlab.com/wetryfun/release/release/-/commit/c1b2c3d…))
38
+ A release run again, after a publish that failed part way, writes no section twice: the wrapped
39
+ changelog plugin skips its `prepare` by the rule `section`, when the changelog has a heading of the
40
+ release already, the first heading of the notes of any date. The stock plugin alone writes it
41
+ again. `skip: { prepare: false }` turns it off; see
42
+ [skipping a step](../../semantic-release-trains/README.md#skipping-a-step) for the rule of any step.
82
43
 
83
- ### Features
44
+ An option the config gives a wrapped plugin wins over the train's: `wrap:
45
+ ['@semantic-release/changelog', { changelogFile: 'docs/CHANGES.md' }]`. Listed unwrapped, the
46
+ plugins take what the config gives them: `trainChangelog`, `TITLE` and `trainAssets` of
47
+ `@wtf/semantic-release-trains/config` give the same values to pass by hand.
84
48
 
85
- - **release-npm:** the smoke of every package packed ([a1b2c3d](https://gitlab.com/wetryfun/release/release/-/commit/a1b2c3d…))
86
- - **release-trains:** drop Node 22 ([c1b2c3d](https://gitlab.com/wetryfun/release/release/-/commit/c1b2c3d…))
87
-
88
- ### Bug Fixes
89
-
90
- - mend the order of the publish ([b1b2c3d](https://gitlab.com/wetryfun/release/release/-/commit/b1b2c3d…))
91
- ```
92
-
93
- A breaking change is a commit with a `BREAKING CHANGE:` footer, whose text it shows, or with a `!`
94
- after its type, whose subject it shows. Give each breaking commit the footer: see
49
+ The changelog plugin reads the notes, not the commits: the entry that wraps it is for its options.
50
+ A preset of the notes generator decides how a section looks: its types, their headings, and the breaking changes
51
+ first. Give each breaking commit a `BREAKING CHANGE:` footer as well as its `!`: see
95
52
  [the caveat](configuring-trains.md#a-preset-and-type).
96
53
 
97
- | Option | Default | What it is |
98
- | ---------------- | ------------------------------ | ---------------------------------------------------------------- |
99
- | `file` | `CHANGELOG.md` | The changelog of each package, in its folder, or `false`. |
100
- | `title` | `# Changelog` | The title of each changelog. |
101
- | `types` | features, fixes, perf, reverts | The types that a section shows, each with its heading, in order. |
102
- | `repositoryUrl` | the run's | The repository whose commit pages each line links to. |
103
- | `trainChangelog` | none | The changelog of the train, of all its commits. |
104
-
105
54
  ## The train in the heading
106
55
 
107
56
  The notes of a release are headed by its version alone: `## [4.0.0](…) (2026-11-02)`, as the
@@ -125,6 +74,7 @@ each train's own: a second `@semantic-release/changelog` writes the same notes a
125
74
  // release.config.mjs
126
75
  import {
127
76
  BREAKING,
77
+ TITLE,
128
78
  trainAssets,
129
79
  trainChangelog,
130
80
  trainTagFormat
@@ -148,55 +98,12 @@ export default {
148
98
  { wrap: '@semantic-release/release-notes-generator', heading: 'train' }
149
99
  ],
150
100
  // The train's own changelog, then the changelog of every train.
151
- ['@semantic-release/changelog', { changelogFile: trainChangelog(trains, train) }],
152
- ['@semantic-release/changelog', { changelogFile: 'CHANGELOG.md' }],
101
+ [
102
+ '@semantic-release/changelog',
103
+ { changelogFile: trainChangelog(trains, train), changelogTitle: TITLE }
104
+ ],
105
+ ['@semantic-release/changelog', { changelogFile: 'CHANGELOG.md', changelogTitle: TITLE }],
153
106
  ['@semantic-release/git', { assets: [...trainAssets(trains, train), 'CHANGELOG.md'] }]
154
107
  ]
155
108
  }
156
109
  ```
157
-
158
- ## As a library
159
-
160
- `@wtf/release-trains-changelog` is the library the plugin runs, of no release tool. `./write`
161
- writes the changelogs of a release, by the `system` its caller gives it, as a CLI passes its own:
162
-
163
- ```ts
164
- import npm from '@wtf/release-npm'
165
- import type { System } from '@wtf/release-system/system'
166
- import { writeChangelogs } from '@wtf/release-trains-changelog/write'
167
-
168
- export function writeTrains(system: System, commits: { hash: string; message: string }[]) {
169
- return writeChangelogs({
170
- trains: { trains: { paths: ['packages/release-trains', 'packages/release-trains-*'] } },
171
- train: 'trains',
172
- // The packages of each train, of each package.json, as the ecosystem of npm reads them.
173
- ecosystems: [npm],
174
- version: '1.2.0',
175
- commits,
176
- system
177
- })
178
- }
179
- ```
180
-
181
- `./render` renders and reads sections, with no git and no system:
182
-
183
- ```ts
184
- import {
185
- changelogSection,
186
- prependSection,
187
- renderSection
188
- } from '@wtf/release-trains-changelog/render'
189
-
190
- const section = renderSection(
191
- [
192
- { hash: 'a1b2c3d4e5f6', message: 'feat(semantic-release-trains): the option cascade' },
193
- { hash: 'b1b2c3d4e5f6', message: 'chore: tidy' }
194
- ],
195
- { version: '1.2.0', date: '2026-10-30', types: [['feat', 'Features']] }
196
- )
197
- const changelog = prependSection('# Changelog\n\n## 1.1.0 (2026-10-01)\n\n- older\n', section)
198
-
199
- export const latest = changelogSection(changelog, '1.2.0') // the section of 1.2.0, to the next heading
200
- ```
201
-
202
- `changelogSection` also reads the headings of `@semantic-release/changelog`.
@@ -347,30 +347,33 @@ version outside a range that its last release published releases too, of no comm
347
347
 
348
348
  ```js train=docs
349
349
  // release.config.mjs
350
+ import { trainChangelog } from '@wtf/semantic-release-trains/config'
351
+
352
+ const trains = {
353
+ system: { paths: ['packages/release-system'] },
354
+ trains: { paths: ['packages/release-trains', 'packages/semantic-release-trains'] },
355
+ replace: { paths: ['packages/release-replace', 'packages/semantic-release-replace'] },
356
+ validate: { paths: ['packages/release-validate', 'packages/semantic-release-validate'] },
357
+ docs: {
358
+ paths: ['packages/docs'],
359
+ generated: ['packages/docs/api'],
360
+ // Say the docs package lists none of the packages it documents: it releases after them.
361
+ dependsOn: ['system', 'trains', 'replace', 'validate']
362
+ }
363
+ }
350
364
  const train = process.env.RELEASE_TRAIN
351
365
  const docs = train === 'docs'
352
366
 
353
367
  export default {
354
368
  ecosystems: ['@wtf/semantic-release-npm/ecosystem'],
355
- trains: {
356
- system: { paths: ['packages/release-system'] },
357
- trains: { paths: ['packages/release-trains', 'packages/semantic-release-trains'] },
358
- replace: { paths: ['packages/release-replace', 'packages/semantic-release-replace'] },
359
- validate: { paths: ['packages/release-validate', 'packages/semantic-release-validate'] },
360
- docs: {
361
- paths: ['packages/docs'],
362
- generated: ['packages/docs/api'],
363
- // Say the docs package lists none of the packages it documents: it releases after them.
364
- dependsOn: ['system', 'trains', 'replace', 'validate']
365
- }
366
- },
369
+ trains,
367
370
  tagFormat: `${train}-v\${version}`,
368
371
  parserOpts: { breakingHeaderPattern: '^(\\w*)(?:\\((.*)\\))?!: (.*)$' },
369
372
  dependencies: 'fail',
370
373
  plugins: [
371
374
  ['@wtf/semantic-release-trains', { wrap: '@semantic-release/commit-analyzer' }],
372
375
  ['@wtf/semantic-release-trains', { wrap: '@semantic-release/release-notes-generator' }],
373
- '@wtf/semantic-release-trains-changelog',
376
+ ['@semantic-release/changelog', { changelogFile: trainChangelog(trains, train) }],
374
377
  // The reference of docs, built and staged: the plugins of no other train's run.
375
378
  ...(docs
376
379
  ? [
@@ -244,6 +244,7 @@ URL; one that cannot be loaded, or whose default export is no ecosystem, fails w
244
244
  import {
245
245
  BRANCHES,
246
246
  BREAKING,
247
+ TITLE,
247
248
  trainAssets,
248
249
  trainChangelog,
249
250
  trainTagFormat
@@ -278,15 +279,17 @@ export default {
278
279
  '@wtf/semantic-release-trains',
279
280
  { wrap: ['@semantic-release/release-notes-generator', { preset: 'conventionalcommits' }] }
280
281
  ],
281
- // The changelog of each package, and of the train, each of no section twice: a release run
282
- // again after a publish that failed writes none again.
283
- ['@wtf/semantic-release-trains-changelog', { trainChangelog: trainChangelog(trains, train) }],
282
+ // The changelog of the train, of the notes of the train's commits.
283
+ [
284
+ '@semantic-release/changelog',
285
+ { changelogFile: trainChangelog(trains, train), changelogTitle: TITLE }
286
+ ],
284
287
  '@wtf/semantic-release-npm',
285
288
  ['@wtf/semantic-release-trains', { generated: true }],
286
289
  [
287
290
  '@semantic-release/git',
288
291
  {
289
- assets: trainAssets(trains, train, { changelogs: 'CHANGELOG.md' }),
292
+ assets: trainAssets(trains, train),
290
293
  message: `chore(release): ${train} \${nextRelease.version}`
291
294
  }
292
295
  ],