@wtf/release-docs 8.1.0 → 8.2.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 (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 +19 -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
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: ModuleExport
8
8
 
9
- Defined in: [packages/semantic-release-replace/src/schema.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L58)
9
+ Defined in: [packages/semantic-release-replace/src/schema.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L58)
10
10
 
11
11
  An export of a module, as a config of JSON names a function, a template or a set of templates of
12
12
  one: the module, by its path from the root of the repo or the name of a package, and the name of
@@ -18,7 +18,7 @@ its export, `default` by default.
18
18
 
19
19
  > `readonly` `optional` **export?**: `string`
20
20
 
21
- Defined in: [packages/semantic-release-replace/src/schema.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L62)
21
+ Defined in: [packages/semantic-release-replace/src/schema.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L62)
22
22
 
23
23
  The name of its export: `default` by default.
24
24
 
@@ -28,6 +28,6 @@ The name of its export: `default` by default.
28
28
 
29
29
  > `readonly` **module**: `string`
30
30
 
31
- Defined in: [packages/semantic-release-replace/src/schema.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L60)
31
+ Defined in: [packages/semantic-release-replace/src/schema.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L60)
32
32
 
33
33
  The module, by its path from the root of the repo (`./`, `../` or absolute), or a package.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: ReplaceOptions
8
8
 
9
- Defined in: [packages/semantic-release-replace/src/schema.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L90)
9
+ Defined in: [packages/semantic-release-replace/src/schema.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L90)
10
10
 
11
11
  The options of an entry of the plugin.
12
12
 
@@ -20,7 +20,7 @@ The options of an entry of the plugin.
20
20
 
21
21
  > `readonly` **files**: readonly `string`[]
22
22
 
23
- Defined in: [packages/semantic-release-replace/src/schema.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L96)
23
+ Defined in: [packages/semantic-release-replace/src/schema.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L96)
24
24
 
25
25
  The files, from the root of the repo, of the files git tracks, in order: each a path, a glob,
26
26
  or of `!` first a negation of what the entries before it hold. A folder holds each file under
@@ -32,7 +32,7 @@ it.
32
32
 
33
33
  > `readonly` **replacements**: readonly [`PluginReplacementSpec`](../type-aliases/PluginReplacementSpec.md)[]
34
34
 
35
- Defined in: [packages/semantic-release-replace/src/schema.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L101)
35
+ Defined in: [packages/semantic-release-replace/src/schema.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L101)
36
36
 
37
37
  The replacements of each file, in order: each whole; or of a template, `{ template, … }`, each
38
38
  option beside its name over the template's own; or the name of a template alone.
@@ -43,7 +43,7 @@ option beside its name over the template's own; or the name of a template alone.
43
43
 
44
44
  > `readonly` `optional` **templates?**: [`TemplatesOption`](../type-aliases/TemplatesOption.md)
45
45
 
46
- Defined in: [packages/semantic-release-replace/src/schema.ts:106](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L106)
46
+ Defined in: [packages/semantic-release-replace/src/schema.ts:106](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L106)
47
47
 
48
48
  The templates a replacement names, each by its name, over those of the root of the config of
49
49
  the same name: a set, or sets merged in order; none by default.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: RootTemplates
8
8
 
9
- Defined in: [packages/semantic-release-replace/src/schema.ts:278](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L278)
9
+ Defined in: [packages/semantic-release-replace/src/schema.ts:278](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L278)
10
10
 
11
11
  The root of a config, as the plugin reads it: its `templates`, which every entry may name.
12
12
 
@@ -16,6 +16,6 @@ The root of a config, as the plugin reads it: its `templates`, which every entry
16
16
 
17
17
  > `readonly` `optional` **templates?**: [`TemplatesOption`](../type-aliases/TemplatesOption.md)
18
18
 
19
- Defined in: [packages/semantic-release-replace/src/schema.ts:280](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L280)
19
+ Defined in: [packages/semantic-release-replace/src/schema.ts:280](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L280)
20
20
 
21
21
  The templates of every entry of the plugin: a set, or sets merged in order.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > **PluginReplacement** = [`ReplacementOf`](../../../release-replace/interfaces/ReplacementOf.md)\<[`PluginTo`](PluginTo.md)\>
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/schema.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L72)
11
+ Defined in: [packages/semantic-release-replace/src/schema.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L72)
12
12
 
