@wtf/release-docs 8.2.2 → 9.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (589) hide show
  1. package/api/.generated +29 -0
  2. package/api/@wtf/release-cargo/auth/functions/mask.md +1 -1
  3. package/api/@wtf/release-cargo/auth/functions/tokenVariableOf.md +1 -1
  4. package/api/@wtf/release-cargo/auth/functions/trustedPublishing.md +1 -1
  5. package/api/@wtf/release-cargo/auth/interfaces/HttpResponse.md +5 -5
  6. package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishing.md +5 -5
  7. package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishingOptions.md +6 -6
  8. package/api/@wtf/release-cargo/auth/type-aliases/HttpFetch.md +1 -1
  9. package/api/@wtf/release-cargo/auth/variables/CRATES_IO_API.md +1 -1
  10. package/api/@wtf/release-cargo/auth/variables/ID_TOKEN_VARIABLE.md +1 -1
  11. package/api/@wtf/release-cargo/auth/variables/USER_AGENT.md +1 -1
  12. package/api/@wtf/release-cargo/crates/functions/publishOrder.md +1 -1
  13. package/api/@wtf/release-cargo/crates/functions/publishable.md +1 -1
  14. package/api/@wtf/release-cargo/crates/functions/readWorkspace.md +1 -1
  15. package/api/@wtf/release-cargo/crates/functions/selectCrates.md +1 -1
  16. package/api/@wtf/release-cargo/crates/interfaces/Selection.md +5 -5
  17. package/api/@wtf/release-cargo/ecosystem/functions/packagesAt.md +1 -1
  18. package/api/@wtf/release-cargo/ecosystem/functions/packagesOfTree.md +1 -1
  19. package/api/@wtf/release-cargo/ecosystem/functions/packagesOfWorkspace.md +1 -1
  20. package/api/@wtf/release-cargo/ecosystem/functions/resolveRequirement.md +1 -1
  21. package/api/@wtf/release-cargo/ecosystem/functions/satisfiesRequirement.md +1 -1
  22. package/api/@wtf/release-cargo/ecosystem/functions/semverRange.md +1 -1
  23. package/api/@wtf/release-cargo/ecosystem/interfaces/CargoPackage.md +7 -7
  24. package/api/@wtf/release-cargo/ecosystem/variables/cargoEcosystem.md +1 -1
  25. package/api/@wtf/release-cargo/errors/classes/CargoError.md +5 -5
  26. package/api/@wtf/release-cargo/errors/type-aliases/CargoErrorCode.md +1 -1
  27. package/api/@wtf/release-cargo/errors/variables/CARGO_ERRORS.md +1 -1
  28. package/api/@wtf/release-cargo/interfaces/Crate.md +6 -6
  29. package/api/@wtf/release-cargo/interfaces/CrateDependency.md +6 -6
  30. package/api/@wtf/release-cargo/interfaces/Workspace.md +3 -3
  31. package/api/@wtf/release-cargo/publish/functions/publishCrates.md +1 -1
  32. package/api/@wtf/release-cargo/publish/interfaces/PublishCratesOptions.md +11 -11
  33. package/api/@wtf/release-cargo/publish/interfaces/PublishedCrate.md +5 -5
  34. package/api/@wtf/release-cargo/publish/type-aliases/CrateStatus.md +1 -1
  35. package/api/@wtf/release-cargo/publish/variables/RECHECK_WAITS.md +1 -1
  36. package/api/@wtf/release-cargo/registry/functions/crateUrl.md +1 -1
  37. package/api/@wtf/release-cargo/registry/functions/indexHasVersion.md +1 -1
  38. package/api/@wtf/release-cargo/registry/functions/indexPath.md +1 -1
  39. package/api/@wtf/release-cargo/registry/variables/CRATES_IO_INDEX.md +1 -1
  40. package/api/@wtf/release-cargo/stamp/functions/checkVersions.md +1 -1
  41. package/api/@wtf/release-cargo/stamp/functions/inheritsVersion.md +1 -1
  42. package/api/@wtf/release-cargo/stamp/functions/stampManifest.md +1 -1
  43. package/api/@wtf/release-cargo/stamp/functions/stampWorkspace.md +1 -1
  44. package/api/@wtf/release-cargo/stamp/interfaces/StampOptions.md +4 -4
  45. package/api/@wtf/release-cargo/stamp/interfaces/Stamped.md +3 -3
  46. package/api/@wtf/release-cargo/stamp/interfaces/StampedWorkspace.md +3 -3
  47. package/api/@wtf/release-cargo/type-aliases/DependencyKind.md +1 -1
  48. package/api/@wtf/release-go/ecosystem/functions/packagesOfModules.md +1 -1
  49. package/api/@wtf/release-go/ecosystem/functions/packagesOfRepo.md +1 -1
  50. package/api/@wtf/release-go/ecosystem/functions/resolveVersion.md +1 -1
  51. package/api/@wtf/release-go/ecosystem/functions/satisfiesVersion.md +1 -1
  52. package/api/@wtf/release-go/ecosystem/interfaces/GoPackage.md +7 -7
  53. package/api/@wtf/release-go/ecosystem/variables/goEcosystem.md +1 -1
  54. package/api/@wtf/release-go/errors/classes/GoError.md +5 -5
  55. package/api/@wtf/release-go/errors/type-aliases/GoErrorCode.md +1 -1
  56. package/api/@wtf/release-go/errors/variables/GO_ERRORS.md +1 -1
  57. package/api/@wtf/release-go/gomod/functions/entriesOf.md +1 -1
  58. package/api/@wtf/release-go/gomod/functions/linesOf.md +1 -1
  59. package/api/@wtf/release-go/gomod/functions/readGoMod.md +1 -1
  60. package/api/@wtf/release-go/gomod/functions/tokensOf.md +1 -1
  61. package/api/@wtf/release-go/gomod/interfaces/Entry.md +4 -4
  62. package/api/@wtf/release-go/gomod/interfaces/GoMod.md +4 -4
  63. package/api/@wtf/release-go/gomod/interfaces/GoReplace.md +6 -6
  64. package/api/@wtf/release-go/gomod/interfaces/GoRequire.md +4 -4
  65. package/api/@wtf/release-go/gomod/interfaces/Token.md +5 -5
  66. package/api/@wtf/release-go/interfaces/GoModule.md +6 -6
  67. package/api/@wtf/release-go/modules/functions/isFetchable.md +1 -1
  68. package/api/@wtf/release-go/modules/functions/isGoMod.md +1 -1
  69. package/api/@wtf/release-go/modules/functions/majorErrors.md +1 -1
  70. package/api/@wtf/release-go/modules/functions/majorOfPath.md +1 -1
  71. package/api/@wtf/release-go/modules/functions/modulesAt.md +1 -1
  72. package/api/@wtf/release-go/modules/functions/modulesOf.md +1 -1
  73. package/api/@wtf/release-go/modules/functions/readModules.md +1 -1
  74. package/api/@wtf/release-go/modules/functions/selectModules.md +1 -1
  75. package/api/@wtf/release-go/modules/interfaces/Selection.md +4 -4
  76. package/api/@wtf/release-go/stamp/functions/checkVersions.md +1 -1
  77. package/api/@wtf/release-go/stamp/functions/stampGoMod.md +1 -1
  78. package/api/@wtf/release-go/stamp/functions/stampModules.md +1 -1
  79. package/api/@wtf/release-go/stamp/interfaces/Stamped.md +3 -3
  80. package/api/@wtf/release-go/stamp/interfaces/StampedModules.md +3 -3
  81. package/api/@wtf/release-go/tags/functions/askProxy.md +1 -1
  82. package/api/@wtf/release-go/tags/functions/maskCredentials.md +1 -1
  83. package/api/@wtf/release-go/tags/functions/releaseCommit.md +1 -1
  84. package/api/@wtf/release-go/tags/functions/remoteTags.md +1 -1
  85. package/api/@wtf/release-go/tags/functions/tagModules.md +1 -1
  86. package/api/@wtf/release-go/tags/functions/tagOfModule.md +1 -1
  87. package/api/@wtf/release-go/tags/functions/tagPrefix.md +1 -1
  88. package/api/@wtf/release-go/tags/interfaces/TagModulesOptions.md +8 -8
  89. package/api/@wtf/release-go/tags/interfaces/TaggedModule.md +5 -5
  90. package/api/@wtf/release-go/tags/type-aliases/ModuleStatus.md +1 -1
  91. package/api/@wtf/release-go/tags/variables/RELEASE_AUTHOR.md +1 -1
  92. package/api/@wtf/release-maven/artifacts/functions/groupIdOf.md +1 -1
  93. package/api/@wtf/release-maven/artifacts/functions/installsOf.md +1 -1
  94. package/api/@wtf/release-maven/artifacts/functions/isPomFile.md +1 -1
  95. package/api/@wtf/release-maven/artifacts/functions/isRange.md +1 -1
  96. package/api/@wtf/release-maven/artifacts/functions/modulesOf.md +1 -1
  97. package/api/@wtf/release-maven/artifacts/functions/nameOf.md +1 -1
  98. package/api/@wtf/release-maven/artifacts/functions/publishOrder.md +1 -1
  99. package/api/@wtf/release-maven/artifacts/functions/readModules.md +1 -1
  100. package/api/@wtf/release-maven/artifacts/functions/readPoms.md +1 -1
  101. package/api/@wtf/release-maven/artifacts/functions/selectArtifacts.md +1 -1
  102. package/api/@wtf/release-maven/artifacts/interfaces/Selection.md +4 -4
  103. package/api/@wtf/release-maven/ecosystem/functions/compareVersions.md +1 -1
  104. package/api/@wtf/release-maven/ecosystem/functions/parseRange.md +1 -1
  105. package/api/@wtf/release-maven/ecosystem/functions/resolveVersion.md +1 -1
  106. package/api/@wtf/release-maven/ecosystem/functions/satisfiesVersion.md +1 -1
  107. package/api/@wtf/release-maven/ecosystem/interfaces/Bound.md +3 -3
  108. package/api/@wtf/release-maven/ecosystem/interfaces/Restriction.md +3 -3
  109. package/api/@wtf/release-maven/ecosystem/variables/mavenEcosystem.md +1 -1
  110. package/api/@wtf/release-maven/errors/classes/MavenError.md +5 -5
  111. package/api/@wtf/release-maven/errors/type-aliases/MavenErrorCode.md +1 -1
  112. package/api/@wtf/release-maven/errors/variables/MAVEN_ERRORS.md +1 -1
  113. package/api/@wtf/release-maven/interfaces/MavenModule.md +14 -14
  114. package/api/@wtf/release-maven/pom/functions/childOf.md +1 -1
  115. package/api/@wtf/release-maven/pom/functions/childrenOf.md +1 -1
  116. package/api/@wtf/release-maven/pom/functions/dependencyOf.md +1 -1
  117. package/api/@wtf/release-maven/pom/functions/escapeXml.md +1 -1
  118. package/api/@wtf/release-maven/pom/functions/parseXml.md +1 -1
  119. package/api/@wtf/release-maven/pom/functions/readPom.md +1 -1
  120. package/api/@wtf/release-maven/pom/functions/textAt.md +1 -1
  121. package/api/@wtf/release-maven/pom/interfaces/Pom.md +15 -15
  122. package/api/@wtf/release-maven/pom/interfaces/PomDependency.md +5 -5
  123. package/api/@wtf/release-maven/pom/interfaces/PomParent.md +4 -4
  124. package/api/@wtf/release-maven/pom/interfaces/PomPlugin.md +5 -5
  125. package/api/@wtf/release-maven/pom/interfaces/PomRepository.md +3 -3
  126. package/api/@wtf/release-maven/pom/interfaces/Span.md +3 -3
  127. package/api/@wtf/release-maven/pom/interfaces/XmlElement.md +7 -7
  128. package/api/@wtf/release-maven/pom/variables/PLUGIN_GROUP.md +1 -1
  129. package/api/@wtf/release-maven/publish/functions/deployModules.md +1 -1
  130. package/api/@wtf/release-maven/publish/interfaces/DeployModulesOptions.md +11 -11
  131. package/api/@wtf/release-maven/publish/interfaces/DeployedModule.md +4 -4
  132. package/api/@wtf/release-maven/publish/type-aliases/ModuleStatus.md +1 -1
  133. package/api/@wtf/release-maven/repository/functions/deployTargets.md +1 -1
  134. package/api/@wtf/release-maven/repository/functions/expandValues.md +1 -1
  135. package/api/@wtf/release-maven/repository/functions/hasPom.md +1 -1
  136. package/api/@wtf/release-maven/repository/functions/pomPath.md +1 -1
  137. package/api/@wtf/release-maven/repository/functions/pomUrl.md +1 -1
  138. package/api/@wtf/release-maven/repository/interfaces/Repository.md +3 -3
  139. package/api/@wtf/release-maven/repository/interfaces/ValuesOf.md +3 -3
  140. package/api/@wtf/release-maven/repository/variables/MAVEN_CENTRAL.md +1 -1
  141. package/api/@wtf/release-maven/stamp/functions/checkVersions.md +1 -1
  142. package/api/@wtf/release-maven/stamp/functions/stampModules.md +1 -1
  143. package/api/@wtf/release-maven/stamp/functions/stampPom.md +1 -1
  144. package/api/@wtf/release-maven/stamp/interfaces/PomStampOptions.md +5 -5
  145. package/api/@wtf/release-maven/stamp/interfaces/Stamped.md +3 -3
  146. package/api/@wtf/release-maven/stamp/interfaces/StampedModules.md +3 -3
  147. package/api/@wtf/release-npm/check/functions/checkPackages.md +1 -1
  148. package/api/@wtf/release-npm/check/functions/formatIssue.md +1 -1
  149. package/api/@wtf/release-npm/check/interfaces/CheckOptions.md +6 -6
  150. package/api/@wtf/release-npm/check/interfaces/Issue.md +5 -5
  151. package/api/@wtf/release-npm/check/type-aliases/CheckedPackage.md +1 -1
  152. package/api/@wtf/release-npm/check/type-aliases/IssueCode.md +1 -1
  153. package/api/@wtf/release-npm/ecosystem/variables/npmEcosystem.md +1 -1
  154. package/api/@wtf/release-npm/errors/type-aliases/NpmErrorCode.md +1 -1
  155. package/api/@wtf/release-npm/errors/variables/NPM_ERRORS.md +1 -1
  156. package/api/@wtf/release-npm/interfaces/Lookup.md +3 -3
  157. package/api/@wtf/release-npm/interfaces/PublishOptions.md +6 -6
  158. package/api/@wtf/release-npm/interfaces/PublishPackage.md +5 -5
  159. package/api/@wtf/release-npm/interfaces/PublishTrainOptions.md +16 -16
  160. package/api/@wtf/release-npm/interfaces/Publisher.md +7 -7
  161. package/api/@wtf/release-npm/interfaces/PublisherContext.md +7 -7
  162. package/api/@wtf/release-npm/manifests/functions/concreteRange.md +1 -1
  163. package/api/@wtf/release-npm/manifests/functions/manifestsAt.md +1 -1
  164. package/api/@wtf/release-npm/manifests/functions/packageOf.md +1 -1
  165. package/api/@wtf/release-npm/manifests/functions/packagesOfManifests.md +1 -1
  166. package/api/@wtf/release-npm/manifests/functions/readManifests.md +1 -1
  167. package/api/@wtf/release-npm/manifests/functions/resolveSpecifier.md +1 -1
  168. package/api/@wtf/release-npm/manifests/functions/runtimeDependenciesOf.md +1 -1
  169. package/api/@wtf/release-npm/manifests/functions/satisfiesRange.md +1 -1
  170. package/api/@wtf/release-npm/manifests/interfaces/Manifest.md +5 -5
  171. package/api/@wtf/release-npm/manifests/interfaces/NpmPackage.md +7 -7
  172. package/api/@wtf/release-npm/manifests/type-aliases/DependencyField.md +1 -1
  173. package/api/@wtf/release-npm/manifests/variables/DEPENDENCY_FIELDS.md +1 -1
  174. package/api/@wtf/release-npm/manifests/variables/FIELD_KINDS.md +1 -1
  175. package/api/@wtf/release-npm/manifests/variables/RUNTIME_FIELDS.md +1 -1
  176. package/api/@wtf/release-npm/prepare/functions/isTypeScriptSource.md +1 -1
  177. package/api/@wtf/release-npm/prepare/functions/prepareManifest.md +1 -1
  178. package/api/@wtf/release-npm/prepare/functions/stripSourceConditions.md +1 -1
  179. package/api/@wtf/release-npm/prepare/interfaces/PrepareOptions.md +5 -5
  180. package/api/@wtf/release-npm/prepare/interfaces/PreparedManifest.md +6 -6
  181. package/api/@wtf/release-npm/prepare/variables/SOURCE_CONDITIONS.md +1 -1
  182. package/api/@wtf/release-npm/publishers/README.md +1 -0
  183. package/api/@wtf/release-npm/publishers/functions/builtInPublisher.md +1 -1
  184. package/api/@wtf/release-npm/publishers/functions/isPublisher.md +1 -1
  185. package/api/@wtf/release-npm/publishers/functions/registryOf.md +34 -0
  186. package/api/@wtf/release-npm/publishers/variables/NPM_REGISTRY.md +1 -1
  187. package/api/@wtf/release-npm/publishers/variables/PUBLISHERS.md +1 -1
  188. package/api/@wtf/release-npm/publishers/variables/npmPublisher.md +1 -1
  189. package/api/@wtf/release-npm/publishers/variables/pnpmPublisher.md +1 -1
  190. package/api/@wtf/release-npm/release/functions/checkTrain.md +1 -1
  191. package/api/@wtf/release-npm/release/functions/distTagOf.md +1 -1
  192. package/api/@wtf/release-npm/release/functions/packTrain.md +1 -1
  193. package/api/@wtf/release-npm/release/functions/publishPacked.md +1 -1
  194. package/api/@wtf/release-npm/release/functions/publishTrain.md +1 -1
  195. package/api/@wtf/release-npm/release/functions/publishedOf.md +1 -1
  196. package/api/@wtf/release-npm/release/functions/publishedOfResolved.md +1 -1
  197. package/api/@wtf/release-npm/release/functions/releaseTrain.md +1 -1
  198. package/api/@wtf/release-npm/release/functions/resolveManifests.md +1 -1
  199. package/api/@wtf/release-npm/release/functions/tagTrain.md +1 -1
  200. package/api/@wtf/release-npm/release/interfaces/CheckRelease.md +19 -19
  201. package/api/@wtf/release-npm/release/interfaces/PackOptions.md +8 -8
  202. package/api/@wtf/release-npm/release/interfaces/PackedTrain.md +13 -13
  203. package/api/@wtf/release-npm/release/interfaces/PublishRun.md +11 -11
  204. package/api/@wtf/release-npm/release/interfaces/PublishedOf.md +4 -4
  205. package/api/@wtf/release-npm/release/interfaces/PublishedPackage.md +18 -7
  206. package/api/@wtf/release-npm/release/interfaces/PublishedTrain.md +5 -5
  207. package/api/@wtf/release-npm/release/interfaces/ResolveRelease.md +18 -18
  208. package/api/@wtf/release-npm/release/interfaces/ResolvedPackage.md +4 -4
  209. package/api/@wtf/release-npm/release/interfaces/ResolvedTrain.md +6 -6
  210. package/api/@wtf/release-npm/release/interfaces/TagRelease.md +14 -14
  211. package/api/@wtf/release-npm/release/type-aliases/LookedUpTrain.md +1 -1
  212. package/api/@wtf/release-npm/release/type-aliases/ReleaseRun.md +1 -1
  213. package/api/@wtf/release-npm/release/variables/ID_TOKENS.md +1 -1
  214. package/api/@wtf/release-npm/release/variables/RUNNER_ENVIRONMENTS.md +1 -1
  215. package/api/@wtf/release-npm/workspace/functions/pnpmWorkspaceGlobs.md +1 -1
  216. package/api/@wtf/release-npm/workspace/functions/publishableOf.md +1 -1
  217. package/api/@wtf/release-npm/workspace/functions/readWorkspace.md +1 -1
  218. package/api/@wtf/release-npm/workspace/functions/workspaceFolders.md +1 -1
  219. package/api/@wtf/release-npm/workspace/functions/workspaceGlobs.md +1 -1
  220. package/api/@wtf/release-npm/workspace/interfaces/WorkspaceGlobs.md +3 -3
  221. package/api/@wtf/release-npm/workspace/interfaces/WorkspaceOptions.md +2 -2
  222. package/api/@wtf/release-replace/errors/classes/ReplaceError.md +5 -5
  223. package/api/@wtf/release-replace/errors/type-aliases/ReplaceErrorCode.md +1 -1
  224. package/api/@wtf/release-replace/errors/variables/REPLACE_ERRORS.md +1 -1
  225. package/api/@wtf/release-replace/files/functions/filesMatcher.md +1 -1
  226. package/api/@wtf/release-replace/interfaces/ReplaceMatch.md +5 -5
  227. package/api/@wtf/release-replace/interfaces/ReplacementOf.md +5 -5
  228. package/api/@wtf/release-replace/replace/functions/regExpOf.md +1 -1
  229. package/api/@wtf/release-replace/replace/functions/replaceFiles.md +1 -1
  230. package/api/@wtf/release-replace/replace/functions/replaceText.md +1 -1
  231. package/api/@wtf/release-replace/replace/interfaces/ReplaceOptions.md +10 -10
  232. package/api/@wtf/release-replace/replace/interfaces/TextOptions.md +5 -5
  233. package/api/@wtf/release-replace/replace/type-aliases/To.md +1 -1
  234. package/api/@wtf/release-replace/templates/functions/mergeTemplates.md +1 -1
  235. package/api/@wtf/release-replace/templates/functions/resolveReplacement.md +1 -1
  236. package/api/@wtf/release-replace/templates/functions/resolveReplacements.md +1 -1
  237. package/api/@wtf/release-replace/type-aliases/Escape.md +1 -1
  238. package/api/@wtf/release-replace/type-aliases/ReplaceFunction.md +1 -1
  239. package/api/@wtf/release-replace/type-aliases/Replacement.md +1 -1
  240. package/api/@wtf/release-replace/type-aliases/ReplacementSpec.md +1 -1
  241. package/api/@wtf/release-replace/type-aliases/TemplateUse.md +1 -1
  242. package/api/@wtf/release-replace/type-aliases/Templates.md +1 -1
  243. package/api/@wtf/release-replace/values/functions/escapeValue.md +1 -1
  244. package/api/@wtf/release-replace/values/functions/textOf.md +1 -1
  245. package/api/@wtf/release-replace/values/functions/valueAt.md +1 -1
  246. package/api/@wtf/release-replace/values/variables/ESCAPES.md +1 -1
  247. package/api/@wtf/release-replace/values/variables/VALUE.md +1 -1
  248. package/api/@wtf/release-system/errors/classes/ReleaseError.md +5 -5
  249. package/api/@wtf/release-system/errors/functions/throwAll.md +1 -1
  250. package/api/@wtf/release-system/errors/type-aliases/ErrorClass.md +1 -1
  251. package/api/@wtf/release-system/errors/type-aliases/SystemErrorCode.md +1 -1
  252. package/api/@wtf/release-system/errors/variables/SYSTEM_ERRORS.md +1 -1
  253. package/api/@wtf/release-system/git/functions/commitsSince.md +1 -1
  254. package/api/@wtf/release-system/git/functions/filesOfCommits.md +1 -1
  255. package/api/@wtf/release-system/git/functions/git.md +1 -1
  256. package/api/@wtf/release-system/git/functions/gitOf.md +1 -1
  257. package/api/@wtf/release-system/git/functions/trackedFiles.md +1 -1
  258. package/api/@wtf/release-system/git/interfaces/GitContext.md +4 -4
  259. package/api/@wtf/release-system/git/interfaces/LogCommit.md +5 -5
  260. package/api/@wtf/release-system/node/functions/nodeSystem.md +1 -1
  261. package/api/@wtf/release-system/node/functions/realPathOf.md +1 -1
  262. package/api/@wtf/release-system/node/functions/systemOf.md +1 -1
  263. package/api/@wtf/release-system/paths/functions/normalizePath.md +1 -1
  264. package/api/@wtf/release-system/paths/functions/pathMatcher.md +1 -1
  265. package/api/@wtf/release-system/paths/type-aliases/PathMatcher.md +1 -1
  266. package/api/@wtf/release-system/posix/functions/basenameOf.md +1 -1
  267. package/api/@wtf/release-system/posix/functions/dirnameOf.md +1 -1
  268. package/api/@wtf/release-system/posix/functions/joinPath.md +1 -1
  269. package/api/@wtf/release-system/posix/functions/relativePath.md +1 -1
  270. package/api/@wtf/release-system/posix/functions/resolvePath.md +1 -1
  271. package/api/@wtf/release-system/system/interfaces/DirEntry.md +3 -3
  272. package/api/@wtf/release-system/system/interfaces/ExecOptions.md +4 -4
  273. package/api/@wtf/release-system/system/interfaces/ExecResult.md +4 -4
  274. package/api/@wtf/release-system/system/interfaces/System.md +7 -7
  275. package/api/@wtf/release-system/system/interfaces/SystemFs.md +8 -8
  276. package/api/@wtf/release-system/system/type-aliases/Exec.md +1 -1
  277. package/api/@wtf/release-system/system/type-aliases/SystemInput.md +1 -1
  278. package/api/@wtf/release-system/validator/functions/allOf.md +1 -1
  279. package/api/@wtf/release-system/validator/functions/anyObject.md +1 -1
  280. package/api/@wtf/release-system/validator/functions/anyOf.md +1 -1
  281. package/api/@wtf/release-system/validator/functions/arrayOf.md +1 -1
  282. package/api/@wtf/release-system/validator/functions/booleanOf.md +1 -1
  283. package/api/@wtf/release-system/validator/functions/errorOf.md +1 -1
  284. package/api/@wtf/release-system/validator/functions/errorsOf.md +1 -1
  285. package/api/@wtf/release-system/validator/functions/exclusive.md +1 -1
  286. package/api/@wtf/release-system/validator/functions/issuesOf.md +1 -1
  287. package/api/@wtf/release-system/validator/functions/objectOf.md +1 -1
  288. package/api/@wtf/release-system/validator/functions/oneOf.md +1 -1
  289. package/api/@wtf/release-system/validator/functions/orFunction.md +1 -1
  290. package/api/@wtf/release-system/validator/functions/pathText.md +1 -1
  291. package/api/@wtf/release-system/validator/functions/pluginEntriesOf.md +1 -1
  292. package/api/@wtf/release-system/validator/functions/recordOf.md +1 -1
  293. package/api/@wtf/release-system/validator/functions/refined.md +1 -1
  294. package/api/@wtf/release-system/validator/functions/stringOf.md +1 -1
  295. package/api/@wtf/release-system/validator/functions/tupleOf.md +1 -1
  296. package/api/@wtf/release-system/validator/interfaces/ArrayOptions.md +5 -5
  297. package/api/@wtf/release-system/validator/interfaces/IssueOptions.md +4 -4
  298. package/api/@wtf/release-system/validator/interfaces/ObjectOptions.md +5 -5
  299. package/api/@wtf/release-system/validator/interfaces/OptionIssue.md +4 -4
  300. package/api/@wtf/release-system/validator/interfaces/Property.md +4 -4
  301. package/api/@wtf/release-system/validator/interfaces/RecordOptions.md +6 -6
  302. package/api/@wtf/release-system/validator/interfaces/StringOptions.md +6 -6
  303. package/api/@wtf/release-system/validator/interfaces/Validator.md +4 -4
  304. package/api/@wtf/release-system/validator/type-aliases/JsonSchema.md +1 -1
  305. package/api/@wtf/release-system/validator/type-aliases/Path.md +1 -1
  306. package/api/@wtf/release-trains/README.md +4 -0
  307. package/api/@wtf/release-trains/cascade/functions/cascadeNotes.md +1 -1
  308. package/api/@wtf/release-trains/cascade/functions/cascadeText.md +1 -1
  309. package/api/@wtf/release-trains/cascade/functions/cascadeType.md +1 -1
  310. package/api/@wtf/release-trains/cascade/functions/cascadesOf.md +1 -1
  311. package/api/@wtf/release-trains/cascade/functions/higherType.md +1 -1
  312. package/api/@wtf/release-trains/cascade/interfaces/Cascade.md +11 -11
  313. package/api/@wtf/release-trains/cascade/interfaces/CascadeCheck.md +8 -8
  314. package/api/@wtf/release-trains/cascade/type-aliases/CascadeKind.md +1 -1
  315. package/api/@wtf/release-trains/cascade/type-aliases/ReleaseType.md +1 -1
  316. package/api/@wtf/release-trains/cascade/variables/RELEASE_TYPES.md +1 -1
  317. package/api/@wtf/release-trains/ecosystem/functions/isEcosystem.md +1 -1
  318. package/api/@wtf/release-trains/ecosystem/functions/loadEcosystems.md +1 -1
  319. package/api/@wtf/release-trains/ecosystem/functions/readPackages.md +1 -1
  320. package/api/@wtf/release-trains/ecosystem/interfaces/Dependency.md +4 -4
  321. package/api/@wtf/release-trains/ecosystem/interfaces/Ecosystem.md +5 -5
  322. package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemContext.md +5 -5
  323. package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemPackages.md +3 -3
  324. package/api/@wtf/release-trains/ecosystem/interfaces/Package.md +6 -6
  325. package/api/@wtf/release-trains/ecosystem/type-aliases/DependencyKind.md +1 -1
  326. package/api/@wtf/release-trains/ecosystem/type-aliases/ModuleLoader.md +1 -1
  327. package/api/@wtf/release-trains/ecosystem/variables/DEPENDENCY_KINDS.md +1 -1
  328. package/api/@wtf/release-trains/errors/classes/TrainsError.md +5 -5
  329. package/api/@wtf/release-trains/errors/type-aliases/TrainsErrorCode.md +1 -1
  330. package/api/@wtf/release-trains/errors/variables/TRAINS_ERRORS.md +13 -1
  331. package/api/@wtf/release-trains/generated/functions/filesIn.md +1 -1
  332. package/api/@wtf/release-trains/generated/functions/formatGenerated.md +1 -1
  333. package/api/@wtf/release-trains/generated/functions/listGenerated.md +1 -1
  334. package/api/@wtf/release-trains/generated/functions/parseGenerated.md +1 -1
  335. package/api/@wtf/release-trains/generated/functions/readGenerated.md +1 -1
  336. package/api/@wtf/release-trains/generated/functions/stageGenerated.md +1 -1
  337. package/api/@wtf/release-trains/generated/functions/stageGeneratedFolders.md +1 -1
  338. package/api/@wtf/release-trains/generated/functions/unlistedIn.md +1 -1
  339. package/api/@wtf/release-trains/generated/interfaces/GeneratedOptions.md +2 -2
  340. package/api/@wtf/release-trains/generated/interfaces/StageOptions.md +6 -6
  341. package/api/@wtf/release-trains/generated/variables/GENERATED.md +1 -1
  342. package/api/@wtf/release-trains/git/functions/tagOf.md +1 -1
  343. package/api/@wtf/release-trains/git/functions/tagsOf.md +1 -1
  344. package/api/@wtf/release-trains/git/functions/versionOfTag.md +1 -1
  345. package/api/@wtf/release-trains/git/interfaces/TrainTag.md +3 -3
  346. package/api/@wtf/release-trains/gitlab/README.md +57 -0
  347. package/api/@wtf/release-trains/gitlab/functions/findPackage.md +32 -0
  348. package/api/@wtf/release-trains/gitlab/functions/gitlabHeadersOf.md +35 -0
  349. package/api/@wtf/release-trains/gitlab/functions/gitlabProjectOf.md +43 -0
  350. package/api/@wtf/release-trains/gitlab/functions/gitlabRegistryOf.md +29 -0
  351. package/api/@wtf/release-trains/gitlab/functions/uploadGeneric.md +30 -0
  352. package/api/@wtf/release-trains/gitlab/interfaces/GenericUpload.md +81 -0
  353. package/api/@wtf/release-trains/gitlab/interfaces/GitLabOptions.md +42 -0
  354. package/api/@wtf/release-trains/gitlab/interfaces/GitLabProject.md +61 -0
  355. package/api/@wtf/release-trains/gitlab/interfaces/GitLabRegistry.md +51 -0
  356. package/api/@wtf/release-trains/gitlab/interfaces/HttpResponse.md +47 -0
  357. package/api/@wtf/release-trains/gitlab/interfaces/PackageQuery.md +72 -0
  358. package/api/@wtf/release-trains/gitlab/type-aliases/HttpFetch.md +43 -0
  359. package/api/@wtf/release-trains/interfaces/Train.md +7 -7
  360. package/api/@wtf/release-trains/links/README.md +54 -0
  361. package/api/@wtf/release-trains/links/functions/forgetReleased.md +25 -0
  362. package/api/@wtf/release-trains/links/functions/recordReleased.md +39 -0
  363. package/api/@wtf/release-trains/links/functions/releaseLinks.md +41 -0
  364. package/api/@wtf/release-trains/links/functions/releasedOf.md +28 -0
  365. package/api/@wtf/release-trains/links/interfaces/LinkOptions.md +127 -0
  366. package/api/@wtf/release-trains/links/interfaces/PackageRegistry.md +41 -0
  367. package/api/@wtf/release-trains/links/interfaces/ReleaseLink.md +41 -0
  368. package/api/@wtf/release-trains/links/interfaces/ReleaseRun.md +41 -0
  369. package/api/@wtf/release-trains/links/interfaces/ReleasedPackage.md +92 -0
  370. package/api/@wtf/release-trains/packages/functions/dependencyEdges.md +1 -1
  371. package/api/@wtf/release-trains/packages/functions/dependencyText.md +1 -1
  372. package/api/@wtf/release-trains/packages/functions/dependsOnErrors.md +1 -1
  373. package/api/@wtf/release-trains/packages/functions/normalizeDir.md +1 -1
  374. package/api/@wtf/release-trains/packages/functions/ownersOf.md +1 -1
  375. package/api/@wtf/release-trains/packages/functions/packagesOf.md +1 -1
  376. package/api/@wtf/release-trains/packages/functions/publishOrder.md +1 -1
  377. package/api/@wtf/release-trains/packages/functions/releasedVersions.md +1 -1
  378. package/api/@wtf/release-trains/packages/functions/trainDependencies.md +1 -1
  379. package/api/@wtf/release-trains/packages/functions/trainOrder.md +1 -1
  380. package/api/@wtf/release-trains/packages/functions/unsatisfiedErrors.md +1 -1
  381. package/api/@wtf/release-trains/packages/interfaces/DependencyEdge.md +6 -6
  382. package/api/@wtf/release-trains/packages/interfaces/OrderFault.md +4 -4
  383. package/api/@wtf/release-trains/packages/interfaces/OrderPins.md +3 -3
  384. package/api/@wtf/release-trains/packages/interfaces/PublishOrder.md +3 -3
  385. package/api/@wtf/release-trains/packages/interfaces/TrainDependency.md +3 -3
  386. package/api/@wtf/release-trains/packages/interfaces/VersionsRelease.md +7 -7
  387. package/api/@wtf/release-trains/paths/functions/filterCommits.md +1 -1
  388. package/api/@wtf/release-trains/paths/functions/gitFilesOf.md +1 -1
  389. package/api/@wtf/release-trains/paths/functions/overlapError.md +1 -1
  390. package/api/@wtf/release-trains/paths/functions/trainOfPath.md +1 -1
  391. package/api/@wtf/release-trains/paths/functions/trainsOfCommit.md +1 -1
  392. package/api/@wtf/release-trains/paths/functions/trainsOfPath.md +1 -1
  393. package/api/@wtf/release-trains/paths/type-aliases/FilesOf.md +1 -1
  394. package/api/@wtf/release-trains/schema/interfaces/ConfigPart.md +6 -6
  395. package/api/@wtf/release-trains/schema/interfaces/RootOptions.md +7 -7
  396. package/api/@wtf/release-trains/schema/type-aliases/DependencyRule.md +1 -1
  397. package/api/@wtf/release-trains/schema/variables/DEPENDENCY_RULES.md +1 -1
  398. package/api/@wtf/release-trains/schema/variables/TAG_FORMAT_PATTERN.md +1 -1
  399. package/api/@wtf/release-trains/schema/variables/TRAIN_NAME_PATTERN.md +1 -1
  400. package/api/@wtf/release-trains/schema/variables/configSchema.md +1 -1
  401. package/api/@wtf/release-trains/schema/variables/jsonSchema.md +1 -1
  402. package/api/@wtf/release-trains/schema/variables/rootOptionsSchema.md +1 -1
  403. package/api/@wtf/release-trains/schema/variables/trainSchema.md +1 -1
  404. package/api/@wtf/release-trains/schema/variables/trainsSchema.md +1 -1
  405. package/api/@wtf/release-trains/trains/functions/changelogOf.md +1 -1
  406. package/api/@wtf/release-trains/trains/functions/matchersOf.md +1 -1
  407. package/api/@wtf/release-trains/trains/functions/overlapErrors.md +1 -1
  408. package/api/@wtf/release-trains/trains/functions/selectTrain.md +1 -1
  409. package/api/@wtf/release-trains/trains/functions/tagFormatOf.md +1 -1
  410. package/api/@wtf/release-trains/trains/functions/trainHeadedNotes.md +1 -1
  411. package/api/@wtf/release-trains/trains/functions/trainOfRun.md +1 -1
  412. package/api/@wtf/release-trains/trains/functions/trainOfTag.md +1 -1
  413. package/api/@wtf/release-trains/trains/functions/trainsErrors.md +1 -1
  414. package/api/@wtf/release-trains/trains/functions/trainsOfOptions.md +1 -1
  415. package/api/@wtf/release-trains/trains/variables/TRAIN_VARIABLE.md +1 -1
  416. package/api/@wtf/release-trains/trains/variables/VERSION.md +1 -1
  417. package/api/@wtf/release-trains/type-aliases/BranchSpec.md +1 -1
  418. package/api/@wtf/release-trains/type-aliases/Trains.md +1 -1
  419. package/api/@wtf/release-trains/verify/functions/unreleasedDependencies.md +1 -1
  420. package/api/@wtf/release-trains/verify/functions/verifyTrain.md +1 -1
  421. package/api/@wtf/release-trains/verify/interfaces/UnreleasedDependencies.md +10 -10
  422. package/api/@wtf/release-trains/verify/interfaces/VerifiedTrain.md +5 -5
  423. package/api/@wtf/release-trains/verify/interfaces/VerifyRelease.md +8 -8
  424. package/api/@wtf/release-validate/errors/classes/ValidateError.md +5 -5
  425. package/api/@wtf/release-validate/errors/type-aliases/ValidateErrorCode.md +1 -1
  426. package/api/@wtf/release-validate/errors/variables/VALIDATE_ERRORS.md +1 -1
  427. package/api/@wtf/release-validate/interfaces/ConfigIssue.md +4 -4
  428. package/api/@wtf/release-validate/json-schema/functions/fromJsonSchema.md +1 -1
  429. package/api/@wtf/release-validate/json-schema/functions/pathOfPointer.md +1 -1
  430. package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaError.md +3 -3
  431. package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaValidator.md +3 -3
  432. package/api/@wtf/release-validate/validate/functions/configErrors.md +1 -1
  433. package/api/@wtf/release-validate/validate/functions/isStandardSchema.md +1 -1
  434. package/api/@wtf/release-validate/validate/functions/pathText.md +1 -1
  435. package/api/@wtf/release-validate/validate/functions/validateConfig.md +1 -1
  436. package/api/@wtf/semantic-release-cargo/README.md +3 -1
  437. package/api/@wtf/semantic-release-cargo/functions/indexLookup.md +1 -1
  438. package/api/@wtf/semantic-release-cargo/functions/prepare.md +1 -1
  439. package/api/@wtf/semantic-release-cargo/functions/publish.md +1 -1
  440. package/api/@wtf/semantic-release-cargo/functions/verifyConditions.md +1 -1
  441. package/api/@wtf/semantic-release-cargo/interfaces/CargoPluginOptions.md +12 -12
  442. package/api/@wtf/semantic-release-cargo/interfaces/CargoRelease.md +3 -3
  443. package/api/@wtf/semantic-release-cargo/schema/type-aliases/CargoOptions.md +1 -1
  444. package/api/@wtf/semantic-release-cargo/schema/variables/cargoOptionsSchema.md +1 -1
  445. package/api/@wtf/semantic-release-cargo/schema/variables/cargoSchema.md +1 -1
  446. package/api/@wtf/semantic-release-cargo/schema/variables/configSchema.md +1 -1
  447. package/api/@wtf/semantic-release-cargo/schema/variables/jsonSchema.md +1 -1
  448. package/api/@wtf/semantic-release-cargo/variables/default.md +1 -1
  449. package/api/@wtf/semantic-release-go/README.md +3 -1
  450. package/api/@wtf/semantic-release-go/functions/prepare.md +1 -1
  451. package/api/@wtf/semantic-release-go/functions/publish.md +1 -1
  452. package/api/@wtf/semantic-release-go/functions/verifyConditions.md +1 -1
  453. package/api/@wtf/semantic-release-go/functions/verifyRelease.md +1 -1
  454. package/api/@wtf/semantic-release-go/interfaces/GoPluginOptions.md +8 -8
  455. package/api/@wtf/semantic-release-go/interfaces/GoRelease.md +3 -3
  456. package/api/@wtf/semantic-release-go/schema/type-aliases/GoOptions.md +1 -1
  457. package/api/@wtf/semantic-release-go/schema/variables/configSchema.md +1 -1
  458. package/api/@wtf/semantic-release-go/schema/variables/goOptionsSchema.md +1 -1
  459. package/api/@wtf/semantic-release-go/schema/variables/goSchema.md +1 -1
  460. package/api/@wtf/semantic-release-go/schema/variables/jsonSchema.md +1 -1
  461. package/api/@wtf/semantic-release-go/variables/default.md +1 -1
  462. package/api/@wtf/semantic-release-maven/README.md +3 -1
  463. package/api/@wtf/semantic-release-maven/functions/pomLookup.md +1 -1
  464. package/api/@wtf/semantic-release-maven/functions/prepare.md +1 -1
  465. package/api/@wtf/semantic-release-maven/functions/publish.md +1 -1
  466. package/api/@wtf/semantic-release-maven/functions/verifyConditions.md +1 -1
  467. package/api/@wtf/semantic-release-maven/interfaces/LookupAuth.md +3 -3
  468. package/api/@wtf/semantic-release-maven/interfaces/MavenPluginOptions.md +12 -12
  469. package/api/@wtf/semantic-release-maven/interfaces/MavenRelease.md +2 -2
  470. package/api/@wtf/semantic-release-maven/schema/type-aliases/MavenOptions.md +1 -1
  471. package/api/@wtf/semantic-release-maven/schema/variables/configSchema.md +1 -1
  472. package/api/@wtf/semantic-release-maven/schema/variables/jsonSchema.md +1 -1
  473. package/api/@wtf/semantic-release-maven/schema/variables/mavenOptionsSchema.md +1 -1
  474. package/api/@wtf/semantic-release-maven/schema/variables/mavenSchema.md +1 -1
  475. package/api/@wtf/semantic-release-maven/variables/default.md +1 -1
  476. package/api/@wtf/semantic-release-npm/README.md +4 -1
  477. package/api/@wtf/semantic-release-npm/functions/addChannel.md +1 -1
  478. package/api/@wtf/semantic-release-npm/functions/fail.md +1 -1
  479. package/api/@wtf/semantic-release-npm/functions/loadPublisher.md +1 -1
  480. package/api/@wtf/semantic-release-npm/functions/prepare.md +1 -1
  481. package/api/@wtf/semantic-release-npm/functions/publish.md +1 -1
  482. package/api/@wtf/semantic-release-npm/functions/verifyConditions.md +1 -1
  483. package/api/@wtf/semantic-release-npm/interfaces/PublishPluginOptions.md +21 -21
  484. package/api/@wtf/semantic-release-npm/interfaces/PublishedRelease.md +4 -4
  485. package/api/@wtf/semantic-release-npm/interfaces/SmokeOption.md +2 -2
  486. package/api/@wtf/semantic-release-npm/schema/type-aliases/PublishOptions.md +1 -1
  487. package/api/@wtf/semantic-release-npm/schema/variables/configSchema.md +1 -1
  488. package/api/@wtf/semantic-release-npm/schema/variables/jsonSchema.md +1 -1
  489. package/api/@wtf/semantic-release-npm/schema/variables/publishOptionsSchema.md +1 -1
  490. package/api/@wtf/semantic-release-npm/schema/variables/publishSchema.md +1 -1
  491. package/api/@wtf/semantic-release-npm/type-aliases/PublisherSpec.md +1 -1
  492. package/api/@wtf/semantic-release-npm/variables/default.md +1 -1
  493. package/api/@wtf/semantic-release-replace/functions/functionOf.md +1 -1
  494. package/api/@wtf/semantic-release-replace/functions/prepare.md +1 -1
  495. package/api/@wtf/semantic-release-replace/functions/templatesOf.md +1 -1
  496. package/api/@wtf/semantic-release-replace/functions/verifyConditions.md +1 -1
  497. package/api/@wtf/semantic-release-replace/interfaces/ReplacePluginOptions.md +5 -5
  498. package/api/@wtf/semantic-release-replace/schema/interfaces/ModuleExport.md +3 -3
  499. package/api/@wtf/semantic-release-replace/schema/interfaces/ReplaceOptions.md +4 -4
  500. package/api/@wtf/semantic-release-replace/schema/interfaces/RootTemplates.md +2 -2
  501. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacement.md +1 -1
  502. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacementSpec.md +1 -1
  503. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTemplates.md +1 -1
  504. package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTo.md +1 -1
  505. package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplateSet.md +1 -1
  506. package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplatesOption.md +1 -1
  507. package/api/@wtf/semantic-release-replace/schema/variables/configSchema.md +1 -1
  508. package/api/@wtf/semantic-release-replace/schema/variables/exportedSetSchema.md +1 -1
  509. package/api/@wtf/semantic-release-replace/schema/variables/jsonSchema.md +1 -1
  510. package/api/@wtf/semantic-release-replace/schema/variables/replaceOptionsSchema.md +1 -1
  511. package/api/@wtf/semantic-release-replace/schema/variables/replacementSchema.md +1 -1
  512. package/api/@wtf/semantic-release-replace/schema/variables/rootTemplatesSchema.md +1 -1
  513. package/api/@wtf/semantic-release-replace/schema/variables/templateSchema.md +1 -1
  514. package/api/@wtf/semantic-release-replace/schema/variables/templatesSchema.md +1 -1
  515. package/api/@wtf/semantic-release-replace/variables/default.md +1 -1
  516. package/api/@wtf/semantic-release-trains/README.md +2 -1
  517. package/api/@wtf/semantic-release-trains/config/functions/skipPlugins.md +1 -1
  518. package/api/@wtf/semantic-release-trains/config/functions/stepId.md +1 -1
  519. package/api/@wtf/semantic-release-trains/config/functions/trainAssets.md +1 -1
  520. package/api/@wtf/semantic-release-trains/config/functions/trainChangelog.md +1 -1
  521. package/api/@wtf/semantic-release-trains/config/functions/trainOfTag.md +1 -1
  522. package/api/@wtf/semantic-release-trains/config/functions/trainTagFormat.md +1 -1
  523. package/api/@wtf/semantic-release-trains/config/interfaces/AssetsOptions.md +4 -4
  524. package/api/@wtf/semantic-release-trains/config/interfaces/SkipOptions.md +3 -3
  525. package/api/@wtf/semantic-release-trains/config/variables/BRANCHES.md +1 -1
  526. package/api/@wtf/semantic-release-trains/config/variables/BREAKING.md +1 -1
  527. package/api/@wtf/semantic-release-trains/config/variables/TITLE.md +1 -1
  528. package/api/@wtf/semantic-release-trains/defaults/README.md +16 -6
  529. package/api/@wtf/semantic-release-trains/defaults/functions/skipRuleOf.md +1 -1
  530. package/api/@wtf/semantic-release-trains/defaults/functions/skips.md +1 -1
  531. package/api/@wtf/semantic-release-trains/defaults/functions/stepOptionsOf.md +35 -0
  532. package/api/@wtf/semantic-release-trains/defaults/functions/trainOptionsOf.md +1 -1
  533. package/api/@wtf/semantic-release-trains/defaults/interfaces/SkipContext.md +5 -5
  534. package/api/@wtf/semantic-release-trains/defaults/interfaces/StepOptionsContext.md +61 -0
  535. package/api/@wtf/semantic-release-trains/defaults/type-aliases/SkipCheck.md +1 -1
  536. package/api/@wtf/semantic-release-trains/defaults/type-aliases/StepOptions.md +28 -0
  537. package/api/@wtf/semantic-release-trains/defaults/type-aliases/TrainOptions.md +1 -1
  538. package/api/@wtf/semantic-release-trains/defaults/variables/SKIP_RULES.md +1 -1
  539. package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_OPTIONS.md +1 -1
  540. package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_SKIP.md +1 -1
  541. package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_STEP_OPTIONS.md +16 -0
  542. package/api/@wtf/semantic-release-trains/defaults/variables/releaseAssets.md +31 -0
  543. package/api/@wtf/semantic-release-trains/errors/type-aliases/PluginErrorCode.md +1 -1
  544. package/api/@wtf/semantic-release-trains/errors/variables/PLUGIN_ERRORS.md +1 -1
  545. package/api/@wtf/semantic-release-trains/info/functions/decideTrain.md +1 -1
  546. package/api/@wtf/semantic-release-trains/info/functions/dotenvOf.md +1 -1
  547. package/api/@wtf/semantic-release-trains/info/functions/infoOf.md +1 -1
  548. package/api/@wtf/semantic-release-trains/info/interfaces/DecideRun.md +4 -4
  549. package/api/@wtf/semantic-release-trains/info/interfaces/InfoRun.md +8 -8
  550. package/api/@wtf/semantic-release-trains/info/interfaces/TrainDecision.md +5 -5
  551. package/api/@wtf/semantic-release-trains/info/interfaces/TrainInfo.md +5 -5
  552. package/api/@wtf/semantic-release-trains/interfaces/TrainsEntryOptions.md +5 -5
  553. package/api/@wtf/semantic-release-trains/interfaces/TrainsOptions.md +7 -7
  554. package/api/@wtf/semantic-release-trains/schema/variables/configSchema.md +1 -1
  555. package/api/@wtf/semantic-release-trains/schema/variables/jsonSchema.md +1 -1
  556. package/api/@wtf/semantic-release-trains/schema/variables/pluginSpecSchema.md +1 -1
  557. package/api/@wtf/semantic-release-trains/schema/variables/skipRuleSchema.md +1 -1
  558. package/api/@wtf/semantic-release-trains/schema/variables/trainsEntrySchema.md +1 -1
  559. package/api/@wtf/semantic-release-trains/schema/variables/trainsPluginSchema.md +1 -1
  560. package/api/@wtf/semantic-release-trains/type-aliases/PluginSpec.md +1 -1
  561. package/api/@wtf/semantic-release-trains/type-aliases/TrainsPluginOptions.md +1 -1
  562. package/api/@wtf/semantic-release-trains/variables/addChannel.md +1 -1
  563. package/api/@wtf/semantic-release-trains/variables/analyzeCommits.md +1 -1
  564. package/api/@wtf/semantic-release-trains/variables/default.md +1 -1
  565. package/api/@wtf/semantic-release-trains/variables/fail.md +1 -1
  566. package/api/@wtf/semantic-release-trains/variables/generateNotes.md +1 -1
  567. package/api/@wtf/semantic-release-trains/variables/prepare.md +1 -1
  568. package/api/@wtf/semantic-release-trains/variables/publish.md +1 -1
  569. package/api/@wtf/semantic-release-trains/variables/success.md +1 -1
  570. package/api/@wtf/semantic-release-trains/variables/verifyConditions.md +1 -1
  571. package/api/@wtf/semantic-release-trains/variables/verifyRelease.md +1 -1
  572. package/api/@wtf/semantic-release-validate/functions/configOf.md +1 -1
  573. package/api/@wtf/semantic-release-validate/functions/loadSchema.md +1 -1
  574. package/api/@wtf/semantic-release-validate/functions/verifyConditions.md +1 -1
  575. package/api/@wtf/semantic-release-validate/interfaces/ValidatePluginOptions.md +2 -2
  576. package/api/@wtf/semantic-release-validate/schema/interfaces/Validator.md +2 -2
  577. package/api/@wtf/semantic-release-validate/schema/variables/configSchema.md +1 -1
  578. package/api/@wtf/semantic-release-validate/schema/variables/jsonSchema.md +1 -1
  579. package/api/@wtf/semantic-release-validate/schema/variables/validateOptionsSchema.md +1 -1
  580. package/api/@wtf/semantic-release-validate/variables/default.md +1 -1
  581. package/api/README.md +2 -0
  582. package/guides/ci-recipes.md +2 -2
  583. package/guides/getting-started.md +2 -0
  584. package/guides/publishing-crates.md +15 -2
  585. package/guides/publishing-go-modules.md +12 -2
  586. package/guides/publishing-maven.md +15 -1
  587. package/guides/publishing.md +45 -3
  588. package/guides/validating-a-config.md +10 -4
  589. package/package.json +11 -11
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **DependencyKind** = `"runtime"` \| `"peer"` \| `"build"` \| `"dev"`
10
10
 
