@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: StampedWorkspace
8
8
 
9
- Defined in: [packages/release-cargo/src/stamp.ts:381](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-cargo/src/stamp.ts#L381)
9
+ Defined in: [packages/release-cargo/src/stamp.ts:381](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/stamp.ts#L381)
10
10
 
11
11
  The result of stamping a workspace: the manifests written, and the values in them.
12
12
 
@@ -16,7 +16,7 @@ The result of stamping a workspace: the manifests written, and the values in the
16
16
 
17
17
  > `readonly` **changes**: `number`
18
18
 
19
- Defined in: [packages/release-cargo/src/stamp.ts:385](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-cargo/src/stamp.ts#L385)
19
+ Defined in: [packages/release-cargo/src/stamp.ts:385](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/stamp.ts#L385)
20
20
 
21
21
  The values written.
22
22
 
@@ -26,6 +26,6 @@ The values written.
26
26
 
27
27
  > `readonly` **files**: readonly `string`[]
28
28
 
29
- Defined in: [packages/release-cargo/src/stamp.ts:383](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-cargo/src/stamp.ts#L383)
29
+ Defined in: [packages/release-cargo/src/stamp.ts:383](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/stamp.ts#L383)
30
30
 
31
31
  The manifests whose text changed, absolute.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > **DependencyKind** = `"normal"` \| `"build"` \| `"dev"`
10
10
 
11
- Defined in: [packages/release-cargo/src/index.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-cargo/src/index.ts#L24)
11
+ Defined in: [packages/release-cargo/src/index.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/index.ts#L24)
12
12
 
13
13
  How a crate depends on another: the dependencies of its build and its run, or its tests'.
@@ -0,0 +1,34 @@
1
+ [**Release trains**](../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../README.md) / @wtf/release-go
6
+
7
+ # @wtf/release-go
8
+
9
+ The Go modules of a repo released in trains, of no release tool. Its default export is the
10
+ ecosystem of Go, `goEcosystem` of `./ecosystem`, which a config of the trains names in
11
+ `ecosystems` as `'@wtf/release-go'`, so the trains read the modules of the repo by it; and this
12
+ module holds the type of a module, which the modules of this package do with: each go.mod of the
13
+ repo, read, selected and checked against the major of a release (`./modules`), the line reader of
14
+ a go.mod (`./gomod`), the versions of the trains written into each `require` (`./stamp`), and the
15
+ tags of a release, on a commit of the stamped go.mod files, pushed to the remote and asked of the
16
+ Go proxy (`./tags`). Each function takes the `System` it runs by, and runs `git` and `go` through
17
+ it.
18
+
19
+ ```ts
20
+ import type { GoModule } from '@wtf/release-go'
21
+
22
+ // The paths of the modules, as a release lists them.
23
+ export const pathsOf = (modules: readonly GoModule[]): string[] => modules.map(({ path }) => path)
24
+ ```
25
+
26
+ ## Interfaces
27
+
28
+ - [GoModule](interfaces/GoModule.md)
29
+
30
+ ## References
31
+
32
+ ### default
33
+
34
+ Renames and re-exports [goEcosystem](ecosystem/variables/goEcosystem.md)
@@ -0,0 +1,40 @@
1
+ [**Release trains**](../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../README.md) / @wtf/release-go/ecosystem
6
+
7
+ # @wtf/release-go/ecosystem
8
+
9
+ The ecosystem of Go ([goEcosystem](variables/goEcosystem.md)), as the trains read it, and the default export of the
10
+ package, which a config names in `ecosystems` as `'@wtf/release-go'`: the modules of the repo,
11
+ each go.mod git tracks ([packagesOfModules](functions/packagesOfModules.md)), of the working tree or of a commit; a repo of
12
+ no go.mod has none. A requirement of Go is a version, which minimal version selection reads as
13
+ that version or a later one of the same major ([satisfiesVersion](functions/satisfiesVersion.md)); a release publishes the
14
+ version itself, of a `v` ([resolveVersion](functions/resolveVersion.md)).
15
+
16
+ ```js
17
+ // release.config.mjs
18
+ export default {
19
+ trains: {
20
+ core: { paths: ['core'] },
21
+ cli: { paths: ['cli'] }
22
+ },
23
+ ecosystems: ['@wtf/release-go']
24
+ }
25
+ ```
26
+
27
+ ## Interfaces
28
+
29
+ - [GoPackage](interfaces/GoPackage.md)
30
+
31
+ ## Variables
32
+
33
+ - [goEcosystem](variables/goEcosystem.md)
34
+
35
+ ## Functions
36
+
37
+ - [packagesOfModules](functions/packagesOfModules.md)
38
+ - [packagesOfRepo](functions/packagesOfRepo.md)
39
+ - [resolveVersion](functions/resolveVersion.md)
40
+ - [satisfiesVersion](functions/satisfiesVersion.md)
@@ -0,0 +1,30 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-go/ecosystem](../README.md) / packagesOfModules
6
+
7
+ # Function: packagesOfModules()
8
+
9
+ > **packagesOfModules**(`modules`): [`GoPackage`](../interfaces/GoPackage.md)[]
10
+
11
+ Defined in: [packages/release-go/src/ecosystem.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/ecosystem.ts#L49)
12
+
13
+ The modules of the repo as the trains read them: each a package named by its module path, of its
14
+ folder and its go.mod; published when Go can fetch it, as the first element of its path has a dot
15
+ (`isFetchable` of `./modules`); and each `require` of another module of the repo a dependency of
16
+ the kind `runtime`, Go's one kind, of the version it writes as its range.
17
+
18
+ ## Parameters
19
+
20
+ ### modules
21
+
22
+ readonly [`GoModule`](../../interfaces/GoModule.md)[]
23
+
24
+ The modules of the repo, as `readModules` of `./modules` gives them.
25
+
26
+ ## Returns
27
+
28
+ [`GoPackage`](../interfaces/GoPackage.md)[]
29
+
30
+ The packages, one of each module, in the order of `modules`.
@@ -0,0 +1,32 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-go/ecosystem](../README.md) / packagesOfRepo
6
+
7
+ # Function: packagesOfRepo()
8
+
9
+ > **packagesOfRepo**(`context`): `Promise`\<[`GoPackage`](../interfaces/GoPackage.md)[]\>
10
+
11
+ Defined in: [packages/release-go/src/ecosystem.ts:104](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/ecosystem.ts#L104)
12
+
13
+ The modules of the repo of `context` as the trains read them, of the commit `ref` where it names
14
+ one, else of the working tree.
15
+
16
+ ## Parameters
17
+
18
+ ### context
19
+
20
+ [`EcosystemContext`](../../../release-trains/ecosystem/interfaces/EcosystemContext.md)
21
+
22
+ The folder of the repo, its environment, the system, and the commit.
23
+
24
+ ## Returns
25
+
26
+ `Promise`\<[`GoPackage`](../interfaces/GoPackage.md)[]\>
27
+
28
+ The packages, one of each module.
29
+
30
+ ## Throws
31
+
32
+ `EGOMOD` of a go.mod of no module, and of two of one path; `EGIT` of a commit git has not.
@@ -0,0 +1,35 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-go/ecosystem](../README.md) / resolveVersion
6
+
7
+ # Function: resolveVersion()
8
+
9
+ > **resolveVersion**(`_requirement`, `version`): `string`
10
+
11
+ Defined in: [packages/release-go/src/ecosystem.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/ecosystem.ts#L78)
12
+
13
+ The version a release requires of a module of `version`, the release of its train, as the stamp
14
+ writes it into each `require` of it: `v1.4.0` of `1.4.0`. The stamp writes it whatever the
15
+ requirement was, so `requirement` names none of it.
16
+
17
+ ## Parameters
18
+
19
+ ### \_requirement
20
+
21
+ `string`
22
+
23
+ The version a go.mod requires before the stamp, as `v0.0.0`.
24
+
25
+ ### version
26
+
27
+ `string`
28
+
29
+ The release of the module it requires, as `1.4.0`.
30
+
31
+ ## Returns
32
+
33
+ `string`
34
+
35
+ The version the release requires, as `v1.4.0`.
@@ -0,0 +1,35 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-go/ecosystem](../README.md) / satisfiesVersion
6
+
7
+ # Function: satisfiesVersion()
8
+
9
+ > **satisfiesVersion**(`requirement`, `version`): `boolean`
10
+
11
+ Defined in: [packages/release-go/src/ecosystem.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/ecosystem.ts#L89)
12
+
13
+ Whether `version` is within `requirement`, by Go's minimal version selection: of the major the
14
+ requirement names, and the same or later, prereleases by the order of semver, as `1.5.0-beta.1`
15
+ of `v1.4.0`. A requirement or a version that is no semver, of a `v` or none, takes none.
16
+
17
+ ## Parameters
18
+
19
+ ### requirement
20
+
21
+ `string`
22
+
23
+ The version a go.mod requires, as `v1.4.0`.
24
+
25
+ ### version
26
+
27
+ `string`
28
+
29
+ The version, as `1.5.0`.
30
+
31
+ ## Returns
32
+
33
+ `boolean`
34
+
35
+ Whether the requirement takes the version.
@@ -0,0 +1,97 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-go/ecosystem](../README.md) / GoPackage
6
+
7
+ # Interface: GoPackage
8
+
9
+ Defined in: [packages/release-go/src/ecosystem.ts:35](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/ecosystem.ts#L35)
10
+
11
+ A module as the trains read it: a package of the trains, and the module it is of.
12
+
13
+ ## Extends
14
+
15
+ - [`Package`](../../../release-trains/ecosystem/interfaces/Package.md)
16
+
17
+ ## Properties
18
+
19
+ ### dependencies
20
+
21
+ > `readonly` **dependencies**: readonly [`Dependency`](../../../release-trains/ecosystem/interfaces/Dependency.md)[]
22
+
23
+ Defined in: [packages/release-trains/src/ecosystem.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-trains/src/ecosystem.ts#L76)
24
+
25
+ Its dependencies on the other packages of its ecosystem in the repo.
26
+
27
+ #### Inherited from
28
+
29
+ [`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`dependencies`](../../../release-trains/ecosystem/interfaces/Package.md#dependencies)
30
+
31
+ ***
32
+
33
+ ### dir
34
+
35
+ > `readonly` **dir**: `string`
36
+
37
+ Defined in: [packages/release-trains/src/ecosystem.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-trains/src/ecosystem.ts#L67)
38
+
39
+ Its folder, from the root of the repo, as `packages/core`; `.` of the root. A train holds it
40
+ when the train's `paths` hold this folder.
41
+
42
+ #### Inherited from
43
+
44
+ [`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`dir`](../../../release-trains/ecosystem/interfaces/Package.md#dir)
45
+
46
+ ***
47
+
48
+ ### manifest
49
+
50
+ > `readonly` **manifest**: `string`
51
+
52
+ Defined in: [packages/release-trains/src/ecosystem.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-trains/src/ecosystem.ts#L69)
53
+
54
+ Its manifest, from the root of the repo, as `packages/core/package.json`.
55
+
56
+ #### Inherited from
57
+
58
+ [`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`manifest`](../../../release-trains/ecosystem/interfaces/Package.md#manifest)
59
+
60
+ ***
61
+
62
+ ### module
63
+
64
+ > `readonly` **module**: [`GoModule`](../../interfaces/GoModule.md)
65
+
66
+ Defined in: [packages/release-go/src/ecosystem.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/ecosystem.ts#L37)
67
+
68
+ The module, as `readModules` of `./modules` gives it.
69
+
70
+ ***
71
+
72
+ ### name
73
+
74
+ > `readonly` **name**: `string`
75
+
76
+ Defined in: [packages/release-trains/src/ecosystem.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-trains/src/ecosystem.ts#L62)
77
+
78
+ Its name, the one its ecosystem's registry knows it by: unique of the ecosystem in the repo.
79
+
80
+ #### Inherited from
81
+
82
+ [`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`name`](../../../release-trains/ecosystem/interfaces/Package.md#name)
83
+
84
+ ***
85
+
86
+ ### published
87
+
88
+ > `readonly` **published**: `boolean`
89
+
90
+ Defined in: [packages/release-trains/src/ecosystem.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-trains/src/ecosystem.ts#L74)
91
+
92
+ Whether a release publishes it: not of an npm package that is private, nor of a crate of
93
+ `publish = false`.
94
+
95
+ #### Inherited from
96
+
97
+ [`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`published`](../../../release-trains/ecosystem/interfaces/Package.md#published)
@@ -0,0 +1,15 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-go/ecosystem](../README.md) / goEcosystem
6
+
7
+ # Variable: goEcosystem
8
+
9
+ > `const` **goEcosystem**: [`Ecosystem`](../../../release-trains/ecosystem/interfaces/Ecosystem.md)
10
+
11
+ Defined in: [packages/release-go/src/ecosystem.ts:115](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/ecosystem.ts#L115)
12
+
13
+ The ecosystem of Go: its packages, the modules of the repo, of the working tree or of a commit
14
+ ([packagesOfRepo](../functions/packagesOfRepo.md)); a requirement published as the stamp writes it
15
+ ([resolveVersion](../functions/resolveVersion.md)); and Go's rules of requirements ([satisfiesVersion](../functions/satisfiesVersion.md)).
@@ -0,0 +1,25 @@
1
+ [**Release trains**](../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../README.md) / @wtf/release-go/errors
6
+
7
+ # @wtf/release-go/errors
8
+
9
+ What the release of Go modules throws: [GoError](classes/GoError.md), a `ReleaseError` of
10
+ `@wtf/release-system/errors` of the codes of [GO\_ERRORS](variables/GO_ERRORS.md), which semantic-release prints by
11
+ its mark, beside the codes of the options of a plugin, its `SYSTEM_ERRORS` (`EOPTIONS`). What is
12
+ the same of every ecosystem, as a dependency on a module of no train or of a train with no
13
+ release, is the trains' own, `TRAINS_ERRORS` of `@wtf/release-trains/errors`.
14
+
15
+ ## Classes
16
+
17
+ - [GoError](classes/GoError.md)
18
+
19
+ ## Type Aliases
20
+
21
+ - [GoErrorCode](type-aliases/GoErrorCode.md)
22
+
23
+ ## Variables
24
+
25
+ - [GO\_ERRORS](variables/GO_ERRORS.md)
@@ -0,0 +1,268 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-go/errors](../README.md) / GoError
6
+
7
+ # Class: GoError
8
+
9
+ Defined in: [packages/release-go/src/errors.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/errors.ts#L39)
10
+
11
+ An error of the Go modules, or of the options of the plugin over them: a stable `code`, of
12
+ [GO\_ERRORS](../variables/GO_ERRORS.md) or of `SYSTEM_ERRORS` of `@wtf/release-system/errors`, its `message` what is
13
+ wrong, and its `details` how to fix it.
14
+
15
+ ## Extends
16
+
17
+ - [`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md)
18
+
19
+ ## Constructors
20
+
21
+ ### Constructor
22
+
23
+ > **new GoError**(`code`, `message`, `details`): `GoError`
24
+
25
+ Defined in: [packages/release-system/src/errors.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-system/src/errors.ts#L54)
26
+
27
+ An error of `code`, of its `message` and its `details`, named `SemanticReleaseError`, as
28
+ semantic-release prints one.
29
+
30
+ #### Parameters
31
+
32
+ ##### code
33
+
34
+ `string`
35
+
36
+ The stable code of the error, as `EGIT`.
37
+
38
+ ##### message
39
+
40
+ `string`
41
+
42
+ What is wrong, as a reader is told it.
43
+
44
+ ##### details
45
+
46
+ `string`
47
+
48
+ How to fix it, of the steps a reader takes.
49
+
50
+ #### Returns
51
+
52
+ `GoError`
53
+
54
+ #### Inherited from
55
+
56
+ [`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`constructor`](../../../release-system/errors/classes/ReleaseError.md#constructor)
57
+
58
+ ## Properties
59
+
60
+ ### cause?
61
+
62
+ > `optional` **cause?**: `unknown`
63
+
64
+ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24
65
+
66
+ #### Inherited from
67
+
68
+ [`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`cause`](../../../release-system/errors/classes/ReleaseError.md#cause)
69
+
70
+ ***
71
+
72
+ ### code
73
+
74
+ > `readonly` **code**: `string`
75
+
76
+ Defined in: [packages/release-system/src/errors.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-system/src/errors.ts#L40)
77
+
78
+ The stable code of the error, as `EGIT`.
79
+
80
+ #### Inherited from
81
+
82
+ [`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`code`](../../../release-system/errors/classes/ReleaseError.md#code)
83
+
84
+ ***
85
+
86
+ ### details
87
+
88
+ > `readonly` **details**: `string`
89
+
90
+ Defined in: [packages/release-system/src/errors.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-system/src/errors.ts#L42)
91
+
92
+ How to fix it.
93
+
94
+ #### Inherited from
95
+
96
+ [`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`details`](../../../release-system/errors/classes/ReleaseError.md#details)
97
+
98
+ ***
99
+
100
+ ### message
101
+
102
+ > **message**: `string`
103
+
104
+ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1075
105
+
106
+ #### Inherited from
107
+
108
+ [`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`message`](../../../release-system/errors/classes/ReleaseError.md#message)
109
+
110
+ ***
111
+
112
+ ### name
113
+
114
+ > **name**: `string`
115
+
116
+ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1074
117
+
118
+ #### Inherited from
119
+
120
+ [`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`name`](../../../release-system/errors/classes/ReleaseError.md#name)
121
+
122
+ ***
123
+
124
+ ### semanticRelease
125
+
126
+ > `readonly` **semanticRelease**: `true`
127
+
128
+ Defined in: [packages/release-system/src/errors.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-system/src/errors.ts#L44)
129
+
130
+ The mark semantic-release prints an error of a plugin by.
131
+
132
+ #### Inherited from
133
+
134
+ [`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`semanticRelease`](../../../release-system/errors/classes/ReleaseError.md#semanticrelease)
135
+
136
+ ***
137
+
138
+ ### stack?
139
+
140
+ > `optional` **stack?**: `string`
141
+
142
+ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
143
+
144
+ #### Inherited from
145
+
146
+ [`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`stack`](../../../release-system/errors/classes/ReleaseError.md#stack)
147
+
148
+ ***
149
+
150
+ ### stackTraceLimit
151
+
152
+ > `static` **stackTraceLimit**: `number`
153
+
154
+ Defined in: node\_modules/.pnpm/@types+node@24.19.2/node\_modules/@types/node/globals.d.ts:68
155
+
156
+ The `Error.stackTraceLimit` property specifies the number of stack frames
157
+ collected by a stack trace (whether generated by `new Error().stack` or
158
+ `Error.captureStackTrace(obj)`).
159
+
160
+ The default value is `10` but may be set to any valid JavaScript number. Changes
161
+ will affect any stack trace captured _after_ the value has been changed.
162
+
163
+ If set to a non-number value, or set to a negative number, stack traces will
164
+ not capture any frames.
165
+
166
+ #### Inherited from
167
+
168
+ [`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`stackTraceLimit`](../../../release-system/errors/classes/ReleaseError.md#stacktracelimit)
169
+
170
+ ## Methods
171
+
172
+ ### captureStackTrace()
173
+
174
+ > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
175
+
176
+ Defined in: node\_modules/.pnpm/@types+node@24.19.2/node\_modules/@types/node/globals.d.ts:52
177
+
178
+ Creates a `.stack` property on `targetObject`, which when accessed returns
179
+ a string representing the location in the code at which
180
+ `Error.captureStackTrace()` was called.
181
+
182
+ ```js
183
+ const myObject = {};
184
+ Error.captureStackTrace(myObject);
185
+ myObject.stack; // Similar to `new Error().stack`
186
+ ```
187
+
188
+ The first line of the trace will be prefixed with
189
+ `${myObject.name}: ${myObject.message}`.
190
+
191
+ The optional `constructorOpt` argument accepts a function. If given, all frames
192
+ above `constructorOpt`, including `constructorOpt`, will be omitted from the
193
+ generated stack trace.
194
+
195
+ The `constructorOpt` argument is useful for hiding implementation
196
+ details of error generation from the user. For instance:
197
+
198
+ ```js
199
+ function a() {
200
+ b();
201
+ }
202
+
203
+ function b() {
204
+ c();
205
+ }
206
+
207
+ function c() {
208
+ // Create an error without stack trace to avoid calculating the stack trace twice.
209
+ const { stackTraceLimit } = Error;
210
+ Error.stackTraceLimit = 0;
211
+ const error = new Error();
212
+ Error.stackTraceLimit = stackTraceLimit;
213
+
214
+ // Capture the stack trace above function b
215
+ Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
216
+ throw error;
217
+ }
218
+
219
+ a();
220
+ ```
221
+
222
+ #### Parameters
223
+
224
+ ##### targetObject
225
+
226
+ `object`
227
+
228
+ ##### constructorOpt?
229
+
230
+ `Function`
231
+
232
+ #### Returns
233
+
234
+ `void`
235
+
236
+ #### Inherited from
237
+
238
+ [`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`captureStackTrace`](../../../release-system/errors/classes/ReleaseError.md#capturestacktrace)
239
+
240
+ ***
241
+
242
+ ### prepareStackTrace()
243
+
244
+ > `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
245
+
246
+ Defined in: node\_modules/.pnpm/@types+node@24.19.2/node\_modules/@types/node/globals.d.ts:56
247
+
248
+ #### Parameters
249
+
250
+ ##### err
251
+
252
+ `Error`
253
+
254
+ ##### stackTraces
255
+
256
+ `CallSite`[]
257
+
258
+ #### Returns
259
+
260
+ `any`
261
+
262
+ #### See
263
+
264
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
265
+
266
+ #### Inherited from
267
+
268
+ [`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`prepareStackTrace`](../../../release-system/errors/classes/ReleaseError.md#preparestacktrace)
@@ -0,0 +1,13 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-go/errors](../README.md) / GoErrorCode
6
+
7
+ # Type Alias: GoErrorCode
8
+
9
+ > **GoErrorCode** = keyof *typeof* [`GO_ERRORS`](../variables/GO_ERRORS.md)
10
+
11
+ Defined in: [packages/release-go/src/errors.ts:32](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/errors.ts#L32)
12
+
13
+ A code of [GO\_ERRORS](../variables/GO_ERRORS.md).