13
13
  A replacement of the plugin: what it matches, what it replaces each match by, and its escape.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > **PluginReplacementSpec** = [`ReplacementSpec`](../../../release-replace/type-aliases/ReplacementSpec.md)\<[`PluginTo`](PluginTo.md)\>
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/schema.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L75)
11
+ Defined in: [packages/semantic-release-replace/src/schema.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L75)
12
12
 
13
13
  A replacement of the plugin as its options list it: whole, or of a template.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > **PluginTemplates** = [`Templates`](../../../release-replace/type-aliases/Templates.md)\<[`PluginTo`](PluginTo.md)\>
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/schema.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L78)
11
+ Defined in: [packages/semantic-release-replace/src/schema.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L78)
12
12
 
13
13
  The templates of the plugin, each a replacement, by its name, as the library takes them.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **PluginTo** = `string` \| [`ModuleExport`](../interfaces/ModuleExport.md) \| [`ReplaceFunction`](../../../release-replace/type-aliases/ReplaceFunction.md)
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/schema.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L69)
11
+ Defined in: [packages/semantic-release-replace/src/schema.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L69)
12
12
 
13
13
  What a replacement of the plugin replaces each match by: a text; a function of a module, which
14
14
  the plugin imports; or a function, of a config of JavaScript.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **TemplateSet** = [`ModuleExport`](../interfaces/ModuleExport.md) \| `Readonly`\<`Record`\<`string`, [`PluginReplacement`](PluginReplacement.md) \| [`ModuleExport`](../interfaces/ModuleExport.md)\>\>
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/schema.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L84)
11
+ Defined in: [packages/semantic-release-replace/src/schema.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L84)
12
12
 
13
13
  A set of templates as a config gives it: each by its name, a replacement or the export of a
14
14
  module that is one; or the export of a module that is a set of replacements, each by its name.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > **TemplatesOption** = [`TemplateSet`](TemplateSet.md) \| readonly [`TemplateSet`](TemplateSet.md)[]
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/schema.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L87)
11
+ Defined in: [packages/semantic-release-replace/src/schema.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L87)
12
12
 
13
13
  The templates as a config gives them: a set, or sets merged in order, each over those before.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **configSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<`object`\>
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/schema.ts:292](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L292)
11
+ Defined in: [packages/semantic-release-replace/src/schema.ts:292](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L292)
12
12
 
13
13
  This package's part of a whole config of semantic-release: `templates` of its root, and each
14
14
  entry of `plugins` of the plugin.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **exportedSetSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<`Record`\<`string`, [`PluginReplacement`](../type-aliases/PluginReplacement.md)\>\>
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/schema.ts:209](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L209)
11
+ Defined in: [packages/semantic-release-replace/src/schema.ts:209](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L209)
12
12
 