11
- Defined in: [packages/release-trains/src/ecosystem.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L40)
11
+ Defined in: [packages/release-trains/src/ecosystem.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/ecosystem.ts#L40)
12
12
 
13
13
  How a package depends on another: `runtime`, what it runs with; `peer`, what its users install
14
14
  beside it; `build`, what its build runs with; and `dev`, what its own tests and tools run with,
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **ModuleLoader** = (`name`) => `Promise`\<`unknown`\>
10
10
 
11
- Defined in: [packages/release-trains/src/ecosystem.ts:151](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L151)
11
+ Defined in: [packages/release-trains/src/ecosystem.ts:151](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/ecosystem.ts#L151)
12
12
 
13
13
  What loads a module of its name, as `import()` of a plugin does, of where the plugin finds it:
14
14
  the module's namespace, of its default export.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **DEPENDENCY\_KINDS**: readonly [`DependencyKind`](../type-aliases/DependencyKind.md)[]
10
10
 
11
- Defined in: [packages/release-trains/src/ecosystem.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L43)
11
+ Defined in: [packages/release-trains/src/ecosystem.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/ecosystem.ts#L43)
12
12
 
13
13
  Each [DependencyKind](../type-aliases/DependencyKind.md), in the order a cascade judges them.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: TrainsError
8
8
 
9
- Defined in: [packages/release-trains/src/errors.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/errors.ts#L46)
9
+ Defined in: [packages/release-trains/src/errors.ts:51](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/errors.ts#L51)
10
10
 
11
11
  An error of a train, or of a package of release trains: a stable `code`, of
12
12
  [TRAINS\_ERRORS](../variables/TRAINS_ERRORS.md) or of the package's own, its `message` what is wrong, and its `details` how
@@ -22,7 +22,7 @@ to fix it. semantic-release prints it as a `SemanticReleaseError`.
22
22
 
23
23
  > **new TrainsError**(`code`, `message`, `details`): `TrainsError`
24
24
 
25
- Defined in: [packages/release-system/src/errors.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L54)
25
+ Defined in: [packages/release-system/src/errors.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-system/src/errors.ts#L54)
26
26
 
27
27
  An error of `code`, of its `message` and its `details`, named `SemanticReleaseError`, as
28
28
  semantic-release prints one.
@@ -73,7 +73,7 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
73
73
 
74
74
  > `readonly` **code**: `string`
75
75
 
76
- Defined in: [packages/release-system/src/errors.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L40)
76
+ Defined in: [packages/release-system/src/errors.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-system/src/errors.ts#L40)
77
77
 
78
78
  The stable code of the error, as `EGIT`.
79
79
 
@@ -87,7 +87,7 @@ The stable code of the error, as `EGIT`.
87
87
 
88
88
  > `readonly` **details**: `string`
89
89
 
90
- Defined in: [packages/release-system/src/errors.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L42)
90
+ Defined in: [packages/release-system/src/errors.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-system/src/errors.ts#L42)
91
91
 
92
92
  How to fix it.
93
93
 
@@ -125,7 +125,7 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
125
125
 
126
126
  > `readonly` **semanticRelease**: `true`
127
127
 
128
- Defined in: [packages/release-system/src/errors.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L44)
128
+ Defined in: [packages/release-system/src/errors.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-system/src/errors.ts#L44)
129
129
 
130
130
  The mark semantic-release prints an error of a plugin by.
131
131
 
@@ -8,6 +8,6 @@
8
8
 
9
9
  > **TrainsErrorCode** = keyof *typeof* [`TRAINS_ERRORS`](../variables/TRAINS_ERRORS.md)
10
10
 
11
- Defined in: [packages/release-trains/src/errors.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/errors.ts#L39)
11
+ Defined in: [packages/release-trains/src/errors.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/errors.ts#L44)
12
12
 
13
13
  A code of [TRAINS\_ERRORS](../variables/TRAINS_ERRORS.md).
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **TRAINS\_ERRORS**: `object`
10
10
 
11
- Defined in: [packages/release-trains/src/errors.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/errors.ts#L15)
11
+ Defined in: [packages/release-trains/src/errors.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/errors.ts#L15)
12
12
 
13
13
  The codes of the errors of the trains themselves, each with what it means.
14
14
 
@@ -42,10 +42,22 @@ The codes of the errors of the trains themselves, each with what it means.
42
42
 
43
43
  > `readonly` **EGENERATED**: `"A folder the build generates is not there."` = `'A folder the build generates is not there.'`
44
44
 
45
+ ### EGITLAB
46
+
47
+ > `readonly` **EGITLAB**: `"GitLab cannot be asked, or refused a request of the release of a tag."` = `'GitLab cannot be asked, or refused a request of the release of a tag.'`
48
+
49
+ ### EGITLABPACKAGE
50
+
51
+ > `readonly` **EGITLABPACKAGE**: `"A package registry of GitLab lists no package of the name and the version a release published."` = `'A package registry of GitLab lists no package of the name and the version a release published.'`
52
+
45
53
  ### EOPTIONS
46
54
 
47
55
  > `readonly` **EOPTIONS**: `` "An option of a plugin is missing, as `trains` or `ecosystems` of the root, or is not one it takes." `` = `` 'An option of a plugin is missing, as `trains` or `ecosystems` of the root, or is not one it takes.' ``
48
56
 
57
+ ### ERELEASELINK
58
+
59
+ > `readonly` **ERELEASELINK**: `"A package of a release has nothing to link it by: no page, no package registry of GitLab, no file and no folder."` = `'A package of a release has nothing to link it by: no page, no package registry of GitLab, no file and no folder.'`
60
+
49
61
  ### ETAGFORMAT
50
62
 
51
63
  > `readonly` **ETAGFORMAT**: `"The tag format of a train is not one that names its version, alone."` = `'The tag format of a train is not one that names its version, alone.'`
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **filesIn**(`folder`, `options`): `Promise`\<`string`[]\>
10
10
 
11
- Defined in: [packages/release-trains/src/generated.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L49)
11
+ Defined in: [packages/release-trains/src/generated.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L49)
12
12
 
13
13
  Each file in `folder` and the folders in it, relative to it, with `/`, in order.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **formatGenerated**(`files`): `string`
10
10
 
11
- Defined in: [packages/release-trains/src/generated.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L69)
11
+ Defined in: [packages/release-trains/src/generated.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L69)
12
12
 
13
13
  The text of a list of `files`: each, and the list itself, once, in order, one a line.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **listGenerated**(`root`, `dir`, `options`): `Promise`\<`string`[]\>
10
10
 
11
- Defined in: [packages/release-trains/src/generated.ts:91](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L91)
11
+ Defined in: [packages/release-trains/src/generated.ts:91](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L91)
12
12
 
13
13
  Lists each file in the folder `dir` of `root`, as the build generated it, in its
14
14
  [GENERATED](../variables/GENERATED.md), the list too, and gives them. Run it once the build has written the folder
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **parseGenerated**(`text`): `string`[]
10
10
 
11
- Defined in: [packages/release-trains/src/generated.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L78)
11
+ Defined in: [packages/release-trains/src/generated.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L78)
12
12
 
13
13
  The files a list names, of its text.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **readGenerated**(`root`, `dir`, `options`): `Promise`\<`string`[] \| `undefined`\>
10
10
 
11
- Defined in: [packages/release-trains/src/generated.ts:117](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L117)
11
+ Defined in: [packages/release-trains/src/generated.ts:117](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L117)
12
12
 
13
13
  The files the [GENERATED](../variables/GENERATED.md) of the folder `dir` of `root` lists; `undefined`, of no list.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **stageGenerated**(`dir`, `listed`): `string`[][]
10
10
 
11
- Defined in: [packages/release-trains/src/generated.ts:161](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L161)
11
+ Defined in: [packages/release-trains/src/generated.ts:161](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L161)
12
12
 
13
13
  The git commands that stage the folder `dir` for the release commit, each its arguments: as its
14
14
  [GENERATED](../variables/GENERATED.md) lists it, of `listed`, each file of it unstaged, each one the list names staged,
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **stageGeneratedFolders**(`options`): `Promise`\<`string`[]\>
10
10
 
11
- Defined in: [packages/release-trains/src/generated.ts:197](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L197)
11
+ Defined in: [packages/release-trains/src/generated.ts:197](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L197)
12
12
 
13
13
  Stages each of `folders` for the release commit, as [stageGenerated](stageGenerated.md) does, by git of the
14
14
  system: run it once the build has written them, and before the commit. Gives each it staged.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **unlistedIn**(`root`, `dir`, `options`): `Promise`\<`string`[] \| `undefined`\>
10
10
 
11
- Defined in: [packages/release-trains/src/generated.ts:138](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L138)
11
+ Defined in: [packages/release-trains/src/generated.ts:138](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L138)
12
12
 
13
13
  Each file in the folder `dir` of `root` that its [GENERATED](../variables/GENERATED.md) does not list: a file the
14
14
  build did not generate, as a page of the last release. None, of a folder that is not there;
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: GeneratedOptions
8
8
 
9
- Defined in: [packages/release-trains/src/generated.ts:38](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L38)
9
+ Defined in: [packages/release-trains/src/generated.ts:38](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L38)
10
10
 
11
11
  How a generated folder is read and written: by the system it is given, which it requires.
12
12
 
@@ -16,4 +16,4 @@ How a generated folder is read and written: by the system it is given, which it
16
16
 
17
17
  > `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
18
18
 
19
- Defined in: [packages/release-trains/src/generated.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L39)
19
+ Defined in: [packages/release-trains/src/generated.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L39)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: StageOptions
8
8
 
9
- Defined in: [packages/release-trains/src/generated.ts:172](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L172)
9
+ Defined in: [packages/release-trains/src/generated.ts:172](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L172)
10
10
 
11
11
  The staging of generated folders, for a release commit.
12
12
 
@@ -16,7 +16,7 @@ The staging of generated folders, for a release commit.
16
16
 
17
17
  > `readonly` `optional` **cwd?**: `string`
18
18
 
19
- Defined in: [packages/release-trains/src/generated.ts:176](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L176)
19
+ Defined in: [packages/release-trains/src/generated.ts:176](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L176)
20
20
 
21
21
  The folder of the repo: the system's working folder by default.
22
22
 
@@ -26,7 +26,7 @@ The folder of the repo: the system's working folder by default.
26
26
 
27
27
  > `readonly` `optional` **env?**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
28
28
 
29
- Defined in: [packages/release-trains/src/generated.ts:178](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L178)
29
+ Defined in: [packages/release-trains/src/generated.ts:178](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L178)
30
30
 
31
31
  The environment git runs in: the system's by default.
32
32
 
@@ -36,7 +36,7 @@ The environment git runs in: the system's by default.
36
36
 
37
37
  > `readonly` **folders**: readonly `string`[]
38
38
 
39
- Defined in: [packages/release-trains/src/generated.ts:174](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L174)
39
+ Defined in: [packages/release-trains/src/generated.ts:174](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L174)
40
40
 
41
41
  The folders, from the root of the repo, each as its build lists it in its [GENERATED](../variables/GENERATED.md).
42
42
 
@@ -46,7 +46,7 @@ The folders, from the root of the repo, each as its build lists it in its [GENER
46
46
 
47
47
  > `readonly` `optional` **log?**: (`line`) => `void`
48
48
 
49
- Defined in: [packages/release-trains/src/generated.ts:186](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L186)
49
+ Defined in: [packages/release-trains/src/generated.ts:186](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L186)
50
50
 
51
51
  Where each folder staged is said: nowhere by default.
52
52
 
@@ -68,6 +68,6 @@ The line of a folder staged, and of its list, where it has one.
68
68
 
69
69
  > `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
70
70
 
71
- Defined in: [packages/release-trains/src/generated.ts:180](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L180)
71
+ Defined in: [packages/release-trains/src/generated.ts:180](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L180)
72
72
 
73
73
  The system git and the files run by, which it requires.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **GENERATED**: `".generated"` = `'.generated'`
10
10
 
11
- Defined in: [packages/release-trains/src/generated.ts:35](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L35)
11
+ Defined in: [packages/release-trains/src/generated.ts:35](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/generated.ts#L35)
12
12
 
13
13
  The list of a generated folder, in it: each file the build generated there, one a line.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **tagOf**(`version`, `tagFormat`): `string`
10
10
 
11
- Defined in: [packages/release-trains/src/git.ts:50](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/git.ts#L50)
11
+ Defined in: [packages/release-trains/src/git.ts:50](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/git.ts#L50)
12
12
 
13
13
  The tag of `version` by a tag format: `core-v2.1.0` of `core-v${version}`.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **tagsOf**(`tagFormat`, `context`, `merged?`): `Promise`\<[`TrainTag`](../interfaces/TrainTag.md)[]\>
10
10
 
11
- Defined in: [packages/release-trains/src/git.ts:64](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/git.ts#L64)
11
+ Defined in: [packages/release-trains/src/git.ts:64](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/git.ts#L64)
12
12
 
13
13
  The tags of a tag format, highest version first: every tag of the repo, or those that `merged`
14
14
  holds.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **versionOfTag**(`tag`, `tagFormat`): `string` \| `undefined`
10
10
 
11
- Defined in: [packages/release-trains/src/git.ts:35](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/git.ts#L35)
11
+ Defined in: [packages/release-trains/src/git.ts:35](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/git.ts#L35)
12
12
 
13
13
  The version a tag names, of a tag format with `${version}` once, or `undefined` when the tag is
14
14
  not one of the format: 2.1.0 of `trains-v2.1.0` by `trains-v${version}`.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: TrainTag
8
8
 
9
- Defined in: [packages/release-trains/src/git.ts:21](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/git.ts#L21)
9
+ Defined in: [packages/release-trains/src/git.ts:21](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/git.ts#L21)
10
10
 
11
11
  A tag of a train, and the version it names.
12
12
 
@@ -16,7 +16,7 @@ A tag of a train, and the version it names.
16
16
 
17
17
  > `readonly` **tag**: `string`
18
18
 
19
- Defined in: [packages/release-trains/src/git.ts:22](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/git.ts#L22)
19
+ Defined in: [packages/release-trains/src/git.ts:22](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/git.ts#L22)
20
20
 
21
21
  ***
22
22
 
@@ -24,4 +24,4 @@ Defined in: [packages/release-trains/src/git.ts:22](https://gitlab.com/wetryfun/
24
24
 
25
25
  > `readonly` **version**: `string`
26
26
 
27
- Defined in: [packages/release-trains/src/git.ts:23](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/git.ts#L23)
27
+ Defined in: [packages/release-trains/src/git.ts:23](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/git.ts#L23)
@@ -0,0 +1,57 @@
1
+ [**Release trains**](../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../README.md) / @wtf/release-trains/gitlab
6
+
7
+ # @wtf/release-trains/gitlab
8
+
9
+ GitLab, as the release of a tag links the packages of its train: the project of a run
10
+ ([gitlabProjectOf](functions/gitlabProjectOf.md)), the headers a run authenticates by ([gitlabHeadersOf](functions/gitlabHeadersOf.md)), the
11
+ package registry of GitLab a URL names ([gitlabRegistryOf](functions/gitlabRegistryOf.md)), the page of a package such a
12
+ registry holds ([findPackage](functions/findPackage.md)), and a file uploaded to the generic package registry of a
13
+ project ([uploadGeneric](functions/uploadGeneric.md)). It has no network of its own: the caller gives it the `fetch`
14
+ its requests are made by, and the environment it reads.
15
+
16
+ ```ts
17
+ import { findPackage, gitlabRegistryOf, type HttpFetch } from '@wtf/release-trains/gitlab'
18
+
19
+ // The fetch of the caller: the global one of a plugin, a fake of a test.
20
+ declare const fetch: HttpFetch
21
+
22
+ const registry = gitlabRegistryOf('https://gitlab.com/api/v4/projects/7/packages/npm/')
23
+ if (registry !== undefined) {
24
+ // As https://gitlab.com/acme/repo/-/packages/42
25
+ console.log(
26
+ await findPackage({
27
+ fetch,
28
+ registry,
29
+ type: 'npm',
30
+ name: '@acme/core',
31
+ version: '1.2.0',
32
+ headers: {}
33
+ })
34
+ )
35
+ }
36
+ ```
37
+
38
+ ## Interfaces
39
+
40
+ - [GenericUpload](interfaces/GenericUpload.md)
41
+ - [GitLabOptions](interfaces/GitLabOptions.md)
42
+ - [GitLabProject](interfaces/GitLabProject.md)
43
+ - [GitLabRegistry](interfaces/GitLabRegistry.md)
44
+ - [HttpResponse](interfaces/HttpResponse.md)
45
+ - [PackageQuery](interfaces/PackageQuery.md)
46
+
47
+ ## Type Aliases
48
+
49
+ - [HttpFetch](type-aliases/HttpFetch.md)
50
+
51
+ ## Functions
52
+
53
+ - [findPackage](functions/findPackage.md)
54
+ - [gitlabHeadersOf](functions/gitlabHeadersOf.md)
55
+ - [gitlabProjectOf](functions/gitlabProjectOf.md)
56
+ - [gitlabRegistryOf](functions/gitlabRegistryOf.md)
57
+ - [uploadGeneric](functions/uploadGeneric.md)
@@ -0,0 +1,32 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-trains/gitlab](../README.md) / findPackage
6
+
7
+ # Function: findPackage()
8
+
9
+ > **findPackage**(`query`): `Promise`\<`string`\>
10
+
11
+ Defined in: [packages/release-trains/src/gitlab.ts:269](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/gitlab.ts#L269)
12
+
13
+ The page of a package on GitLab at a version, as the Packages API lists it at the registry it
14
+ was published to: `GET /projects/<id>/packages` of a project's, `GET /groups/<id>/packages` of a
15
+ group's, which finds the package in the one project of the group that holds it. The page is its
16
+ `_links.web_path` on GitLab. Throws `EGITLAB` of a request GitLab refuses, and `EGITLABPACKAGE` of
17
+ a registry that lists no package of the name at the version.
18
+
19
+ ## Parameters
20
+
21
+ ### query
22
+
23
+ [`PackageQuery`](../interfaces/PackageQuery.md)
24
+
25
+ The `fetch`, the registry, the type, the name and the version of the package, and
26
+ the headers the request authenticates by.
27
+
28
+ ## Returns
29
+
30
+ `Promise`\<`string`\>
31
+
32
+ The URL of the page of the package.
@@ -0,0 +1,35 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-trains/gitlab](../README.md) / gitlabHeadersOf
6
+
7
+ # Function: gitlabHeadersOf()
8
+
9
+ > **gitlabHeadersOf**(`env`, `useJobToken?`): `Record`\<`string`, `string`\>
10
+
11
+ Defined in: [packages/release-trains/src/gitlab.ts:165](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/gitlab.ts#L165)
12
+
13
+ The headers a run authenticates to GitLab by, as `@semantic-release/gitlab` does: of
14
+ `useJobToken`, the job token, `CI_JOB_TOKEN`, as `JOB-TOKEN`; else a token, `GL_TOKEN` or
15
+ `GITLAB_TOKEN`, as `PRIVATE-TOKEN`; else the job token of a pipeline; none of no token.
16
+
17
+ ## Parameters
18
+
19
+ ### env
20
+
21
+ `Env`
22
+
23
+ The environment of the run.
24
+
25
+ ### useJobToken?
26
+
27
+ `boolean` = `false`
28
+
29
+ Whether the run authenticates by the job token alone.
30
+
31
+ ## Returns
32
+
33
+ `Record`\<`string`, `string`\>
34
+
35
+ The header of the token, or none.
@@ -0,0 +1,43 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-trains/gitlab](../README.md) / gitlabProjectOf
6
+
7
+ # Function: gitlabProjectOf()
8
+
9
+ > **gitlabProjectOf**(`options`, `env`, `repositoryUrl`): [`GitLabProject`](../interfaces/GitLabProject.md)
10
+
11
+ Defined in: [packages/release-trains/src/gitlab.ts:129](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/gitlab.ts#L129)
12
+
13
+ The project of a run on GitLab, as `@semantic-release/gitlab` finds it: GitLab at `gitlabUrl`,
14
+ else `GL_URL` or `GITLAB_URL`, else the server of a pipeline, `CI_SERVER_URL`, else
15
+ `https://gitlab.com`; its API at `gitlabApiPathPrefix`, `GL_PREFIX` or `GITLAB_PREFIX` of that
16
+ URL, else `CI_API_V4_URL` of a pipeline, else `/api/v4`; and the project of the pipeline,
17
+ `CI_PROJECT_ID` and `CI_PROJECT_PATH`, else of the path of `repositoryUrl`.
18
+
19
+ ## Parameters
20
+
21
+ ### options
22
+
23
+ [`GitLabOptions`](../interfaces/GitLabOptions.md)
24
+
25
+ The options of `@semantic-release/gitlab` that say where GitLab is.
26
+
27
+ ### env
28
+
29
+ `Env`
30
+
31
+ The environment of the run.
32
+
33
+ ### repositoryUrl
34
+
35
+ `string` \| `undefined`
36
+
37
+ The URL of the repository of the run, as semantic-release gives it.
38
+
39
+ ## Returns
40
+
41
+ [`GitLabProject`](../interfaces/GitLabProject.md)
42
+
43
+ The project.
@@ -0,0 +1,29 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-trains/gitlab](../README.md) / gitlabRegistryOf
6
+
7
+ # Function: gitlabRegistryOf()
8
+
9
+ > **gitlabRegistryOf**(`url`): [`GitLabRegistry`](../interfaces/GitLabRegistry.md) \| `undefined`
10
+
11
+ Defined in: [packages/release-trains/src/gitlab.ts:196](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/gitlab.ts#L196)
12
+
13
+ The package registry of GitLab that `url` names, as a registry of npm or of Maven writes it:
14
+ `https://gitlab.com/api/v4/projects/7/packages/npm/` of a project, or
15
+ `https://gitlab.com/api/v4/groups/3/-/packages/npm/` of a group; `undefined` of any other URL.
16
+
17
+ ## Parameters
18
+
19
+ ### url
20
+
21
+ `string`
22
+
23
+ The URL of the registry.
24
+
25
+ ## Returns
26
+
27
+ [`GitLabRegistry`](../interfaces/GitLabRegistry.md) \| `undefined`
28
+
29
+ The registry, or `undefined`.
@@ -0,0 +1,30 @@
1
+ [**Release trains**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [Release trains](../../../../README.md) / [@wtf/release-trains/gitlab](../README.md) / uploadGeneric
6
+
7
+ # Function: uploadGeneric()
8
+
9
+ > **uploadGeneric**(`upload`): `Promise`\<`string`\>
10
+
11
+ Defined in: [packages/release-trains/src/gitlab.ts:334](https://gitlab.com/wetryfun/release/release/-/blob/5d1edd319c34b1eef0b1f4677a780a58c6e3cd15/packages/release-trains/src/gitlab.ts#L334)
12
+
13
+ Uploads a file to the generic package registry of a project, by
14
+ `PUT /projects/<id>/packages/generic/<package>/<version>/<file>`, and gives the URL it is
15
+ downloaded from. Throws `EGITLAB` of a request GitLab refuses.
16
+
17
+ ## Parameters
18
+
19
+ ### upload
20
+
21
+ [`GenericUpload`](../interfaces/GenericUpload.md)
22
+
23
+ The `fetch`, the project, the package, its version, the file and its content, and
24
+ the headers the request authenticates by.
25
+
26
+ ## Returns
27
+
28
+ `Promise`\<`string`\>
29
+
30
+ The URL of the file in the registry.