@wtf/release-docs 8.1.0 → 8.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (606) hide show
  1. package/README.md +12 -4
  2. package/api/.generated +155 -29
  3. package/api/@wtf/release-cargo/auth/functions/mask.md +1 -1
  4. package/api/@wtf/release-cargo/auth/functions/tokenVariableOf.md +1 -1
  5. package/api/@wtf/release-cargo/auth/functions/trustedPublishing.md +1 -1
  6. package/api/@wtf/release-cargo/auth/interfaces/HttpResponse.md +5 -5
  7. package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishing.md +5 -5
  8. package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishingOptions.md +6 -6
  9. package/api/@wtf/release-cargo/auth/type-aliases/HttpFetch.md +1 -1
  10. package/api/@wtf/release-cargo/auth/variables/CRATES_IO_API.md +1 -1
  11. package/api/@wtf/release-cargo/auth/variables/ID_TOKEN_VARIABLE.md +1 -1
  12. package/api/@wtf/release-cargo/auth/variables/USER_AGENT.md +1 -1
  13. package/api/@wtf/release-cargo/crates/functions/publishOrder.md +1 -1
  14. package/api/@wtf/release-cargo/crates/functions/publishable.md +1 -1
  15. package/api/@wtf/release-cargo/crates/functions/readWorkspace.md +1 -1
  16. package/api/@wtf/release-cargo/crates/functions/selectCrates.md +5 -4
  17. package/api/@wtf/release-cargo/crates/interfaces/Selection.md +5 -5
  18. package/api/@wtf/release-cargo/ecosystem/functions/packagesAt.md +1 -1
  19. package/api/@wtf/release-cargo/ecosystem/functions/packagesOfTree.md +1 -1
  20. package/api/@wtf/release-cargo/ecosystem/functions/packagesOfWorkspace.md +1 -1
  21. package/api/@wtf/release-cargo/ecosystem/functions/resolveRequirement.md +1 -1
  22. package/api/@wtf/release-cargo/ecosystem/functions/satisfiesRequirement.md +1 -1
  23. package/api/@wtf/release-cargo/ecosystem/functions/semverRange.md +1 -1
  24. package/api/@wtf/release-cargo/ecosystem/interfaces/CargoPackage.md +7 -7
  25. package/api/@wtf/release-cargo/ecosystem/variables/cargoEcosystem.md +1 -1
  26. package/api/@wtf/release-cargo/errors/classes/CargoError.md +5 -5
  27. package/api/@wtf/release-cargo/errors/type-aliases/CargoErrorCode.md +1 -1
  28. package/api/@wtf/release-cargo/errors/variables/CARGO_ERRORS.md +2 -2
  29. package/api/@wtf/release-cargo/interfaces/Crate.md +6 -6
  30. package/api/@wtf/release-cargo/interfaces/CrateDependency.md +6 -6
  31. package/api/@wtf/release-cargo/interfaces/Workspace.md +3 -3
  32. package/api/@wtf/release-cargo/publish/functions/publishCrates.md +1 -1
  33. package/api/@wtf/release-cargo/publish/interfaces/PublishCratesOptions.md +11 -11
  34. package/api/@wtf/release-cargo/publish/interfaces/PublishedCrate.md +5 -5
  35. package/api/@wtf/release-cargo/publish/type-aliases/CrateStatus.md +1 -1
  36. package/api/@wtf/release-cargo/publish/variables/RECHECK_WAITS.md +1 -1
  37. package/api/@wtf/release-cargo/registry/functions/crateUrl.md +1 -1
  38. package/api/@wtf/release-cargo/registry/functions/indexHasVersion.md +1 -1
  39. package/api/@wtf/release-cargo/registry/functions/indexPath.md +1 -1
  40. package/api/@wtf/release-cargo/registry/variables/CRATES_IO_INDEX.md +1 -1
  41. package/api/@wtf/release-cargo/stamp/functions/checkVersions.md +1 -1
  42. package/api/@wtf/release-cargo/stamp/functions/inheritsVersion.md +1 -1
  43. package/api/@wtf/release-cargo/stamp/functions/stampManifest.md +1 -1
  44. package/api/@wtf/release-cargo/stamp/functions/stampWorkspace.md +1 -1
  45. package/api/@wtf/release-cargo/stamp/interfaces/StampOptions.md +4 -4
  46. package/api/@wtf/release-cargo/stamp/interfaces/Stamped.md +3 -3
  47. package/api/@wtf/release-cargo/stamp/interfaces/StampedWorkspace.md +3 -3
  48. package/api/@wtf/release-cargo/type-aliases/DependencyKind.md +1 -1
  49. package/api/@wtf/release-go/README.md +34 -0
  50. package/api/@wtf/release-go/ecosystem/README.md +40 -0
  51. package/api/@wtf/release-go/ecosystem/functions/packagesOfModules.md +30 -0
  52. package/api/@wtf/release-go/ecosystem/functions/packagesOfRepo.md +32 -0
  53. package/api/@wtf/release-go/ecosystem/functions/resolveVersion.md +35 -0
  54. package/api/@wtf/release-go/ecosystem/functions/satisfiesVersion.md +35 -0
  55. package/api/@wtf/release-go/ecosystem/interfaces/GoPackage.md +97 -0
  56. package/api/@wtf/release-go/ecosystem/variables/goEcosystem.md +15 -0
  57. package/api/@wtf/release-go/errors/README.md +25 -0
  58. package/api/@wtf/release-go/errors/classes/GoError.md +268 -0
  59. package/api/@wtf/release-go/errors/type-aliases/GoErrorCode.md +13 -0
  60. package/api/@wtf/release-go/errors/variables/GO_ERRORS.md +47 -0
  61. package/api/@wtf/release-go/gomod/README.md +39 -0
  62. package/api/@wtf/release-go/gomod/functions/entriesOf.md +29 -0
  63. package/api/@wtf/release-go/gomod/functions/linesOf.md +27 -0
  64. package/api/@wtf/release-go/gomod/functions/readGoMod.md +28 -0
  65. package/api/@wtf/release-go/gomod/functions/tokensOf.md +29 -0
  66. package/api/@wtf/release-go/gomod/interfaces/Entry.md +41 -0
  67. package/api/@wtf/release-go/gomod/interfaces/GoMod.md +41 -0
  68. package/api/@wtf/release-go/gomod/interfaces/GoReplace.md +61 -0
  69. package/api/@wtf/release-go/gomod/interfaces/GoRequire.md +41 -0
  70. package/api/@wtf/release-go/gomod/interfaces/Token.md +51 -0
  71. package/api/@wtf/release-go/interfaces/GoModule.md +61 -0
  72. package/api/@wtf/release-go/modules/README.md +39 -0
  73. package/api/@wtf/release-go/modules/functions/isFetchable.md +28 -0
  74. package/api/@wtf/release-go/modules/functions/isGoMod.md +28 -0
  75. package/api/@wtf/release-go/modules/functions/majorErrors.md +37 -0
  76. package/api/@wtf/release-go/modules/functions/majorOfPath.md +28 -0
  77. package/api/@wtf/release-go/modules/functions/modulesAt.md +39 -0
  78. package/api/@wtf/release-go/modules/functions/modulesOf.md +29 -0
  79. package/api/@wtf/release-go/modules/functions/readModules.md +33 -0
  80. package/api/@wtf/release-go/modules/functions/selectModules.md +44 -0
  81. package/api/@wtf/release-go/modules/interfaces/Selection.md +43 -0
  82. package/api/@wtf/release-go/stamp/README.md +44 -0
  83. package/api/@wtf/release-go/stamp/functions/checkVersions.md +38 -0
  84. package/api/@wtf/release-go/stamp/functions/stampGoMod.md +35 -0
  85. package/api/@wtf/release-go/stamp/functions/stampModules.md +42 -0
  86. package/api/@wtf/release-go/stamp/interfaces/Stamped.md +31 -0
  87. package/api/@wtf/release-go/stamp/interfaces/StampedModules.md +31 -0
  88. package/api/@wtf/release-go/tags/README.md +48 -0
  89. package/api/@wtf/release-go/tags/functions/askProxy.md +44 -0
  90. package/api/@wtf/release-go/tags/functions/maskCredentials.md +28 -0
  91. package/api/@wtf/release-go/tags/functions/releaseCommit.md +48 -0
  92. package/api/@wtf/release-go/tags/functions/remoteTags.md +43 -0
  93. package/api/@wtf/release-go/tags/functions/tagModules.md +36 -0
  94. package/api/@wtf/release-go/tags/functions/tagOfModule.md +34 -0
  95. package/api/@wtf/release-go/tags/functions/tagPrefix.md +29 -0
  96. package/api/@wtf/release-go/tags/interfaces/TagModulesOptions.md +93 -0
  97. package/api/@wtf/release-go/tags/interfaces/TaggedModule.md +51 -0
  98. package/api/@wtf/release-go/tags/type-aliases/ModuleStatus.md +13 -0
  99. package/api/@wtf/release-go/tags/variables/RELEASE_AUTHOR.md +23 -0
  100. package/api/@wtf/release-maven/README.md +33 -0
  101. package/api/@wtf/release-maven/artifacts/README.md +41 -0
  102. package/api/@wtf/release-maven/artifacts/functions/groupIdOf.md +33 -0
  103. package/api/@wtf/release-maven/artifacts/functions/installsOf.md +44 -0
  104. package/api/@wtf/release-maven/artifacts/functions/isPomFile.md +28 -0
  105. package/api/@wtf/release-maven/artifacts/functions/isRange.md +27 -0
  106. package/api/@wtf/release-maven/artifacts/functions/modulesOf.md +44 -0
  107. package/api/@wtf/release-maven/artifacts/functions/nameOf.md +33 -0
  108. package/api/@wtf/release-maven/artifacts/functions/publishOrder.md +34 -0
  109. package/api/@wtf/release-maven/artifacts/functions/readModules.md +31 -0
  110. package/api/@wtf/release-maven/artifacts/functions/readPoms.md +32 -0
  111. package/api/@wtf/release-maven/artifacts/functions/selectArtifacts.md +44 -0
  112. package/api/@wtf/release-maven/artifacts/interfaces/Selection.md +42 -0
  113. package/api/@wtf/release-maven/ecosystem/README.md +41 -0
  114. package/api/@wtf/release-maven/ecosystem/functions/compareVersions.md +38 -0
  115. package/api/@wtf/release-maven/ecosystem/functions/parseRange.md +28 -0
  116. package/api/@wtf/release-maven/ecosystem/functions/resolveVersion.md +36 -0
  117. package/api/@wtf/release-maven/ecosystem/functions/satisfiesVersion.md +36 -0
  118. package/api/@wtf/release-maven/ecosystem/interfaces/Bound.md +31 -0
  119. package/api/@wtf/release-maven/ecosystem/interfaces/Restriction.md +31 -0
  120. package/api/@wtf/release-maven/ecosystem/variables/mavenEcosystem.md +15 -0
  121. package/api/@wtf/release-maven/errors/README.md +25 -0
  122. package/api/@wtf/release-maven/errors/classes/MavenError.md +268 -0
  123. package/api/@wtf/release-maven/errors/type-aliases/MavenErrorCode.md +13 -0
  124. package/api/@wtf/release-maven/errors/variables/MAVEN_ERRORS.md +51 -0
  125. package/api/@wtf/release-maven/interfaces/MavenModule.md +169 -0
  126. package/api/@wtf/release-maven/pom/README.md +48 -0
  127. package/api/@wtf/release-maven/pom/functions/childOf.md +33 -0
  128. package/api/@wtf/release-maven/pom/functions/childrenOf.md +33 -0
  129. package/api/@wtf/release-maven/pom/functions/dependencyOf.md +27 -0
  130. package/api/@wtf/release-maven/pom/functions/escapeXml.md +27 -0
  131. package/api/@wtf/release-maven/pom/functions/parseXml.md +39 -0
  132. package/api/@wtf/release-maven/pom/functions/readPom.md +39 -0
  133. package/api/@wtf/release-maven/pom/functions/textAt.md +34 -0
  134. package/api/@wtf/release-maven/pom/interfaces/Pom.md +151 -0
  135. package/api/@wtf/release-maven/pom/interfaces/PomDependency.md +51 -0
  136. package/api/@wtf/release-maven/pom/interfaces/PomParent.md +41 -0
  137. package/api/@wtf/release-maven/pom/interfaces/PomPlugin.md +51 -0
  138. package/api/@wtf/release-maven/pom/interfaces/PomRepository.md +31 -0
  139. package/api/@wtf/release-maven/pom/interfaces/Span.md +35 -0
  140. package/api/@wtf/release-maven/pom/interfaces/XmlElement.md +83 -0
  141. package/api/@wtf/release-maven/pom/variables/PLUGIN_GROUP.md +13 -0
  142. package/api/@wtf/release-maven/publish/README.md +45 -0
  143. package/api/@wtf/release-maven/publish/functions/deployModules.md +35 -0
  144. package/api/@wtf/release-maven/publish/interfaces/DeployModulesOptions.md +146 -0
  145. package/api/@wtf/release-maven/publish/interfaces/DeployedModule.md +42 -0
  146. package/api/@wtf/release-maven/publish/type-aliases/ModuleStatus.md +13 -0
  147. package/api/@wtf/release-maven/repository/README.md +38 -0
  148. package/api/@wtf/release-maven/repository/functions/deployTargets.md +46 -0
  149. package/api/@wtf/release-maven/repository/functions/expandValues.md +42 -0
  150. package/api/@wtf/release-maven/repository/functions/hasPom.md +38 -0
  151. package/api/@wtf/release-maven/repository/functions/pomPath.md +40 -0
  152. package/api/@wtf/release-maven/repository/functions/pomUrl.md +45 -0
  153. package/api/@wtf/release-maven/repository/interfaces/Repository.md +31 -0
  154. package/api/@wtf/release-maven/repository/interfaces/ValuesOf.md +31 -0
  155. package/api/@wtf/release-maven/repository/variables/MAVEN_CENTRAL.md +13 -0
  156. package/api/@wtf/release-maven/stamp/README.md +50 -0
  157. package/api/@wtf/release-maven/stamp/functions/checkVersions.md +36 -0
  158. package/api/@wtf/release-maven/stamp/functions/stampModules.md +55 -0
  159. package/api/@wtf/release-maven/stamp/functions/stampPom.md +45 -0
  160. package/api/@wtf/release-maven/stamp/interfaces/PomStampOptions.md +51 -0
  161. package/api/@wtf/release-maven/stamp/interfaces/Stamped.md +31 -0
  162. package/api/@wtf/release-maven/stamp/interfaces/StampedModules.md +31 -0
  163. package/api/@wtf/release-npm/check/functions/checkPackages.md +1 -1
  164. package/api/@wtf/release-npm/check/functions/formatIssue.md +1 -1
  165. package/api/@wtf/release-npm/check/interfaces/CheckOptions.md +6 -6
  166. package/api/@wtf/release-npm/check/interfaces/Issue.md +5 -5
  167. package/api/@wtf/release-npm/check/type-aliases/CheckedPackage.md +1 -1
  168. package/api/@wtf/release-npm/check/type-aliases/IssueCode.md +1 -1
  169. package/api/@wtf/release-npm/ecosystem/variables/npmEcosystem.md +1 -1
  170. package/api/@wtf/release-npm/errors/type-aliases/NpmErrorCode.md +1 -1
  171. package/api/@wtf/release-npm/errors/variables/NPM_ERRORS.md +1 -1
  172. package/api/@wtf/release-npm/interfaces/Lookup.md +3 -3
  173. package/api/@wtf/release-npm/interfaces/PublishOptions.md +6 -6
  174. package/api/@wtf/release-npm/interfaces/PublishPackage.md +5 -5
  175. package/api/@wtf/release-npm/interfaces/PublishTrainOptions.md +13 -13
  176. package/api/@wtf/release-npm/interfaces/Publisher.md +7 -7
  177. package/api/@wtf/release-npm/interfaces/PublisherContext.md +7 -7
  178. package/api/@wtf/release-npm/manifests/functions/concreteRange.md +1 -1
  179. package/api/@wtf/release-npm/manifests/functions/manifestsAt.md +1 -1
  180. package/api/@wtf/release-npm/manifests/functions/packageOf.md +1 -1
  181. package/api/@wtf/release-npm/manifests/functions/packagesOfManifests.md +1 -1
  182. package/api/@wtf/release-npm/manifests/functions/readManifests.md +1 -1
  183. package/api/@wtf/release-npm/manifests/functions/resolveSpecifier.md +1 -1
  184. package/api/@wtf/release-npm/manifests/functions/runtimeDependenciesOf.md +1 -1
  185. package/api/@wtf/release-npm/manifests/functions/satisfiesRange.md +1 -1
  186. package/api/@wtf/release-npm/manifests/interfaces/Manifest.md +5 -5
  187. package/api/@wtf/release-npm/manifests/interfaces/NpmPackage.md +7 -7
  188. package/api/@wtf/release-npm/manifests/type-aliases/DependencyField.md +1 -1
  189. package/api/@wtf/release-npm/manifests/variables/DEPENDENCY_FIELDS.md +1 -1
  190. package/api/@wtf/release-npm/manifests/variables/FIELD_KINDS.md +1 -1
  191. package/api/@wtf/release-npm/manifests/variables/RUNTIME_FIELDS.md +1 -1
  192. package/api/@wtf/release-npm/prepare/functions/isTypeScriptSource.md +1 -1
  193. package/api/@wtf/release-npm/prepare/functions/prepareManifest.md +1 -1
  194. package/api/@wtf/release-npm/prepare/functions/stripSourceConditions.md +1 -1
  195. package/api/@wtf/release-npm/prepare/interfaces/PrepareOptions.md +5 -5
  196. package/api/@wtf/release-npm/prepare/interfaces/PreparedManifest.md +6 -6
  197. package/api/@wtf/release-npm/prepare/variables/SOURCE_CONDITIONS.md +1 -1
  198. package/api/@wtf/release-npm/publishers/functions/builtInPublisher.md +1 -1
  199. package/api/@wtf/release-npm/publishers/functions/isPublisher.md +1 -1
  200. package/api/@wtf/release-npm/publishers/variables/NPM_REGISTRY.md +1 -1
  201. package/api/@wtf/release-npm/publishers/variables/PUBLISHERS.md +1 -1
  202. package/api/@wtf/release-npm/publishers/variables/npmPublisher.md +1 -1
  203. package/api/@wtf/release-npm/publishers/variables/pnpmPublisher.md +1 -1
  204. package/api/@wtf/release-npm/release/functions/checkTrain.md +1 -1
  205. package/api/@wtf/release-npm/release/functions/distTagOf.md +1 -1
  206. package/api/@wtf/release-npm/release/functions/packTrain.md +1 -1
  207. package/api/@wtf/release-npm/release/functions/publishPacked.md +1 -1
  208. package/api/@wtf/release-npm/release/functions/publishTrain.md +1 -1
  209. package/api/@wtf/release-npm/release/functions/publishedOf.md +1 -1
  210. package/api/@wtf/release-npm/release/functions/publishedOfResolved.md +1 -1
  211. package/api/@wtf/release-npm/release/functions/releaseTrain.md +1 -1
  212. package/api/@wtf/release-npm/release/functions/resolveManifests.md +1 -1
  213. package/api/@wtf/release-npm/release/functions/tagTrain.md +1 -1
  214. package/api/@wtf/release-npm/release/interfaces/CheckRelease.md +16 -16
  215. package/api/@wtf/release-npm/release/interfaces/PackOptions.md +8 -8
  216. package/api/@wtf/release-npm/release/interfaces/PackedTrain.md +12 -12
  217. package/api/@wtf/release-npm/release/interfaces/PublishRun.md +11 -11
  218. package/api/@wtf/release-npm/release/interfaces/PublishedOf.md +4 -4
  219. package/api/@wtf/release-npm/release/interfaces/PublishedPackage.md +7 -7
  220. package/api/@wtf/release-npm/release/interfaces/PublishedTrain.md +5 -5
  221. package/api/@wtf/release-npm/release/interfaces/ResolveRelease.md +17 -17
  222. package/api/@wtf/release-npm/release/interfaces/ResolvedPackage.md +4 -4
  223. package/api/@wtf/release-npm/release/interfaces/ResolvedTrain.md +6 -6
  224. package/api/@wtf/release-npm/release/interfaces/TagRelease.md +14 -14
  225. package/api/@wtf/release-npm/release/type-aliases/LookedUpTrain.md +1 -1
  226. package/api/@wtf/release-npm/release/type-aliases/ReleaseRun.md +1 -1
  227. package/api/@wtf/release-npm/release/variables/ID_TOKENS.md +1 -1
  228. package/api/@wtf/release-npm/release/variables/RUNNER_ENVIRONMENTS.md +1 -1
  229. package/api/@wtf/release-npm/workspace/functions/pnpmWorkspaceGlobs.md +1 -1
  230. package/api/@wtf/release-npm/workspace/functions/publishableOf.md +1 -1
  231. package/api/@wtf/release-npm/workspace/functions/readWorkspace.md +1 -1
  232. package/api/@wtf/release-npm/workspace/functions/workspaceFolders.md +1 -1
  233. package/api/@wtf/release-npm/workspace/functions/workspaceGlobs.md +1 -1
  234. package/api/@wtf/release-npm/workspace/interfaces/WorkspaceGlobs.md +3 -3
  235. package/api/@wtf/release-npm/workspace/interfaces/WorkspaceOptions.md +2 -2
  236. package/api/@wtf/release-replace/errors/classes/ReplaceError.md +5 -5
  237. package/api/@wtf/release-replace/errors/type-aliases/ReplaceErrorCode.md +1 -1
  238. package/api/@wtf/release-replace/errors/variables/REPLACE_ERRORS.md +1 -1
  239. package/api/@wtf/release-replace/files/functions/filesMatcher.md +1 -1
  240. package/api/@wtf/release-replace/interfaces/ReplaceMatch.md +5 -5
  241. package/api/@wtf/release-replace/interfaces/ReplacementOf.md +5 -5
  242. package/api/@wtf/release-replace/replace/functions/regExpOf.md +1 -1
  243. package/api/@wtf/release-replace/replace/functions/replaceFiles.md +1 -1
  244. package/api/@wtf/release-replace/replace/functions/replaceText.md +1 -1
  245. package/api/@wtf/release-replace/replace/interfaces/ReplaceOptions.md +10 -10
  246. package/api/@wtf/release-replace/replace/interfaces/TextOptions.md +5 -5
  247. package/api/@wtf/release-replace/replace/type-aliases/To.md +1 -1
  248. package/api/@wtf/release-replace/templates/functions/mergeTemplates.md +1 -1
  249. package/api/@wtf/release-replace/templates/functions/resolveReplacement.md +1 -1
  250. package/api/@wtf/release-replace/templates/functions/resolveReplacements.md +1 -1
  251. package/api/@wtf/release-replace/type-aliases/Escape.md +1 -1
  252. package/api/@wtf/release-replace/type-aliases/ReplaceFunction.md +1 -1
  253. package/api/@wtf/release-replace/type-aliases/Replacement.md +1 -1
  254. package/api/@wtf/release-replace/type-aliases/ReplacementSpec.md +1 -1
  255. package/api/@wtf/release-replace/type-aliases/TemplateUse.md +1 -1
  256. package/api/@wtf/release-replace/type-aliases/Templates.md +1 -1
  257. package/api/@wtf/release-replace/values/functions/escapeValue.md +1 -1
  258. package/api/@wtf/release-replace/values/functions/textOf.md +1 -1
  259. package/api/@wtf/release-replace/values/functions/valueAt.md +1 -1
  260. package/api/@wtf/release-replace/values/variables/ESCAPES.md +1 -1
  261. package/api/@wtf/release-replace/values/variables/VALUE.md +1 -1
  262. package/api/@wtf/release-system/errors/classes/ReleaseError.md +7 -5
  263. package/api/@wtf/release-system/errors/functions/throwAll.md +1 -1
  264. package/api/@wtf/release-system/errors/type-aliases/ErrorClass.md +1 -1
  265. package/api/@wtf/release-system/errors/type-aliases/SystemErrorCode.md +1 -1
  266. package/api/@wtf/release-system/errors/variables/SYSTEM_ERRORS.md +1 -1
  267. package/api/@wtf/release-system/git/functions/commitsSince.md +1 -1
  268. package/api/@wtf/release-system/git/functions/filesOfCommits.md +1 -1
  269. package/api/@wtf/release-system/git/functions/git.md +1 -1
  270. package/api/@wtf/release-system/git/functions/gitOf.md +1 -1
  271. package/api/@wtf/release-system/git/functions/trackedFiles.md +1 -1
  272. package/api/@wtf/release-system/git/interfaces/GitContext.md +4 -4
  273. package/api/@wtf/release-system/git/interfaces/LogCommit.md +5 -5
  274. package/api/@wtf/release-system/node/functions/nodeSystem.md +1 -1
  275. package/api/@wtf/release-system/node/functions/realPathOf.md +1 -1
  276. package/api/@wtf/release-system/node/functions/systemOf.md +1 -1
  277. package/api/@wtf/release-system/paths/functions/normalizePath.md +1 -1
  278. package/api/@wtf/release-system/paths/functions/pathMatcher.md +1 -1
  279. package/api/@wtf/release-system/paths/type-aliases/PathMatcher.md +1 -1
  280. package/api/@wtf/release-system/posix/functions/basenameOf.md +1 -1
  281. package/api/@wtf/release-system/posix/functions/dirnameOf.md +1 -1
  282. package/api/@wtf/release-system/posix/functions/joinPath.md +1 -1
  283. package/api/@wtf/release-system/posix/functions/relativePath.md +1 -1
  284. package/api/@wtf/release-system/posix/functions/resolvePath.md +1 -1
  285. package/api/@wtf/release-system/system/interfaces/DirEntry.md +3 -3
  286. package/api/@wtf/release-system/system/interfaces/ExecOptions.md +4 -4
  287. package/api/@wtf/release-system/system/interfaces/ExecResult.md +4 -4
  288. package/api/@wtf/release-system/system/interfaces/System.md +7 -7
  289. package/api/@wtf/release-system/system/interfaces/SystemFs.md +8 -8
  290. package/api/@wtf/release-system/system/type-aliases/Exec.md +1 -1
  291. package/api/@wtf/release-system/system/type-aliases/SystemInput.md +1 -1
  292. package/api/@wtf/release-system/validator/functions/allOf.md +1 -1
  293. package/api/@wtf/release-system/validator/functions/anyObject.md +1 -1
  294. package/api/@wtf/release-system/validator/functions/anyOf.md +1 -1
  295. package/api/@wtf/release-system/validator/functions/arrayOf.md +1 -1
  296. package/api/@wtf/release-system/validator/functions/booleanOf.md +1 -1
  297. package/api/@wtf/release-system/validator/functions/errorOf.md +1 -1
  298. package/api/@wtf/release-system/validator/functions/errorsOf.md +1 -1
  299. package/api/@wtf/release-system/validator/functions/exclusive.md +1 -1
  300. package/api/@wtf/release-system/validator/functions/issuesOf.md +1 -1
  301. package/api/@wtf/release-system/validator/functions/objectOf.md +1 -1
  302. package/api/@wtf/release-system/validator/functions/oneOf.md +1 -1
  303. package/api/@wtf/release-system/validator/functions/orFunction.md +1 -1
  304. package/api/@wtf/release-system/validator/functions/pathText.md +1 -1
  305. package/api/@wtf/release-system/validator/functions/pluginEntriesOf.md +1 -1
  306. package/api/@wtf/release-system/validator/functions/recordOf.md +1 -1
  307. package/api/@wtf/release-system/validator/functions/refined.md +1 -1
  308. package/api/@wtf/release-system/validator/functions/stringOf.md +1 -1
  309. package/api/@wtf/release-system/validator/functions/tupleOf.md +1 -1
  310. package/api/@wtf/release-system/validator/interfaces/ArrayOptions.md +5 -5
  311. package/api/@wtf/release-system/validator/interfaces/IssueOptions.md +4 -4
  312. package/api/@wtf/release-system/validator/interfaces/ObjectOptions.md +5 -5
  313. package/api/@wtf/release-system/validator/interfaces/OptionIssue.md +4 -4
  314. package/api/@wtf/release-system/validator/interfaces/Property.md +4 -4
  315. package/api/@wtf/release-system/validator/interfaces/RecordOptions.md +6 -6
  316. package/api/@wtf/release-system/validator/interfaces/StringOptions.md +6 -6
  317. package/api/@wtf/release-system/validator/interfaces/Validator.md +4 -4
  318. package/api/@wtf/release-system/validator/type-aliases/JsonSchema.md +1 -1
  319. package/api/@wtf/release-system/validator/type-aliases/Path.md +1 -1
  320. package/api/@wtf/release-trains/cascade/functions/cascadeNotes.md +1 -1
  321. package/api/@wtf/release-trains/cascade/functions/cascadeText.md +1 -1
  322. package/api/@wtf/release-trains/cascade/functions/cascadeType.md +1 -1
  323. package/api/@wtf/release-trains/cascade/functions/cascadesOf.md +1 -1
  324. package/api/@wtf/release-trains/cascade/functions/higherType.md +1 -1
  325. package/api/@wtf/release-trains/cascade/interfaces/Cascade.md +11 -11
  326. package/api/@wtf/release-trains/cascade/interfaces/CascadeCheck.md +8 -8
  327. package/api/@wtf/release-trains/cascade/type-aliases/CascadeKind.md +1 -1
  328. package/api/@wtf/release-trains/cascade/type-aliases/ReleaseType.md +1 -1
  329. package/api/@wtf/release-trains/cascade/variables/RELEASE_TYPES.md +1 -1
  330. package/api/@wtf/release-trains/ecosystem/functions/isEcosystem.md +1 -1
  331. package/api/@wtf/release-trains/ecosystem/functions/loadEcosystems.md +1 -1
  332. package/api/@wtf/release-trains/ecosystem/functions/readPackages.md +1 -1
  333. package/api/@wtf/release-trains/ecosystem/interfaces/Dependency.md +4 -4
  334. package/api/@wtf/release-trains/ecosystem/interfaces/Ecosystem.md +5 -5
  335. package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemContext.md +5 -5
  336. package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemPackages.md +3 -3
  337. package/api/@wtf/release-trains/ecosystem/interfaces/Package.md +8 -6
  338. package/api/@wtf/release-trains/ecosystem/type-aliases/DependencyKind.md +1 -1
  339. package/api/@wtf/release-trains/ecosystem/type-aliases/ModuleLoader.md +1 -1
  340. package/api/@wtf/release-trains/ecosystem/variables/DEPENDENCY_KINDS.md +1 -1
  341. package/api/@wtf/release-trains/errors/classes/TrainsError.md +5 -5
  342. package/api/@wtf/release-trains/errors/type-aliases/TrainsErrorCode.md +1 -1
  343. package/api/@wtf/release-trains/errors/variables/TRAINS_ERRORS.md +1 -1
  344. package/api/@wtf/release-trains/generated/functions/filesIn.md +1 -1
  345. package/api/@wtf/release-trains/generated/functions/formatGenerated.md +1 -1
  346. package/api/@wtf/release-trains/generated/functions/listGenerated.md +1 -1
  347. package/api/@wtf/release-trains/generated/functions/parseGenerated.md +1 -1
  348. package/api/@wtf/release-trains/generated/functions/readGenerated.md +1 -1
  349. package/api/@wtf/release-trains/generated/functions/stageGenerated.md +1 -1
  350. package/api/@wtf/release-trains/generated/functions/stageGeneratedFolders.md +1 -1
  351. package/api/@wtf/release-trains/generated/functions/unlistedIn.md +1 -1
  352. package/api/@wtf/release-trains/generated/interfaces/GeneratedOptions.md +2 -2
  353. package/api/@wtf/release-trains/generated/interfaces/StageOptions.md +6 -6
  354. package/api/@wtf/release-trains/generated/variables/GENERATED.md +1 -1
  355. package/api/@wtf/release-trains/git/functions/tagOf.md +1 -1
  356. package/api/@wtf/release-trains/git/functions/tagsOf.md +1 -1
  357. package/api/@wtf/release-trains/git/functions/versionOfTag.md +1 -1
  358. package/api/@wtf/release-trains/git/interfaces/TrainTag.md +3 -3
  359. package/api/@wtf/release-trains/interfaces/Train.md +7 -7
  360. package/api/@wtf/release-trains/packages/functions/dependencyEdges.md +1 -1
  361. package/api/@wtf/release-trains/packages/functions/dependencyText.md +1 -1
  362. package/api/@wtf/release-trains/packages/functions/dependsOnErrors.md +1 -1
  363. package/api/@wtf/release-trains/packages/functions/normalizeDir.md +1 -1
  364. package/api/@wtf/release-trains/packages/functions/ownersOf.md +1 -1
  365. package/api/@wtf/release-trains/packages/functions/packagesOf.md +1 -1
  366. package/api/@wtf/release-trains/packages/functions/publishOrder.md +1 -1
  367. package/api/@wtf/release-trains/packages/functions/releasedVersions.md +1 -1
  368. package/api/@wtf/release-trains/packages/functions/trainDependencies.md +1 -1
  369. package/api/@wtf/release-trains/packages/functions/trainOrder.md +1 -1
  370. package/api/@wtf/release-trains/packages/functions/unsatisfiedErrors.md +1 -1
  371. package/api/@wtf/release-trains/packages/interfaces/DependencyEdge.md +6 -6
  372. package/api/@wtf/release-trains/packages/interfaces/OrderFault.md +4 -4
  373. package/api/@wtf/release-trains/packages/interfaces/OrderPins.md +3 -3
  374. package/api/@wtf/release-trains/packages/interfaces/PublishOrder.md +3 -3
  375. package/api/@wtf/release-trains/packages/interfaces/TrainDependency.md +3 -3
  376. package/api/@wtf/release-trains/packages/interfaces/VersionsRelease.md +7 -7
  377. package/api/@wtf/release-trains/paths/functions/filterCommits.md +1 -1
  378. package/api/@wtf/release-trains/paths/functions/gitFilesOf.md +1 -1
  379. package/api/@wtf/release-trains/paths/functions/overlapError.md +1 -1
  380. package/api/@wtf/release-trains/paths/functions/trainOfPath.md +1 -1
  381. package/api/@wtf/release-trains/paths/functions/trainsOfCommit.md +1 -1
  382. package/api/@wtf/release-trains/paths/functions/trainsOfPath.md +1 -1
  383. package/api/@wtf/release-trains/paths/type-aliases/FilesOf.md +1 -1
  384. package/api/@wtf/release-trains/schema/interfaces/ConfigPart.md +6 -6
  385. package/api/@wtf/release-trains/schema/interfaces/RootOptions.md +7 -7
  386. package/api/@wtf/release-trains/schema/type-aliases/DependencyRule.md +1 -1
  387. package/api/@wtf/release-trains/schema/variables/DEPENDENCY_RULES.md +1 -1
  388. package/api/@wtf/release-trains/schema/variables/TAG_FORMAT_PATTERN.md +1 -1
  389. package/api/@wtf/release-trains/schema/variables/TRAIN_NAME_PATTERN.md +1 -1
  390. package/api/@wtf/release-trains/schema/variables/configSchema.md +1 -1
  391. package/api/@wtf/release-trains/schema/variables/jsonSchema.md +1 -1
  392. package/api/@wtf/release-trains/schema/variables/rootOptionsSchema.md +1 -1
  393. package/api/@wtf/release-trains/schema/variables/trainSchema.md +1 -1
  394. package/api/@wtf/release-trains/schema/variables/trainsSchema.md +1 -1
  395. package/api/@wtf/release-trains/trains/functions/changelogOf.md +1 -1
  396. package/api/@wtf/release-trains/trains/functions/matchersOf.md +1 -1
  397. package/api/@wtf/release-trains/trains/functions/overlapErrors.md +1 -1
  398. package/api/@wtf/release-trains/trains/functions/selectTrain.md +1 -1
  399. package/api/@wtf/release-trains/trains/functions/tagFormatOf.md +1 -1
  400. package/api/@wtf/release-trains/trains/functions/trainHeadedNotes.md +1 -1
  401. package/api/@wtf/release-trains/trains/functions/trainOfRun.md +1 -1
  402. package/api/@wtf/release-trains/trains/functions/trainOfTag.md +1 -1
  403. package/api/@wtf/release-trains/trains/functions/trainsErrors.md +1 -1
  404. package/api/@wtf/release-trains/trains/functions/trainsOfOptions.md +1 -1
  405. package/api/@wtf/release-trains/trains/variables/TRAIN_VARIABLE.md +1 -1
  406. package/api/@wtf/release-trains/trains/variables/VERSION.md +1 -1
  407. package/api/@wtf/release-trains/type-aliases/BranchSpec.md +1 -1
  408. package/api/@wtf/release-trains/type-aliases/Trains.md +1 -1
  409. package/api/@wtf/release-trains/verify/functions/unreleasedDependencies.md +1 -1
  410. package/api/@wtf/release-trains/verify/functions/verifyTrain.md +1 -1
  411. package/api/@wtf/release-trains/verify/interfaces/UnreleasedDependencies.md +10 -10
  412. package/api/@wtf/release-trains/verify/interfaces/VerifiedTrain.md +5 -5
  413. package/api/@wtf/release-trains/verify/interfaces/VerifyRelease.md +8 -8
  414. package/api/@wtf/release-validate/errors/classes/ValidateError.md +5 -5
  415. package/api/@wtf/release-validate/errors/type-aliases/ValidateErrorCode.md +1 -1
  416. package/api/@wtf/release-validate/errors/variables/VALIDATE_ERRORS.md +1 -1
  417. package/api/@wtf/release-validate/interfaces/ConfigIssue.md +4 -4
  418. package/api/@wtf/release-validate/json-schema/functions/fromJsonSchema.md +1 -1
  419. package/api/@wtf/release-validate/json-schema/functions/pathOfPointer.md +1 -1
  420. package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaError.md +3 -3
  421. package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaValidator.md +3 -3
  422. package/api/@wtf/release-validate/validate/functions/configErrors.md +1 -1
  423. package/api/@wtf/release-validate/validate/functions/isStandardSchema.md +1 -1
  424. package/api/@wtf/release-validate/validate/functions/pathText.md +1 -1
  425. package/api/@wtf/release-validate/validate/functions/validateConfig.md +1 -1
  426. package/api/@wtf/semantic-release-cargo/functions/indexLookup.md +1 -1
  427. package/api/@wtf/semantic-release-cargo/functions/prepare.md +1 -1
  428. package/api/@wtf/semantic-release-cargo/functions/publish.md +1 -1
  429. package/api/@wtf/semantic-release-cargo/functions/verifyConditions.md +1 -1
  430. package/api/@wtf/semantic-release-cargo/interfaces/CargoPluginOptions.md +12 -12
  431. package/api/@wtf/semantic-release-cargo/interfaces/CargoRelease.md +3 -3
  432. package/api/@wtf/semantic-release-cargo/schema/type-aliases/CargoOptions.md +1 -1
  433. package/api/@wtf/semantic-release-cargo/schema/variables/cargoOptionsSchema.md +1 -1
  434. package/api/@wtf/semantic-release-cargo/schema/variables/cargoSchema.md +1 -1
  435. package/api/@wtf/semantic-release-cargo/schema/variables/configSchema.md +1 -1
  436. package/api/@wtf/semantic-release-cargo/schema/variables/jsonSchema.md +1 -1
  437. package/api/@wtf/semantic-release-cargo/variables/default.md +1 -1
  438. package/api/@wtf/semantic-release-go/README.md +73 -0
  439. package/api/@wtf/semantic-release-go/functions/prepare.md +41 -0
  440. package/api/@wtf/semantic-release-go/functions/publish.md +43 -0
  441. package/api/@wtf/semantic-release-go/functions/verifyConditions.md +37 -0
  442. package/api/@wtf/semantic-release-go/functions/verifyRelease.md +38 -0
  443. package/api/@wtf/semantic-release-go/interfaces/GoPluginOptions.md +84 -0
  444. package/api/@wtf/semantic-release-go/interfaces/GoRelease.md +31 -0
  445. package/api/@wtf/semantic-release-go/schema/README.md +37 -0
  446. package/api/@wtf/semantic-release-go/schema/type-aliases/GoOptions.md +13 -0
  447. package/api/@wtf/{semantic-release-trains-changelog → semantic-release-go}/schema/variables/configSchema.md +2 -2
  448. package/api/@wtf/semantic-release-go/schema/variables/goOptionsSchema.md +13 -0
  449. package/api/@wtf/semantic-release-go/schema/variables/goSchema.md +14 -0
  450. package/api/@wtf/{semantic-release-trains-changelog → semantic-release-go}/schema/variables/jsonSchema.md +2 -2
  451. package/api/@wtf/semantic-release-go/variables/default.md +144 -0
  452. package/api/@wtf/semantic-release-maven/README.md +74 -0
  453. package/api/@wtf/semantic-release-maven/functions/pomLookup.md +38 -0
  454. package/api/@wtf/semantic-release-maven/functions/prepare.md +41 -0
  455. package/api/@wtf/semantic-release-maven/functions/publish.md +43 -0
  456. package/api/@wtf/semantic-release-maven/functions/verifyConditions.md +40 -0
  457. package/api/@wtf/semantic-release-maven/interfaces/LookupAuth.md +32 -0
  458. package/api/@wtf/semantic-release-maven/interfaces/MavenPluginOptions.md +129 -0
  459. package/api/@wtf/semantic-release-maven/interfaces/MavenRelease.md +21 -0
  460. package/api/@wtf/semantic-release-maven/schema/README.md +38 -0
  461. package/api/@wtf/semantic-release-maven/schema/type-aliases/MavenOptions.md +13 -0
  462. package/api/@wtf/semantic-release-maven/schema/variables/configSchema.md +13 -0
  463. package/api/@wtf/semantic-release-maven/schema/variables/jsonSchema.md +13 -0
  464. package/api/@wtf/semantic-release-maven/schema/variables/mavenOptionsSchema.md +13 -0
  465. package/api/@wtf/semantic-release-maven/schema/variables/mavenSchema.md +14 -0
  466. package/api/@wtf/semantic-release-maven/variables/default.md +116 -0
  467. package/api/@wtf/semantic-release-npm/functions/addChannel.md +1 -1
  468. package/api/@wtf/semantic-release-npm/functions/fail.md +1 -1
  469. package/api/@wtf/semantic-release-npm/functions/loadPublisher.md +1 -1
  470. package/api/@wtf/semantic-release-npm/functions/prepare.md +1 -1
  471. package/api/@wtf/semantic-release-npm/functions/publish.md +1 -1
  472. package/api/@wtf/semantic-release-npm/functions/verifyConditions.md +1 -1
  473. package/api/@wtf/semantic-release-npm/interfaces/PublishPluginOptions.md +18 -18
  474. package/api/@wtf/semantic-release-npm/interfaces/PublishedRelease.md +4 -4
  475. package/api/@wtf/semantic-release-npm/interfaces/SmokeOption.md +2 -2
  476. package/api/@wtf/semantic-release-npm/schema/type-aliases/PublishOptions.md +1 -1
  477. package/api/@wtf/semantic-release-npm/schema/variables/configSchema.md +1 -1
  478. package/api/@wtf/semantic-release-npm/schema/variables/jsonSchema.md +1 -1
  479. package/api/@wtf/semantic-release-npm/schema/variables/publishOptionsSchema.md +1 -1
  480. package/api/@wtf/semantic-release-npm/schema/variables/publishSchema.md +1 -1
  481. package/api/@wtf/semantic-release-npm/type-aliases/PublisherSpec.md +1 -1
  482. package/api/@wtf/semantic-release-npm/variables/default.md +1 -1
  483. package/api/@wtf/semantic-release-replace/functions/functionOf.md +1 -1
  484. package/api/@wtf/semantic-release-replace/functions/prepare.md +1 -1
  485. package/api/@wtf/semantic-release-replace/functions/templatesOf.md +1 -1
  486. package/api/@wtf/semantic-release-replace/functions/verifyConditions.md +1 -1
  487. package/api/@wtf/semantic-release-replace/interfaces/ReplacePluginOptions.md +5 -5
  488. package/api/@wtf/semantic-release-replace/schema/interfaces/ModuleExport.md +3 -3
  489. package/api/@wtf/semantic-release-replace/schema/interfaces/ReplaceOptions.md +4 -4
  490. package/api/@wtf/semantic-release-replace/schema/interfaces/RootTemplates.md +2 -2
  491. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacement.md +1 -1
  492. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacementSpec.md +1 -1
  493. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTemplates.md +1 -1
  494. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTo.md +1 -1
  495. package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplateSet.md +1 -1
  496. package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplatesOption.md +1 -1
  497. package/api/@wtf/semantic-release-replace/schema/variables/configSchema.md +1 -1
  498. package/api/@wtf/semantic-release-replace/schema/variables/exportedSetSchema.md +1 -1
  499. package/api/@wtf/semantic-release-replace/schema/variables/jsonSchema.md +1 -1
  500. package/api/@wtf/semantic-release-replace/schema/variables/replaceOptionsSchema.md +1 -1
  501. package/api/@wtf/semantic-release-replace/schema/variables/replacementSchema.md +1 -1
  502. package/api/@wtf/semantic-release-replace/schema/variables/rootTemplatesSchema.md +1 -1
  503. package/api/@wtf/semantic-release-replace/schema/variables/templateSchema.md +1 -1
  504. package/api/@wtf/semantic-release-replace/schema/variables/templatesSchema.md +1 -1
  505. package/api/@wtf/semantic-release-replace/variables/default.md +1 -1
  506. package/api/@wtf/semantic-release-trains/config/README.md +11 -3
  507. package/api/@wtf/semantic-release-trains/config/functions/skipPlugins.md +1 -1
  508. package/api/@wtf/semantic-release-trains/config/functions/stepId.md +1 -1
  509. package/api/@wtf/semantic-release-trains/config/functions/trainAssets.md +1 -1
  510. package/api/@wtf/semantic-release-trains/config/functions/trainChangelog.md +3 -4
  511. package/api/@wtf/semantic-release-trains/config/functions/trainOfTag.md +1 -1
  512. package/api/@wtf/semantic-release-trains/config/functions/trainTagFormat.md +1 -1
  513. package/api/@wtf/semantic-release-trains/config/interfaces/AssetsOptions.md +4 -4
  514. package/api/@wtf/semantic-release-trains/config/interfaces/SkipOptions.md +3 -3
  515. package/api/@wtf/semantic-release-trains/config/variables/BRANCHES.md +1 -1
  516. package/api/@wtf/semantic-release-trains/config/variables/BREAKING.md +1 -1
  517. package/api/@wtf/semantic-release-trains/config/variables/TITLE.md +14 -0
  518. package/api/@wtf/semantic-release-trains/defaults/README.md +42 -0
  519. package/api/@wtf/semantic-release-trains/defaults/functions/skipRuleOf.md +40 -0
  520. package/api/@wtf/semantic-release-trains/defaults/functions/skips.md +42 -0
  521. package/api/@wtf/semantic-release-trains/defaults/functions/trainOptionsOf.md +40 -0
  522. package/api/@wtf/semantic-release-trains/defaults/interfaces/SkipContext.md +59 -0
  523. package/api/@wtf/semantic-release-trains/defaults/type-aliases/SkipCheck.md +35 -0
  524. package/api/@wtf/semantic-release-trains/defaults/type-aliases/TrainOptions.md +33 -0
  525. package/api/@wtf/semantic-release-trains/defaults/variables/SKIP_RULES.md +13 -0
  526. package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_OPTIONS.md +20 -0
  527. package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_SKIP.md +17 -0
  528. package/api/@wtf/semantic-release-trains/errors/type-aliases/PluginErrorCode.md +1 -1
  529. package/api/@wtf/semantic-release-trains/errors/variables/PLUGIN_ERRORS.md +1 -1
  530. package/api/@wtf/semantic-release-trains/info/functions/decideTrain.md +1 -1
  531. package/api/@wtf/semantic-release-trains/info/functions/dotenvOf.md +1 -1
  532. package/api/@wtf/semantic-release-trains/info/functions/infoOf.md +1 -1
  533. package/api/@wtf/semantic-release-trains/info/interfaces/DecideRun.md +4 -4
  534. package/api/@wtf/semantic-release-trains/info/interfaces/InfoRun.md +8 -8
  535. package/api/@wtf/semantic-release-trains/info/interfaces/TrainDecision.md +5 -5
  536. package/api/@wtf/semantic-release-trains/info/interfaces/TrainInfo.md +5 -5
  537. package/api/@wtf/semantic-release-trains/interfaces/TrainsEntryOptions.md +15 -8
  538. package/api/@wtf/semantic-release-trains/interfaces/TrainsOptions.md +7 -7
  539. package/api/@wtf/semantic-release-trains/schema/README.md +1 -0
  540. package/api/@wtf/semantic-release-trains/schema/variables/configSchema.md +1 -1
  541. package/api/@wtf/semantic-release-trains/schema/variables/jsonSchema.md +1 -1
  542. package/api/@wtf/semantic-release-trains/schema/variables/pluginSpecSchema.md +1 -1
  543. package/api/@wtf/semantic-release-trains/schema/variables/skipRuleSchema.md +13 -0
  544. package/api/@wtf/semantic-release-trains/schema/variables/trainsEntrySchema.md +1 -1
  545. package/api/@wtf/semantic-release-trains/schema/variables/trainsPluginSchema.md +1 -1
  546. package/api/@wtf/semantic-release-trains/type-aliases/PluginSpec.md +1 -1
  547. package/api/@wtf/semantic-release-trains/type-aliases/TrainsPluginOptions.md +1 -1
  548. package/api/@wtf/semantic-release-trains/variables/addChannel.md +1 -1
  549. package/api/@wtf/semantic-release-trains/variables/analyzeCommits.md +1 -1
  550. package/api/@wtf/semantic-release-trains/variables/default.md +1 -1
  551. package/api/@wtf/semantic-release-trains/variables/fail.md +1 -1
  552. package/api/@wtf/semantic-release-trains/variables/generateNotes.md +1 -1
  553. package/api/@wtf/semantic-release-trains/variables/prepare.md +1 -1
  554. package/api/@wtf/semantic-release-trains/variables/publish.md +1 -1
  555. package/api/@wtf/semantic-release-trains/variables/success.md +1 -1
  556. package/api/@wtf/semantic-release-trains/variables/verifyConditions.md +1 -1
  557. package/api/@wtf/semantic-release-trains/variables/verifyRelease.md +1 -1
  558. package/api/@wtf/semantic-release-validate/functions/configOf.md +1 -1
  559. package/api/@wtf/semantic-release-validate/functions/loadSchema.md +1 -1
  560. package/api/@wtf/semantic-release-validate/functions/verifyConditions.md +1 -1
  561. package/api/@wtf/semantic-release-validate/interfaces/ValidatePluginOptions.md +2 -2
  562. package/api/@wtf/semantic-release-validate/schema/interfaces/Validator.md +2 -2
  563. package/api/@wtf/semantic-release-validate/schema/variables/configSchema.md +1 -1
  564. package/api/@wtf/semantic-release-validate/schema/variables/jsonSchema.md +1 -1
  565. package/api/@wtf/semantic-release-validate/schema/variables/validateOptionsSchema.md +1 -1
  566. package/api/@wtf/semantic-release-validate/variables/default.md +1 -1
  567. package/api/README.md +20 -5
  568. package/api/trains.json +9 -3
  569. package/guides/changelogs.md +30 -123
  570. package/guides/ci-recipes.md +16 -13
  571. package/guides/configuring-trains.md +7 -4
  572. package/guides/ecosystems.md +46 -23
  573. package/guides/getting-started.md +4 -6
  574. package/guides/publishing-go-modules.md +208 -0
  575. package/guides/publishing-maven.md +293 -0
  576. package/guides/publishing.md +6 -5
  577. package/guides/system.md +2 -2
  578. package/guides/validating-a-config.md +7 -9
  579. package/package.json +12 -10
  580. package/api/@wtf/release-trains-changelog/README.md +0 -58
  581. package/api/@wtf/release-trains-changelog/render/README.md +0 -44
  582. package/api/@wtf/release-trains-changelog/render/functions/changelogSection.md +0 -35
  583. package/api/@wtf/release-trains-changelog/render/functions/parseCommit.md +0 -28
  584. package/api/@wtf/release-trains-changelog/render/functions/prependSection.md +0 -40
  585. package/api/@wtf/release-trains-changelog/render/functions/renderSection.md +0 -37
  586. package/api/@wtf/release-trains-changelog/render/interfaces/ChangelogCommit.md +0 -27
  587. package/api/@wtf/release-trains-changelog/render/interfaces/ParsedCommit.md +0 -53
  588. package/api/@wtf/release-trains-changelog/render/interfaces/RenderOptions.md +0 -65
  589. package/api/@wtf/release-trains-changelog/render/variables/DEFAULT_TYPES.md +0 -13
  590. package/api/@wtf/release-trains-changelog/render/variables/TITLE.md +0 -13
  591. package/api/@wtf/release-trains-changelog/write/README.md +0 -48
  592. package/api/@wtf/release-trains-changelog/write/functions/changelogErrors.md +0 -33
  593. package/api/@wtf/release-trains-changelog/write/functions/commitUrlOf.md +0 -29
  594. package/api/@wtf/release-trains-changelog/write/functions/writeChangelogs.md +0 -35
  595. package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogOptions.md +0 -68
  596. package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogRelease.md +0 -176
  597. package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogTarget.md +0 -146
  598. package/api/@wtf/release-trains-changelog/write/interfaces/WrittenChangelog.md +0 -37
  599. package/api/@wtf/semantic-release-trains-changelog/README.md +0 -47
  600. package/api/@wtf/semantic-release-trains-changelog/functions/prepare.md +0 -33
  601. package/api/@wtf/semantic-release-trains-changelog/functions/verifyConditions.md +0 -36
  602. package/api/@wtf/semantic-release-trains-changelog/interfaces/ChangelogPluginOptions.md +0 -126
  603. package/api/@wtf/semantic-release-trains-changelog/schema/README.md +0 -24
  604. package/api/@wtf/semantic-release-trains-changelog/schema/variables/changelogOptionsSchema.md +0 -13
  605. package/api/@wtf/semantic-release-trains-changelog/schema/variables/changelogSchema.md +0 -13
  606. package/api/@wtf/semantic-release-trains-changelog/variables/default.md +0 -68