13
13
  The validator of a set of templates a module exports: each a replacement whole, by its name.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **jsonSchema**: [`JsonSchema`](../../../release-system/validator/type-aliases/JsonSchema.md)
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/schema.ts:298](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L298)
11
+ Defined in: [packages/semantic-release-replace/src/schema.ts:298](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L298)
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` **replaceOptionsSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`ReplaceOptions`](../interfaces/ReplaceOptions.md)\>
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/schema.ts:253](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L253)
11
+ Defined in: [packages/semantic-release-replace/src/schema.ts:253](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L253)
12
12
 
13
13
  The validator of the options of an entry of the plugin: `files` and `replacements`, required.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **replacementSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`PluginReplacementSpec`](../type-aliases/PluginReplacementSpec.md)\>
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/schema.ts:162](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L162)
11
+ Defined in: [packages/semantic-release-replace/src/schema.ts:162](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L162)
12
12
 
13
13
  The validator of a replacement: whole, of `from`, `flags`, `to` and `escape`; of a template,
14
14
  `{ template, … }`; or the name of a template alone. Which template a name is of is the run's to
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **rootTemplatesSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`RootTemplates`](../interfaces/RootTemplates.md)\>
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/schema.ts:284](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L284)
11
+ Defined in: [packages/semantic-release-replace/src/schema.ts:284](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L284)
12
12
 
13
13
  The validator of the root of a config, as the plugin reads it: `templates`, optional.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **templateSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`PluginReplacement`](../type-aliases/PluginReplacement.md)\>
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/schema.ts:202](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L202)
11
+ Defined in: [packages/semantic-release-replace/src/schema.ts:202](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L202)
12
12
 
13
13
  The validator of a replacement whole a template is, as a module exports one: its `to` a text, a
14
14
  function or the function of a module; a RegExp that is one, and no escape of a function.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **templatesSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`TemplatesOption`](../type-aliases/TemplatesOption.md)\>
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/schema.ts:243](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L243)
11
+ Defined in: [packages/semantic-release-replace/src/schema.ts:243](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/schema.ts#L243)
12
12
 
13
13
  The validator of the templates of a config, of its root or of an entry of the plugin: a set, or
14
14
  an array of sets, merged in order, each over those before it.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **default**: `object`
10
10
 
11
- Defined in: [packages/semantic-release-replace/src/index.ts:327](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/index.ts#L327)
11
+ Defined in: [packages/semantic-release-replace/src/index.ts:327](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-replace/src/index.ts#L327)
12
12
 
13
13
  ## Type Declaration
14
14
 
@@ -14,7 +14,14 @@ plugin: which plugins a run has, of which options and in which order, is the con
14
14
 
15
15
  ```js
16
16
  // release.config.mjs
17
- import { BRANCHES, BREAKING, trainAssets, trainTagFormat } from '@wtf/semantic-release-trains/config'
17
+ import {
18
+ BRANCHES,
19
+ BREAKING,
20
+ TITLE,
21
+ trainAssets,
22
+ trainChangelog,
23
+ trainTagFormat
24
+ } from '@wtf/semantic-release-trains/config'
18
25
 
19
26
  const trains = {
20
27
  trains: { paths: ['packages/release-trains', 'packages/semantic-release-trains'] },
@@ -34,9 +41,9 @@ export default {
34
41
  plugins: [
35
42
  ['@wtf/semantic-release-trains', { wrap: '@semantic-release/commit-analyzer' }],
36
43
  ['@wtf/semantic-release-trains', { wrap: '@semantic-release/release-notes-generator' }],
37
- '@wtf/semantic-release-trains-changelog',
44
+ ['@semantic-release/changelog', { changelogFile: trainChangelog(trains, train), changelogTitle: TITLE }],
38
45
  '@wtf/semantic-release-npm',
39
- ['@semantic-release/git', { assets: trainAssets(trains, train, { changelogs: 'CHANGELOG.md' }) }],
46
+ ['@semantic-release/git', { assets: trainAssets(trains, train) }],
40
47
  ['@wtf/semantic-release-trains', { wrap: '@semantic-release/gitlab' }]
41
48
  ]
42
49
  }
@@ -51,6 +58,7 @@ export default {
51
58
 
52
59
  - [BRANCHES](variables/BRANCHES.md)
53
60
  - [BREAKING](variables/BREAKING.md)
61
+ - [TITLE](variables/TITLE.md)
54
62
 
55
63
  ## Functions
56
64
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **skipPlugins**\<`T`\>(`plugins`, `pattern`, `options`): `T`[]
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/config.ts:258](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L258)
11
+ Defined in: [packages/semantic-release-trains/src/config.ts:270](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L270)
12
12
 
13
13
  The entries of `plugins` but those whose step id ([stepId](stepId.md)) `pattern` matches, the source
14
14
  of a RegExp, unanchored, so `exec` matches every step of `@semantic-release/exec`: pin the end of a
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **stepId**(`entry`): `string`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/config.ts:192](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L192)
11
+ Defined in: [packages/semantic-release-trains/src/config.ts:204](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L204)
12
12
 
13
13
  The id of the step of an entry of `plugins`, as [skipPlugins](skipPlugins.md) matches it: the plugin's name,
14
14
  of a string; of an entry with options, `<name>:<the plugin it wraps>`, of an entry of `wrap`,
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **trainAssets**(`trains`, `train`, `options?`): (`string` \| `string`[])[]
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/config.ts:130](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L130)
11
+ Defined in: [packages/semantic-release-trains/src/config.ts:142](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L142)
12
12
 
13
13
  The `assets` of @semantic-release/git of the train `train` of `trains`: its changelog, the
14
14
  changelog of each of its packages of `changelogs`, the file of each of `replaced`, and each folder
@@ -8,11 +8,10 @@
8
8
 
9
9
  > **trainChangelog**(`trains`, `train`): `string` \| `undefined`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/config.ts:100](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L100)
11
+ Defined in: [packages/semantic-release-trains/src/config.ts:112](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L112)
12
12
 
13
- The changelog of the train `train` of `trains`, from the root of the repo, as `trainChangelog` of
14
- @wtf/semantic-release-trains-changelog, which writes no section twice of a release run again, or
15
- `changelogFile` of @semantic-release/changelog: its own, or `<first path>/CHANGELOG.md`;
13
+ The changelog of the train `train` of `trains`, from the root of the repo, as `changelogFile` of
14
+ @semantic-release/changelog: its own, or `<first path>/CHANGELOG.md`;
16
15
  `undefined` of a train of none. Throws `ETRAINNOTSELECTED` and `ETRAINUNKNOWN`.
17
16
 
18
17
  ## Parameters
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **trainOfTag**(`trains`, `tag`): `string` \| `undefined`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/config.ts:175](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L175)
11
+ Defined in: [packages/semantic-release-trains/src/config.ts:187](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L187)
12
12
 
13
13
  The name of the train of `trains` whose tag format names the tag `tag`, as a config of a release
14
14
  in two steps names the train of the run of the tag, `RELEASE_TAG`, which
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **trainTagFormat**(`trains`, `train`): `string`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/config.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L85)
11
+ Defined in: [packages/semantic-release-trains/src/config.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L92)
12
12
 
13
13
  The tag format of the train `train` of `trains`, as `tagFormat` of a config: its own, or
14
14
  `<train>-v${version}`. Throws `ETRAINNOTSELECTED` and `ETRAINUNKNOWN`.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: AssetsOptions
8
8
 
9
- Defined in: [packages/semantic-release-trains/src/config.ts:106](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L106)
9
+ Defined in: [packages/semantic-release-trains/src/config.ts:118](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L118)
10
10
 
11
11
  What [trainAssets](../functions/trainAssets.md) lists of a train.
12
12
 
@@ -16,7 +16,7 @@ What [trainAssets](../functions/trainAssets.md) lists of a train.
16
16
 
17
17
  > `readonly` `optional` **changelog?**: `boolean`
18
18
 
19
- Defined in: [packages/semantic-release-trains/src/config.ts:108](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L108)
19
+ Defined in: [packages/semantic-release-trains/src/config.ts:120](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L120)
20
20
 
21
21
  The train's own changelog, of [trainChangelog](../functions/trainChangelog.md): `true`.
22
22
 
@@ -26,7 +26,7 @@ The train's own changelog, of [trainChangelog](../functions/trainChangelog.md):
26
26
 
27
27
  > `readonly` `optional` **changelogs?**: `string`
28
28
 
29
- Defined in: [packages/semantic-release-trains/src/config.ts:110](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L110)
29
+ Defined in: [packages/semantic-release-trains/src/config.ts:122](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L122)
30
30
 
31
31
  The changelog of each package, by its file name, as the changelog plugin writes it: none.
32
32
 
@@ -36,7 +36,7 @@ The changelog of each package, by its file name, as the changelog plugin writes
36
36
 
37
37
  > `readonly` `optional` **replaced?**: `string`
38
38
 
39
- Defined in: [packages/semantic-release-trains/src/config.ts:115](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L115)
39
+ Defined in: [packages/semantic-release-trains/src/config.ts:127](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L127)
40
40
 
41
41
  The files of each package a plugin writes in `prepare`, by their file name, as the `README.md`
42
42
  whose badge `@wtf/semantic-release-replace` replaces: none.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: SkipOptions
8
8
 
9
- Defined in: [packages/semantic-release-trains/src/config.ts:212](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L212)
9
+ Defined in: [packages/semantic-release-trains/src/config.ts:224](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L224)
10
10
 