@@ -0,0 +1,51 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-maven/errors](../README.md) / MAVEN\_ERRORS
6
+
7
+ # Variable: MAVEN\_ERRORS
8
+
9
+ > `const` **MAVEN\_ERRORS**: `object`
10
+
11
+ Defined in: [packages/release-maven/src/errors.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/errors.ts#L15)
12
+
13
+ The codes of the errors of the Maven modules, each with what it means.
14
+
15
+ ## Type Declaration
16
+
17
+ ### EMAVENARTIFACTS
18
+
19
+ > `readonly` **EMAVENARTIFACTS**: `"An option names a module the repo has not, or of another train, or one that is not deployed."` = `'An option names a module the repo has not, or of another train, or one that is not deployed.'`
20
+
21
+ ### EMAVENDEPLOY
22
+
23
+ > `readonly` **EMAVENDEPLOY**: `"mvn failed to deploy a module, or cannot be run."` = `'mvn failed to deploy a module, or cannot be run.'`
24
+
25
+ ### EMAVENECOSYSTEM
26
+
27
+ > `readonly` **EMAVENECOSYSTEM**: `` "The `ecosystems` of the config lists neither `@wtf/semantic-release-maven/ecosystem` nor `@wtf/release-maven`, so the trains read no module." `` = `` 'The `ecosystems` of the config lists neither `@wtf/semantic-release-maven/ecosystem` nor `@wtf/release-maven`, so the trains read no module.' ``
28
+
29
+ ### EMAVENORDER
30
+
31
+ > `readonly` **EMAVENORDER**: `"The modules of the release depend on one another in a cycle."` = `'The modules of the release depend on one another in a cycle.'`
32
+
33
+ ### EMAVENPOM
34
+
35
+ > `readonly` **EMAVENPOM**: `"A pom.xml cannot be read: it is no XML, it names no artifactId or groupId, or two poms name one artifact."` = `'A pom.xml cannot be read: it is no XML, it names no artifactId or groupId, or two poms name one artifact.'`
36
+
37
+ ### EMAVENPRIVATE
38
+
39
+ > `readonly` **EMAVENPRIVATE**: `` "A module of the release depends on a module of `maven.deploy.skip`, by more than the test scope, or has it as its parent." `` = `` 'A module of the release depends on a module of `maven.deploy.skip`, by more than the test scope, or has it as its parent.' ``
40
+
41
+ ### EMAVENREPOSITORY
42
+
43
+ > `readonly` **EMAVENREPOSITORY**: `"The release knows no repository to deploy a module to, or the repository cannot say whether it has a pom."` = `'The release knows no repository to deploy a module to, or the repository cannot say whether it has a pom.'`
44
+
45
+ ### EMAVENSTAMP
46
+
47
+ > `readonly` **EMAVENSTAMP**: `"A pom.xml cannot be stamped with the versions of the trains."` = `'A pom.xml cannot be stamped with the versions of the trains.'`
48
+
49
+ ### EMAVENVERSION
50
+
51
+ > `readonly` **EMAVENVERSION**: `"A module is not at the version of its train."` = `'A module is not at the version of its train.'`
@@ -0,0 +1,169 @@
1
+ [**Release trains**](../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../README.md) / [@wtf/release-maven](../README.md) / MavenModule
6
+
7
+ # Interface: MavenModule
8
+
9
+ Defined in: [packages/release-maven/src/index.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/index.ts#L31)
10
+
11
+ A module of the repo, one pom.xml, as the trains read it: a package of the trains of the name
12
+ `groupId:artifactId`, and what the release needs of its pom, the values it inherits of its parents
13
+ in the repo read.
14
+
15
+ ## Extends
16
+
17
+ - [`Package`](../../release-trains/ecosystem/interfaces/Package.md)
18
+
19
+ ## Properties
20
+
21
+ ### artifactId
22
+
23
+ > `readonly` **artifactId**: `string`
24
+
25
+ Defined in: [packages/release-maven/src/index.ts:35](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/index.ts#L35)
26
+
27
+ Its artifactId.
28
+
29
+ ***
30
+
31
+ ### dependencies
32
+
33
+ > `readonly` **dependencies**: readonly [`Dependency`](../../release-trains/ecosystem/interfaces/Dependency.md)[]
34
+
35
+ Defined in: [packages/release-trains/src/ecosystem.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-trains/src/ecosystem.ts#L76)
36
+
37
+ Its dependencies on the other packages of its ecosystem in the repo.
38
+
39
+ #### Inherited from
40
+
41
+ [`Package`](../../release-trains/ecosystem/interfaces/Package.md).[`dependencies`](../../release-trains/ecosystem/interfaces/Package.md#dependencies)
42
+
43
+ ***
44
+
45
+ ### dir
46
+
47
+ > `readonly` **dir**: `string`
48
+
49
+ Defined in: [packages/release-trains/src/ecosystem.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-trains/src/ecosystem.ts#L67)
50
+
51
+ Its folder, from the root of the repo, as `packages/core`; `.` of the root. A train holds it
52
+ when the train's `paths` hold this folder.
53
+
54
+ #### Inherited from
55
+
56
+ [`Package`](../../release-trains/ecosystem/interfaces/Package.md).[`dir`](../../release-trains/ecosystem/interfaces/Package.md#dir)
57
+
58
+ ***
59
+
60
+ ### groupId
61
+
62
+ > `readonly` **groupId**: `string`
63
+
64
+ Defined in: [packages/release-maven/src/index.ts:33](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/index.ts#L33)
65
+
66
+ Its groupId: its own, or its parent's.
67
+
68
+ ***
69
+
70
+ ### manifest
71
+
72
+ > `readonly` **manifest**: `string`
73
+
74
+ Defined in: [packages/release-trains/src/ecosystem.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-trains/src/ecosystem.ts#L69)
75
+
76
+ Its manifest, from the root of the repo, as `packages/core/package.json`.
77
+
78
+ #### Inherited from
79
+
80
+ [`Package`](../../release-trains/ecosystem/interfaces/Package.md).[`manifest`](../../release-trains/ecosystem/interfaces/Package.md#manifest)
81
+
82
+ ***
83
+
84
+ ### name
85
+
86
+ > `readonly` **name**: `string`
87
+
88
+ Defined in: [packages/release-trains/src/ecosystem.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-trains/src/ecosystem.ts#L62)
89
+
90
+ Its name, the one its ecosystem's registry knows it by: unique of the ecosystem in the repo.
91
+
92
+ #### Inherited from
93
+
94
+ [`Package`](../../release-trains/ecosystem/interfaces/Package.md).[`name`](../../release-trains/ecosystem/interfaces/Package.md#name)
95
+
96
+ ***
97
+
98
+ ### ownVersion
99
+
100
+ > `readonly` **ownVersion**: `boolean`
101
+
102
+ Defined in: [packages/release-maven/src/index.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/index.ts#L39)
103
+
104
+ Whether its pom writes a `<version>` of its own: it takes its parent's otherwise.
105
+
106
+ ***
107
+
108
+ ### parent
109
+
110
+ > `readonly` **parent**: `string` \| `undefined`
111
+
112
+ Defined in: [packages/release-maven/src/index.ts:41](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/index.ts#L41)
113
+
114
+ The name of its parent, where the parent is a module of the repo.
115
+
116
+ ***
117
+
118
+ ### pom
119
+
120
+ > `readonly` **pom**: [`Pom`](../pom/interfaces/Pom.md)
121
+
122
+ Defined in: [packages/release-maven/src/index.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/index.ts#L47)
123
+
124
+ Its pom, as `readPom` of `./pom` reads it.
125
+
126
+ ***
127
+
128
+ ### properties
129
+
130
+ > `readonly` **properties**: `ReadonlyMap`\<`string`, `string`\>
131
+
132
+ Defined in: [packages/release-maven/src/index.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/index.ts#L45)
133
+
134
+ Its properties, of its parents in the repo, its own over theirs.
135
+
136
+ ***
137
+
138
+ ### published
139
+
140
+ > `readonly` **published**: `boolean`
141
+
142
+ Defined in: [packages/release-trains/src/ecosystem.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-trains/src/ecosystem.ts#L74)
143
+
144
+ Whether a release publishes it: not of an npm package that is private, nor of a crate of
145
+ `publish = false`.
146
+
147
+ #### Inherited from
148
+
149
+ [`Package`](../../release-trains/ecosystem/interfaces/Package.md).[`published`](../../release-trains/ecosystem/interfaces/Package.md#published)
150
+
151
+ ***
152
+
153
+ ### repository
154
+
155
+ > `readonly` **repository**: [`PomRepository`](../pom/interfaces/PomRepository.md) \| `undefined`
156
+
157
+ Defined in: [packages/release-maven/src/index.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/index.ts#L43)
158
+
159
+ The repository it deploys to, of its `distributionManagement` or of a parent's in the repo.
160
+
161
+ ***
162
+
163
+ ### version
164
+
165
+ > `readonly` **version**: `string` \| `undefined`
166
+
167
+ Defined in: [packages/release-maven/src/index.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/index.ts#L37)
168
+
169
+ Its version, as written: its own, or its parent's; `undefined` of neither.
@@ -0,0 +1,48 @@
1
+ [**Release trains**](../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../README.md) / @wtf/release-maven/pom
6
+
7
+ # @wtf/release-maven/pom
8
+
9
+ A pom.xml read: [parseXml](functions/parseXml.md), a small reader of XML of no library, which gives the tree of
10
+ elements, each with where it starts and ends in the text, and where its content does; and
11
+ [readPom](functions/readPom.md), what a release needs of a pom of that tree: its coordinates, its parent, its
12
+ properties, its dependencies, its plugins and its repository. The reader reads elements, text,
13
+ comments, CDATA, processing instructions and a doctype; it reads no attribute, as a pom has none
14
+ that a release needs, and writes nothing: the stamp (`./stamp`) splices a version into the text at
15
+ the place the reader gives, so every other byte of the file stays as it was.
16
+
17
+ ```ts
18
+ import { parseXml, readPom } from '@wtf/release-maven/pom'
19
+
20
+ const text = '<project><artifactId>core</artifactId><!-- set by the release --><version>0.0.0-SNAPSHOT</version></project>'
21
+ const version = parseXml(text).children.find(({ name }) => name === 'version')
22
+ console.log(version?.text) // 0.0.0-SNAPSHOT
23
+ console.log(readPom('core/pom.xml', text).artifactId) // core
24
+ ```
25
+
26
+ ## Interfaces
27
+
28
+ - [Pom](interfaces/Pom.md)
29
+ - [PomDependency](interfaces/PomDependency.md)
30
+ - [PomParent](interfaces/PomParent.md)
31
+ - [PomPlugin](interfaces/PomPlugin.md)
32
+ - [PomRepository](interfaces/PomRepository.md)
33
+ - [Span](interfaces/Span.md)
34
+ - [XmlElement](interfaces/XmlElement.md)
35
+
36
+ ## Variables
37
+
38
+ - [PLUGIN\_GROUP](variables/PLUGIN_GROUP.md)
39
+
40
+ ## Functions
41
+
42
+ - [childOf](functions/childOf.md)
43
+ - [childrenOf](functions/childrenOf.md)
44
+ - [dependencyOf](functions/dependencyOf.md)
45
+ - [escapeXml](functions/escapeXml.md)
46
+ - [parseXml](functions/parseXml.md)
47
+ - [readPom](functions/readPom.md)
48
+ - [textAt](functions/textAt.md)
@@ -0,0 +1,33 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / childOf
6
+
7
+ # Function: childOf()
8
+
9
+ > **childOf**(`element`, `name`): [`XmlElement`](../interfaces/XmlElement.md) \| `undefined`
10
+
11
+ Defined in: [packages/release-maven/src/pom.ts:196](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L196)
12
+
13
+ The first element of `element` of the name `name`.
14
+
15
+ ## Parameters
16
+
17
+ ### element
18
+
19
+ [`XmlElement`](../interfaces/XmlElement.md) \| `undefined`
20
+
21
+ The element.
22
+
23
+ ### name
24
+
25
+ `string`
26
+
27
+ The name of the child.
28
+
29
+ ## Returns
30
+
31
+ [`XmlElement`](../interfaces/XmlElement.md) \| `undefined`
32
+
33
+ The child, or `undefined`.
@@ -0,0 +1,33 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / childrenOf
6
+
7
+ # Function: childrenOf()
8
+
9
+ > **childrenOf**(`element`, `name`): [`XmlElement`](../interfaces/XmlElement.md)[]
10
+
11
+ Defined in: [packages/release-maven/src/pom.ts:206](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L206)
12
+
13
+ The elements of `element` of the name `name`, in order.
14
+
15
+ ## Parameters
16
+
17
+ ### element
18
+
19
+ [`XmlElement`](../interfaces/XmlElement.md) \| `undefined`
20
+
21
+ The element.
22
+
23
+ ### name
24
+
25
+ `string`
26
+
27
+ The name of the children.
28
+
29
+ ## Returns
30
+
31
+ [`XmlElement`](../interfaces/XmlElement.md)[]
32
+
33
+ The children; none of no element.
@@ -0,0 +1,27 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / dependencyOf
6
+
7
+ # Function: dependencyOf()
8
+
9
+ > **dependencyOf**(`element`): [`PomDependency`](../interfaces/PomDependency.md)
10
+
11
+ Defined in: [packages/release-maven/src/pom.ts:309](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L309)
12
+
13
+ A dependency of its element.
14
+
15
+ ## Parameters
16
+
17
+ ### element
18
+
19
+ [`XmlElement`](../interfaces/XmlElement.md)
20
+
21
+ A `<dependency>`.
22
+
23
+ ## Returns
24
+
25
+ [`PomDependency`](../interfaces/PomDependency.md)
26
+
27
+ The dependency, each value its text.
@@ -0,0 +1,27 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / escapeXml
6
+
7
+ # Function: escapeXml()
8
+
9
+ > **escapeXml**(`text`): `string`
10
+
11
+ Defined in: [packages/release-maven/src/pom.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L74)
12
+
13
+ Text written as XML writes it: `&`, `<` and `>` as their entities.
14
+
15
+ ## Parameters
16
+
17
+ ### text
18
+
19
+ `string`
20
+
21
+ The text.
22
+
23
+ ## Returns
24
+
25
+ `string`
26
+
27
+ The text, as the content of an element.
@@ -0,0 +1,39 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / parseXml
6
+
7
+ # Function: parseXml()
8
+
9
+ > **parseXml**(`text`, `file?`): [`XmlElement`](../interfaces/XmlElement.md)
10
+
11
+ Defined in: [packages/release-maven/src/pom.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L96)
12
+
13
+ The root element of the XML `text`, each element of its offsets in the text. The reader reads
14
+ elements, text and entities, comments, CDATA, processing instructions and a doctype, and skips
15
+ the attributes of each tag; it checks that each element closes, by its name.
16
+
17
+ ## Parameters
18
+
19
+ ### text
20
+
21
+ `string`
22
+
23
+ The XML, as a file holds it.
24
+
25
+ ### file?
26
+
27
+ `string` = `'The XML'`
28
+
29
+ The file, as an error names it.
30
+
31
+ ## Returns
32
+
33
+ [`XmlElement`](../interfaces/XmlElement.md)
34
+
35
+ The root element.
36
+
37
+ ## Throws
38
+
39
+ `EMAVENPOM` of text that is no XML of one root element.
@@ -0,0 +1,39 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / readPom
6
+
7
+ # Function: readPom()
8
+
9
+ > **readPom**(`file`, `text`): [`Pom`](../interfaces/Pom.md)
10
+
11
+ Defined in: [packages/release-maven/src/pom.ts:349](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L349)
12
+
13
+ The pom `text` of the file `file`, as the module says: what it writes of itself, of no parent,
14
+ and of no profile.
15
+
16
+ ## Parameters
17
+
18
+ ### file
19
+
20
+ `string`
21
+
22
+ The file, from the root of the repo, as `core/pom.xml`.
23
+
24
+ ### text
25
+
26
+ `string`
27
+
28
+ The text of the file.
29
+
30
+ ## Returns
31
+
32
+ [`Pom`](../interfaces/Pom.md)
33
+
34
+ The pom.
35
+
36
+ ## Throws
37
+
38
+ `EMAVENPOM` of a file that is no XML, of a root that is no `<project>`, or of no
39
+ `artifactId`.
@@ -0,0 +1,34 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / textAt
6
+
7
+ # Function: textAt()
8
+
9
+ > **textAt**(`element`, ...`path`): `string` \| `undefined`
10
+
11
+ Defined in: [packages/release-maven/src/pom.ts:217](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L217)
12
+
13
+ The text of the element down the names of `path` from `element`, each the first child of its
14
+ name: `undefined` where one is not there.
15
+
16
+ ## Parameters
17
+
18
+ ### element
19
+
20
+ [`XmlElement`](../interfaces/XmlElement.md) \| `undefined`
21
+
22
+ The element to start at.
23
+
24
+ ### path
25
+
26
+ ...readonly `string`[]
27
+
28
+ The names of the children, in turn, as `['parent', 'version']`.
29
+
30
+ ## Returns
31
+
32
+ `string` \| `undefined`
33
+
34
+ The text of the last, or `undefined`.
@@ -0,0 +1,151 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / Pom
6
+
7
+ # Interface: Pom
8
+
9
+ Defined in: [packages/release-maven/src/pom.ts:269](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L269)
10
+
11
+ A pom.xml, as [readPom](../functions/readPom.md) reads it: each value as the pom writes it, of no inheritance.
12
+
13
+ ## Properties
14
+
15
+ ### artifactId
16
+
17
+ > `readonly` **artifactId**: `string`
18
+
19
+ Defined in: [packages/release-maven/src/pom.ts:281](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L281)
20
+
21
+ Its `artifactId`.
22
+
23
+ ***
24
+
25
+ ### dependencies
26
+
27
+ > `readonly` **dependencies**: readonly [`PomDependency`](PomDependency.md)[]
28
+
29
+ Defined in: [packages/release-maven/src/pom.ts:289](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L289)
30
+
31
+ The dependencies of its `<dependencies>`.
32
+
33
+ ***
34
+
35
+ ### dir
36
+
37
+ > `readonly` **dir**: `string`
38
+
39
+ Defined in: [packages/release-maven/src/pom.ts:273](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L273)
40
+
41
+ Its folder, from the root of the repo, as `core`; `.` of the root.
42
+
43
+ ***
44
+
45
+ ### file
46
+
47
+ > `readonly` **file**: `string`
48
+
49
+ Defined in: [packages/release-maven/src/pom.ts:271](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L271)
50
+
51
+ The file, from the root of the repo, as `core/pom.xml`.
52
+
53
+ ***
54
+
55
+ ### groupId
56
+
57
+ > `readonly` **groupId**: `string` \| `undefined`
58
+
59
+ Defined in: [packages/release-maven/src/pom.ts:279](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L279)
60
+
61
+ Its own `groupId`: none, its parent's.
62
+
63
+ ***
64
+
65
+ ### managed
66
+
67
+ > `readonly` **managed**: readonly [`PomDependency`](PomDependency.md)[]
68
+
69
+ Defined in: [packages/release-maven/src/pom.ts:291](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L291)
70
+
71
+ The dependencies of its `<dependencyManagement>`.
72
+
73
+ ***
74
+
75
+ ### managedPlugins
76
+
77
+ > `readonly` **managedPlugins**: readonly [`PomPlugin`](PomPlugin.md)[]
78
+
79
+ Defined in: [packages/release-maven/src/pom.ts:295](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L295)
80
+
81
+ The plugins of its `<build><pluginManagement>`.
82
+
83
+ ***
84
+
85
+ ### parent
86
+
87
+ > `readonly` **parent**: [`PomParent`](PomParent.md) \| `undefined`
88
+
89
+ Defined in: [packages/release-maven/src/pom.ts:285](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L285)
90
+
91
+ Its `<parent>`, where it has one.
92
+
93
+ ***
94
+
95
+ ### plugins
96
+
97
+ > `readonly` **plugins**: readonly [`PomPlugin`](PomPlugin.md)[]
98
+
99
+ Defined in: [packages/release-maven/src/pom.ts:293](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L293)
100
+
101
+ The plugins of its `<build><plugins>`.
102
+
103
+ ***
104
+
105
+ ### properties
106
+
107
+ > `readonly` **properties**: `ReadonlyMap`\<`string`, `string`\>
108
+
109
+ Defined in: [packages/release-maven/src/pom.ts:287](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L287)
110
+
111
+ Its `<properties>`, each by its name.
112
+
113
+ ***
114
+
115
+ ### repository
116
+
117
+ > `readonly` **repository**: [`PomRepository`](PomRepository.md) \| `undefined`
118
+
119
+ Defined in: [packages/release-maven/src/pom.ts:297](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L297)
120
+
121
+ The repository of its `<distributionManagement>`, where it names one.
122
+
123
+ ***
124
+
125
+ ### root
126
+
127
+ > `readonly` **root**: [`XmlElement`](XmlElement.md)
128
+
129
+ Defined in: [packages/release-maven/src/pom.ts:277](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L277)
130
+
131
+ The root element of the file, `<project>`.
132
+
133
+ ***
134
+
135
+ ### text
136
+
137
+ > `readonly` **text**: `string`
138
+
139
+ Defined in: [packages/release-maven/src/pom.ts:275](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L275)
140
+
141
+ The text of the file.
142
+
143
+ ***
144
+
145
+ ### version
146
+
147
+ > `readonly` **version**: `string` \| `undefined`
148
+
149
+ Defined in: [packages/release-maven/src/pom.ts:283](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L283)
150
+
151
+ Its own `version`: none, its parent's.