11
11
  How [skipPlugins](../functions/skipPlugins.md) skips.
12
12
 
@@ -16,7 +16,7 @@ How [skipPlugins](../functions/skipPlugins.md) skips.
16
16
 
17
17
  > `readonly` **log**: (`line`) => `void`
18
18
 
19
- Defined in: [packages/semantic-release-trains/src/config.ts:221](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L221)
19
+ Defined in: [packages/semantic-release-trains/src/config.ts:233](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L233)
20
20
 
21
21
  Where it says what it kept and left out, which it requires: a config, as the root of its run,
22
22
  gives it, as of `process.stderr`.
@@ -39,6 +39,6 @@ The line it says: the pattern, the steps it left out and those it kept.
39
39
 
40
40
  > `readonly` `optional` **required?**: readonly `string`[]
41
41
 
42
- Defined in: [packages/semantic-release-trains/src/config.ts:214](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L214)
42
+ Defined in: [packages/semantic-release-trains/src/config.ts:226](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L226)
43
43
 
44
44
  The names of the plugins it may not leave out, as the one that makes the release commit.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **BRANCHES**: readonly \[`"main"`, \{ `name`: `"rc"`; `prerelease`: `true`; \}, \{ `name`: `"pre"`; `prerelease`: `true`; \}, \{ `name`: `"beta"`; `prerelease`: `true`; \}, \{ `name`: `"alpha"`; `prerelease`: `true`; \}\]
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/config.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L58)
11
+ Defined in: [packages/semantic-release-trains/src/config.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L65)
12
12
 
13
13
  The branches a train releases from, as `branches` of a config: `main`, and the prereleases `rc`,
14
14
  `pre`, `beta` and `alpha`, each of its own channel. Keep them in step with the rules of the
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **BREAKING**: `object`
10
10
 
11
- Defined in: [packages/semantic-release-trains/src/config.ts:73](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains/src/config.ts#L73)
11
+ Defined in: [packages/semantic-release-trains/src/config.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L80)
12
12
 
13
13
  The parser options that read `type!:` and `type(scope)!:` as a breaking change, of a preset that
14
14
  does not, as the default `angular`: spread at the root of the config, so semantic-release gives
@@ -0,0 +1,14 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/semantic-release-trains/config](../README.md) / TITLE
6
+
7
+ # Variable: TITLE
8
+
9
+ > `const` **TITLE**: `"# Changelog"` = `'# Changelog'`
10
+
11
+ Defined in: [packages/semantic-release-trains/src/config.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/config.ts#L101)
12
+
13
+ The title of a changelog, `changelogTitle` of @semantic-release/changelog: the first line of the
14
+ file, which each release's section goes under.
@@ -0,0 +1,42 @@
1
+ [**Release trains**](../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../README.md) / @wtf/semantic-release-trains/defaults
6
+
7
+ # @wtf/semantic-release-trains/defaults
8
+
9
+ What the train of a run gives a plugin an entry wraps: options of a plugin of semantic-release
10
+ that the train decides, as the file of its changelog and the assets of its release commit, and a
11
+ step of the plugin that has nothing left to do, which the entry skips, as a changelog that has the
12
+ section of the release already. The entry passes the options under the options of the root of the
13
+ config and under its own, so a config that names one names its own.
14
+
15
+ ```js
16
+ // release.config.mjs: the changelog of the train and its release commit, of the train.
17
+ plugins: [
18
+ ['@wtf/semantic-release-trains', { wrap: '@semantic-release/changelog' }],
19
+ ['@wtf/semantic-release-trains', { wrap: '@semantic-release/git' }]
20
+ ]
21
+ ```
22
+
23
+ ## Interfaces
24
+
25
+ - [SkipContext](interfaces/SkipContext.md)
26
+
27
+ ## Type Aliases
28
+
29
+ - [SkipCheck](type-aliases/SkipCheck.md)
30
+ - [TrainOptions](type-aliases/TrainOptions.md)
31
+
32
+ ## Variables
33
+
34
+ - [SKIP\_RULES](variables/SKIP_RULES.md)
35
+ - [TRAIN\_OPTIONS](variables/TRAIN_OPTIONS.md)
36
+ - [TRAIN\_SKIP](variables/TRAIN_SKIP.md)
37
+
38
+ ## Functions
39
+
40
+ - [skipRuleOf](functions/skipRuleOf.md)
41
+ - [skips](functions/skips.md)
42
+ - [trainOptionsOf](functions/trainOptionsOf.md)
@@ -0,0 +1,40 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/semantic-release-trains/defaults](../README.md) / skipRuleOf
6
+
7
+ # Function: skipRuleOf()
8
+
9
+ > **skipRuleOf**(`plugin`, `step`, `skip?`): `SkipRule`
10
+
11
+ Defined in: [packages/semantic-release-trains/src/defaults.ts:146](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/defaults.ts#L146)
12
+
13
+ The rule of the step `step` of the plugin `plugin`: of the entry's `skip`, else of
14
+ [TRAIN\_SKIP](../variables/TRAIN_SKIP.md); `false` of none.
15
+
16
+ ## Parameters
17
+
18
+ ### plugin
19
+
20
+ `string`
21
+
22
+ The name of the plugin an entry wraps.
23
+
24
+ ### step
25
+
26
+ `SkipStep`
27
+
28
+ The step.
29
+
30
+ ### skip?
31
+
32
+ `Readonly`\<`Partial`\<`Record`\<`SkipStep`, `SkipRule`\>\>\> = `{}`
33
+
34
+ The entry's own rules, by their steps.
35
+
36
+ ## Returns
37
+
38
+ `SkipRule`
39
+
40
+ The rule of the step.
@@ -0,0 +1,42 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/semantic-release-trains/defaults](../README.md) / skips
6
+
7
+ # Function: skips()
8
+
9
+ > **skips**(`rule`, `context`, `load`): `Promise`\<`boolean`\>
10
+
11
+ Defined in: [packages/semantic-release-trains/src/defaults.ts:165](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/defaults.ts#L165)
12
+
13
+ Whether the rule `rule` skips the step of `context`: `true` and `false` as they are; a rule of
14
+ [SKIP\_RULES](../variables/SKIP_RULES.md) by its name; else the default export of the module it names, loaded by `load`,
15
+ a [SkipCheck](../type-aliases/SkipCheck.md), of the options the rule gives it. Throws `EOPTIONS` of a module whose default
16
+ export is no function.
17
+
18
+ ## Parameters
19
+
20
+ ### rule
21
+
22
+ `SkipRule`
23
+
24
+ The rule.
25
+
26
+ ### context
27
+
28
+ [`SkipContext`](../interfaces/SkipContext.md)
29
+
30
+ The step, the options of the plugin, the release and the system of the run.
31
+
32
+ ### load
33
+
34
+ (`name`) => `Promise`\<`unknown`\>
35
+
36
+ What loads a module by its name, as `import()` does, of the repo.
37
+
38
+ ## Returns
39
+
40
+ `Promise`\<`boolean`\>
41
+
42
+ Whether the entry skips the step.
@@ -0,0 +1,40 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/semantic-release-trains/defaults](../README.md) / trainOptionsOf
6
+
7
+ # Function: trainOptionsOf()
8
+
9
+ > **trainOptionsOf**(`plugin`, `trains`, `train`): `Readonly`\<`Record`\<`string`, `unknown`\>\>
10
+
11
+ Defined in: [packages/semantic-release-trains/src/defaults.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-trains/src/defaults.ts#L92)
12
+
13
+ The options the train `train` of `trains` gives the plugin `plugin`, by its name: none of a plugin
14
+ [TRAIN\_OPTIONS](../variables/TRAIN_OPTIONS.md) does not name.
15
+
16
+ ## Parameters
17
+
18
+ ### plugin
19
+
20
+ `string`
21
+
22
+ The name of the plugin an entry wraps.
23
+
24
+ ### trains
25
+
26
+ [`Trains`](../../../release-trains/type-aliases/Trains.md)
27
+
28
+ The trains of the repo, by their names.
29
+
30
+ ### train
31
+
32
+ `string`
33
+
34
+ The name of the train of the run.
35
+
36
+ ## Returns
37
+
38
+ `Readonly`\<`Record`\<`string`, `unknown`\>\>
39
+
40
+ Its options of the train.