@wtf/release-docs 8.2.3 → 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.
- package/api/.generated +29 -0
- package/api/@wtf/release-cargo/auth/functions/mask.md +1 -1
- package/api/@wtf/release-cargo/auth/functions/tokenVariableOf.md +1 -1
- package/api/@wtf/release-cargo/auth/functions/trustedPublishing.md +1 -1
- package/api/@wtf/release-cargo/auth/interfaces/HttpResponse.md +5 -5
- package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishing.md +5 -5
- package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishingOptions.md +6 -6
- package/api/@wtf/release-cargo/auth/type-aliases/HttpFetch.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/CRATES_IO_API.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/ID_TOKEN_VARIABLE.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/USER_AGENT.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/publishOrder.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/publishable.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/readWorkspace.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/selectCrates.md +1 -1
- package/api/@wtf/release-cargo/crates/interfaces/Selection.md +5 -5
- package/api/@wtf/release-cargo/ecosystem/functions/packagesAt.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/packagesOfTree.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/packagesOfWorkspace.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/resolveRequirement.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/satisfiesRequirement.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/semverRange.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/interfaces/CargoPackage.md +7 -7
- package/api/@wtf/release-cargo/ecosystem/variables/cargoEcosystem.md +1 -1
- package/api/@wtf/release-cargo/errors/classes/CargoError.md +5 -5
- package/api/@wtf/release-cargo/errors/type-aliases/CargoErrorCode.md +1 -1
- package/api/@wtf/release-cargo/errors/variables/CARGO_ERRORS.md +1 -1
- package/api/@wtf/release-cargo/interfaces/Crate.md +6 -6
- package/api/@wtf/release-cargo/interfaces/CrateDependency.md +6 -6
- package/api/@wtf/release-cargo/interfaces/Workspace.md +3 -3
- package/api/@wtf/release-cargo/publish/functions/publishCrates.md +1 -1
- package/api/@wtf/release-cargo/publish/interfaces/PublishCratesOptions.md +11 -11
- package/api/@wtf/release-cargo/publish/interfaces/PublishedCrate.md +5 -5
- package/api/@wtf/release-cargo/publish/type-aliases/CrateStatus.md +1 -1
- package/api/@wtf/release-cargo/publish/variables/RECHECK_WAITS.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/crateUrl.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/indexHasVersion.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/indexPath.md +1 -1
- package/api/@wtf/release-cargo/registry/variables/CRATES_IO_INDEX.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/inheritsVersion.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/stampManifest.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/stampWorkspace.md +1 -1
- package/api/@wtf/release-cargo/stamp/interfaces/StampOptions.md +4 -4
- package/api/@wtf/release-cargo/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-cargo/stamp/interfaces/StampedWorkspace.md +3 -3
- package/api/@wtf/release-cargo/type-aliases/DependencyKind.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/packagesOfModules.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/packagesOfRepo.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/resolveVersion.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/satisfiesVersion.md +1 -1
- package/api/@wtf/release-go/ecosystem/interfaces/GoPackage.md +7 -7
- package/api/@wtf/release-go/ecosystem/variables/goEcosystem.md +1 -1
- package/api/@wtf/release-go/errors/classes/GoError.md +5 -5
- package/api/@wtf/release-go/errors/type-aliases/GoErrorCode.md +1 -1
- package/api/@wtf/release-go/errors/variables/GO_ERRORS.md +1 -1
- package/api/@wtf/release-go/gomod/functions/entriesOf.md +1 -1
- package/api/@wtf/release-go/gomod/functions/linesOf.md +1 -1
- package/api/@wtf/release-go/gomod/functions/readGoMod.md +1 -1
- package/api/@wtf/release-go/gomod/functions/tokensOf.md +1 -1
- package/api/@wtf/release-go/gomod/interfaces/Entry.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/GoMod.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/GoReplace.md +6 -6
- package/api/@wtf/release-go/gomod/interfaces/GoRequire.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/Token.md +5 -5
- package/api/@wtf/release-go/interfaces/GoModule.md +6 -6
- package/api/@wtf/release-go/modules/functions/isFetchable.md +1 -1
- package/api/@wtf/release-go/modules/functions/isGoMod.md +1 -1
- package/api/@wtf/release-go/modules/functions/majorErrors.md +1 -1
- package/api/@wtf/release-go/modules/functions/majorOfPath.md +1 -1
- package/api/@wtf/release-go/modules/functions/modulesAt.md +1 -1
- package/api/@wtf/release-go/modules/functions/modulesOf.md +1 -1
- package/api/@wtf/release-go/modules/functions/readModules.md +1 -1
- package/api/@wtf/release-go/modules/functions/selectModules.md +1 -1
- package/api/@wtf/release-go/modules/interfaces/Selection.md +4 -4
- package/api/@wtf/release-go/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-go/stamp/functions/stampGoMod.md +1 -1
- package/api/@wtf/release-go/stamp/functions/stampModules.md +1 -1
- package/api/@wtf/release-go/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-go/stamp/interfaces/StampedModules.md +3 -3
- package/api/@wtf/release-go/tags/functions/askProxy.md +1 -1
- package/api/@wtf/release-go/tags/functions/maskCredentials.md +1 -1
- package/api/@wtf/release-go/tags/functions/releaseCommit.md +1 -1
- package/api/@wtf/release-go/tags/functions/remoteTags.md +1 -1
- package/api/@wtf/release-go/tags/functions/tagModules.md +1 -1
- package/api/@wtf/release-go/tags/functions/tagOfModule.md +1 -1
- package/api/@wtf/release-go/tags/functions/tagPrefix.md +1 -1
- package/api/@wtf/release-go/tags/interfaces/TagModulesOptions.md +8 -8
- package/api/@wtf/release-go/tags/interfaces/TaggedModule.md +5 -5
- package/api/@wtf/release-go/tags/type-aliases/ModuleStatus.md +1 -1
- package/api/@wtf/release-go/tags/variables/RELEASE_AUTHOR.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/groupIdOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/installsOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/isPomFile.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/isRange.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/modulesOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/nameOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/publishOrder.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/readModules.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/readPoms.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/selectArtifacts.md +1 -1
- package/api/@wtf/release-maven/artifacts/interfaces/Selection.md +4 -4
- package/api/@wtf/release-maven/ecosystem/functions/compareVersions.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/parseRange.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/resolveVersion.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/satisfiesVersion.md +1 -1
- package/api/@wtf/release-maven/ecosystem/interfaces/Bound.md +3 -3
- package/api/@wtf/release-maven/ecosystem/interfaces/Restriction.md +3 -3
- package/api/@wtf/release-maven/ecosystem/variables/mavenEcosystem.md +1 -1
- package/api/@wtf/release-maven/errors/classes/MavenError.md +5 -5
- package/api/@wtf/release-maven/errors/type-aliases/MavenErrorCode.md +1 -1
- package/api/@wtf/release-maven/errors/variables/MAVEN_ERRORS.md +1 -1
- package/api/@wtf/release-maven/interfaces/MavenModule.md +14 -14
- package/api/@wtf/release-maven/pom/functions/childOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/childrenOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/dependencyOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/escapeXml.md +1 -1
- package/api/@wtf/release-maven/pom/functions/parseXml.md +1 -1
- package/api/@wtf/release-maven/pom/functions/readPom.md +1 -1
- package/api/@wtf/release-maven/pom/functions/textAt.md +1 -1
- package/api/@wtf/release-maven/pom/interfaces/Pom.md +15 -15
- package/api/@wtf/release-maven/pom/interfaces/PomDependency.md +5 -5
- package/api/@wtf/release-maven/pom/interfaces/PomParent.md +4 -4
- package/api/@wtf/release-maven/pom/interfaces/PomPlugin.md +5 -5
- package/api/@wtf/release-maven/pom/interfaces/PomRepository.md +3 -3
- package/api/@wtf/release-maven/pom/interfaces/Span.md +3 -3
- package/api/@wtf/release-maven/pom/interfaces/XmlElement.md +7 -7
- package/api/@wtf/release-maven/pom/variables/PLUGIN_GROUP.md +1 -1
- package/api/@wtf/release-maven/publish/functions/deployModules.md +1 -1
- package/api/@wtf/release-maven/publish/interfaces/DeployModulesOptions.md +11 -11
- package/api/@wtf/release-maven/publish/interfaces/DeployedModule.md +4 -4
- package/api/@wtf/release-maven/publish/type-aliases/ModuleStatus.md +1 -1
- package/api/@wtf/release-maven/repository/functions/deployTargets.md +1 -1
- package/api/@wtf/release-maven/repository/functions/expandValues.md +1 -1
- package/api/@wtf/release-maven/repository/functions/hasPom.md +1 -1
- package/api/@wtf/release-maven/repository/functions/pomPath.md +1 -1
- package/api/@wtf/release-maven/repository/functions/pomUrl.md +1 -1
- package/api/@wtf/release-maven/repository/interfaces/Repository.md +3 -3
- package/api/@wtf/release-maven/repository/interfaces/ValuesOf.md +3 -3
- package/api/@wtf/release-maven/repository/variables/MAVEN_CENTRAL.md +1 -1
- package/api/@wtf/release-maven/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-maven/stamp/functions/stampModules.md +1 -1
- package/api/@wtf/release-maven/stamp/functions/stampPom.md +1 -1
- package/api/@wtf/release-maven/stamp/interfaces/PomStampOptions.md +5 -5
- package/api/@wtf/release-maven/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-maven/stamp/interfaces/StampedModules.md +3 -3
- package/api/@wtf/release-npm/check/functions/checkPackages.md +1 -1
- package/api/@wtf/release-npm/check/functions/formatIssue.md +1 -1
- package/api/@wtf/release-npm/check/interfaces/CheckOptions.md +6 -6
- package/api/@wtf/release-npm/check/interfaces/Issue.md +5 -5
- package/api/@wtf/release-npm/check/type-aliases/CheckedPackage.md +1 -1
- package/api/@wtf/release-npm/check/type-aliases/IssueCode.md +1 -1
- package/api/@wtf/release-npm/ecosystem/variables/npmEcosystem.md +1 -1
- package/api/@wtf/release-npm/errors/type-aliases/NpmErrorCode.md +1 -1
- package/api/@wtf/release-npm/errors/variables/NPM_ERRORS.md +1 -1
- package/api/@wtf/release-npm/interfaces/Lookup.md +3 -3
- package/api/@wtf/release-npm/interfaces/PublishOptions.md +6 -6
- package/api/@wtf/release-npm/interfaces/PublishPackage.md +5 -5
- package/api/@wtf/release-npm/interfaces/PublishTrainOptions.md +16 -16
- package/api/@wtf/release-npm/interfaces/Publisher.md +7 -7
- package/api/@wtf/release-npm/interfaces/PublisherContext.md +7 -7
- package/api/@wtf/release-npm/manifests/functions/concreteRange.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/manifestsAt.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/packageOf.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/packagesOfManifests.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/readManifests.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/resolveSpecifier.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/runtimeDependenciesOf.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/satisfiesRange.md +1 -1
- package/api/@wtf/release-npm/manifests/interfaces/Manifest.md +5 -5
- package/api/@wtf/release-npm/manifests/interfaces/NpmPackage.md +7 -7
- package/api/@wtf/release-npm/manifests/type-aliases/DependencyField.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/DEPENDENCY_FIELDS.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/FIELD_KINDS.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/RUNTIME_FIELDS.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/isTypeScriptSource.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/prepareManifest.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/stripSourceConditions.md +1 -1
- package/api/@wtf/release-npm/prepare/interfaces/PrepareOptions.md +5 -5
- package/api/@wtf/release-npm/prepare/interfaces/PreparedManifest.md +6 -6
- package/api/@wtf/release-npm/prepare/variables/SOURCE_CONDITIONS.md +1 -1
- package/api/@wtf/release-npm/publishers/README.md +1 -0
- package/api/@wtf/release-npm/publishers/functions/builtInPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/functions/isPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/functions/registryOf.md +34 -0
- package/api/@wtf/release-npm/publishers/variables/NPM_REGISTRY.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/PUBLISHERS.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/npmPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/pnpmPublisher.md +1 -1
- package/api/@wtf/release-npm/release/functions/checkTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/distTagOf.md +1 -1
- package/api/@wtf/release-npm/release/functions/packTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishPacked.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishedOf.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishedOfResolved.md +1 -1
- package/api/@wtf/release-npm/release/functions/releaseTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/resolveManifests.md +1 -1
- package/api/@wtf/release-npm/release/functions/tagTrain.md +1 -1
- package/api/@wtf/release-npm/release/interfaces/CheckRelease.md +19 -19
- package/api/@wtf/release-npm/release/interfaces/PackOptions.md +8 -8
- package/api/@wtf/release-npm/release/interfaces/PackedTrain.md +13 -13
- package/api/@wtf/release-npm/release/interfaces/PublishRun.md +11 -11
- package/api/@wtf/release-npm/release/interfaces/PublishedOf.md +4 -4
- package/api/@wtf/release-npm/release/interfaces/PublishedPackage.md +18 -7
- package/api/@wtf/release-npm/release/interfaces/PublishedTrain.md +5 -5
- package/api/@wtf/release-npm/release/interfaces/ResolveRelease.md +18 -18
- package/api/@wtf/release-npm/release/interfaces/ResolvedPackage.md +4 -4
- package/api/@wtf/release-npm/release/interfaces/ResolvedTrain.md +6 -6
- package/api/@wtf/release-npm/release/interfaces/TagRelease.md +14 -14
- package/api/@wtf/release-npm/release/type-aliases/LookedUpTrain.md +1 -1
- package/api/@wtf/release-npm/release/type-aliases/ReleaseRun.md +1 -1
- package/api/@wtf/release-npm/release/variables/ID_TOKENS.md +1 -1
- package/api/@wtf/release-npm/release/variables/RUNNER_ENVIRONMENTS.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/pnpmWorkspaceGlobs.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/publishableOf.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/readWorkspace.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/workspaceFolders.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/workspaceGlobs.md +1 -1
- package/api/@wtf/release-npm/workspace/interfaces/WorkspaceGlobs.md +3 -3
- package/api/@wtf/release-npm/workspace/interfaces/WorkspaceOptions.md +2 -2
- package/api/@wtf/release-replace/errors/classes/ReplaceError.md +5 -5
- package/api/@wtf/release-replace/errors/type-aliases/ReplaceErrorCode.md +1 -1
- package/api/@wtf/release-replace/errors/variables/REPLACE_ERRORS.md +1 -1
- package/api/@wtf/release-replace/files/functions/filesMatcher.md +1 -1
- package/api/@wtf/release-replace/interfaces/ReplaceMatch.md +5 -5
- package/api/@wtf/release-replace/interfaces/ReplacementOf.md +5 -5
- package/api/@wtf/release-replace/replace/functions/regExpOf.md +1 -1
- package/api/@wtf/release-replace/replace/functions/replaceFiles.md +1 -1
- package/api/@wtf/release-replace/replace/functions/replaceText.md +1 -1
- package/api/@wtf/release-replace/replace/interfaces/ReplaceOptions.md +10 -10
- package/api/@wtf/release-replace/replace/interfaces/TextOptions.md +5 -5
- package/api/@wtf/release-replace/replace/type-aliases/To.md +1 -1
- package/api/@wtf/release-replace/templates/functions/mergeTemplates.md +1 -1
- package/api/@wtf/release-replace/templates/functions/resolveReplacement.md +1 -1
- package/api/@wtf/release-replace/templates/functions/resolveReplacements.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Escape.md +1 -1
- package/api/@wtf/release-replace/type-aliases/ReplaceFunction.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Replacement.md +1 -1
- package/api/@wtf/release-replace/type-aliases/ReplacementSpec.md +1 -1
- package/api/@wtf/release-replace/type-aliases/TemplateUse.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Templates.md +1 -1
- package/api/@wtf/release-replace/values/functions/escapeValue.md +1 -1
- package/api/@wtf/release-replace/values/functions/textOf.md +1 -1
- package/api/@wtf/release-replace/values/functions/valueAt.md +1 -1
- package/api/@wtf/release-replace/values/variables/ESCAPES.md +1 -1
- package/api/@wtf/release-replace/values/variables/VALUE.md +1 -1
- package/api/@wtf/release-system/errors/classes/ReleaseError.md +5 -5
- package/api/@wtf/release-system/errors/functions/throwAll.md +1 -1
- package/api/@wtf/release-system/errors/type-aliases/ErrorClass.md +1 -1
- package/api/@wtf/release-system/errors/type-aliases/SystemErrorCode.md +1 -1
- package/api/@wtf/release-system/errors/variables/SYSTEM_ERRORS.md +1 -1
- package/api/@wtf/release-system/git/functions/commitsSince.md +1 -1
- package/api/@wtf/release-system/git/functions/filesOfCommits.md +1 -1
- package/api/@wtf/release-system/git/functions/git.md +1 -1
- package/api/@wtf/release-system/git/functions/gitOf.md +1 -1
- package/api/@wtf/release-system/git/functions/trackedFiles.md +1 -1
- package/api/@wtf/release-system/git/interfaces/GitContext.md +4 -4
- package/api/@wtf/release-system/git/interfaces/LogCommit.md +5 -5
- package/api/@wtf/release-system/node/functions/nodeSystem.md +1 -1
- package/api/@wtf/release-system/node/functions/realPathOf.md +1 -1
- package/api/@wtf/release-system/node/functions/systemOf.md +1 -1
- package/api/@wtf/release-system/paths/functions/normalizePath.md +1 -1
- package/api/@wtf/release-system/paths/functions/pathMatcher.md +1 -1
- package/api/@wtf/release-system/paths/type-aliases/PathMatcher.md +1 -1
- package/api/@wtf/release-system/posix/functions/basenameOf.md +1 -1
- package/api/@wtf/release-system/posix/functions/dirnameOf.md +1 -1
- package/api/@wtf/release-system/posix/functions/joinPath.md +1 -1
- package/api/@wtf/release-system/posix/functions/relativePath.md +1 -1
- package/api/@wtf/release-system/posix/functions/resolvePath.md +1 -1
- package/api/@wtf/release-system/system/interfaces/DirEntry.md +3 -3
- package/api/@wtf/release-system/system/interfaces/ExecOptions.md +4 -4
- package/api/@wtf/release-system/system/interfaces/ExecResult.md +4 -4
- package/api/@wtf/release-system/system/interfaces/System.md +7 -7
- package/api/@wtf/release-system/system/interfaces/SystemFs.md +8 -8
- package/api/@wtf/release-system/system/type-aliases/Exec.md +1 -1
- package/api/@wtf/release-system/system/type-aliases/SystemInput.md +1 -1
- package/api/@wtf/release-system/validator/functions/allOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/anyObject.md +1 -1
- package/api/@wtf/release-system/validator/functions/anyOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/arrayOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/booleanOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/errorOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/errorsOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/exclusive.md +1 -1
- package/api/@wtf/release-system/validator/functions/issuesOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/objectOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/oneOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/orFunction.md +1 -1
- package/api/@wtf/release-system/validator/functions/pathText.md +1 -1
- package/api/@wtf/release-system/validator/functions/pluginEntriesOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/recordOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/refined.md +1 -1
- package/api/@wtf/release-system/validator/functions/stringOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/tupleOf.md +1 -1
- package/api/@wtf/release-system/validator/interfaces/ArrayOptions.md +5 -5
- package/api/@wtf/release-system/validator/interfaces/IssueOptions.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/ObjectOptions.md +5 -5
- package/api/@wtf/release-system/validator/interfaces/OptionIssue.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/Property.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/RecordOptions.md +6 -6
- package/api/@wtf/release-system/validator/interfaces/StringOptions.md +6 -6
- package/api/@wtf/release-system/validator/interfaces/Validator.md +4 -4
- package/api/@wtf/release-system/validator/type-aliases/JsonSchema.md +1 -1
- package/api/@wtf/release-system/validator/type-aliases/Path.md +1 -1
- package/api/@wtf/release-trains/README.md +4 -0
- package/api/@wtf/release-trains/cascade/functions/cascadeNotes.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadeText.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadeType.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadesOf.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/higherType.md +1 -1
- package/api/@wtf/release-trains/cascade/interfaces/Cascade.md +11 -11
- package/api/@wtf/release-trains/cascade/interfaces/CascadeCheck.md +8 -8
- package/api/@wtf/release-trains/cascade/type-aliases/CascadeKind.md +1 -1
- package/api/@wtf/release-trains/cascade/type-aliases/ReleaseType.md +1 -1
- package/api/@wtf/release-trains/cascade/variables/RELEASE_TYPES.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/isEcosystem.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/loadEcosystems.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/readPackages.md +1 -1
- package/api/@wtf/release-trains/ecosystem/interfaces/Dependency.md +4 -4
- package/api/@wtf/release-trains/ecosystem/interfaces/Ecosystem.md +5 -5
- package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemContext.md +5 -5
- package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemPackages.md +3 -3
- package/api/@wtf/release-trains/ecosystem/interfaces/Package.md +6 -6
- package/api/@wtf/release-trains/ecosystem/type-aliases/DependencyKind.md +1 -1
- package/api/@wtf/release-trains/ecosystem/type-aliases/ModuleLoader.md +1 -1
- package/api/@wtf/release-trains/ecosystem/variables/DEPENDENCY_KINDS.md +1 -1
- package/api/@wtf/release-trains/errors/classes/TrainsError.md +5 -5
- package/api/@wtf/release-trains/errors/type-aliases/TrainsErrorCode.md +1 -1
- package/api/@wtf/release-trains/errors/variables/TRAINS_ERRORS.md +13 -1
- package/api/@wtf/release-trains/generated/functions/filesIn.md +1 -1
- package/api/@wtf/release-trains/generated/functions/formatGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/listGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/parseGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/readGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/stageGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/stageGeneratedFolders.md +1 -1
- package/api/@wtf/release-trains/generated/functions/unlistedIn.md +1 -1
- package/api/@wtf/release-trains/generated/interfaces/GeneratedOptions.md +2 -2
- package/api/@wtf/release-trains/generated/interfaces/StageOptions.md +6 -6
- package/api/@wtf/release-trains/generated/variables/GENERATED.md +1 -1
- package/api/@wtf/release-trains/git/functions/tagOf.md +1 -1
- package/api/@wtf/release-trains/git/functions/tagsOf.md +1 -1
- package/api/@wtf/release-trains/git/functions/versionOfTag.md +1 -1
- package/api/@wtf/release-trains/git/interfaces/TrainTag.md +3 -3
- package/api/@wtf/release-trains/gitlab/README.md +57 -0
- package/api/@wtf/release-trains/gitlab/functions/findPackage.md +32 -0
- package/api/@wtf/release-trains/gitlab/functions/gitlabHeadersOf.md +35 -0
- package/api/@wtf/release-trains/gitlab/functions/gitlabProjectOf.md +43 -0
- package/api/@wtf/release-trains/gitlab/functions/gitlabRegistryOf.md +29 -0
- package/api/@wtf/release-trains/gitlab/functions/uploadGeneric.md +30 -0
- package/api/@wtf/release-trains/gitlab/interfaces/GenericUpload.md +81 -0
- package/api/@wtf/release-trains/gitlab/interfaces/GitLabOptions.md +42 -0
- package/api/@wtf/release-trains/gitlab/interfaces/GitLabProject.md +61 -0
- package/api/@wtf/release-trains/gitlab/interfaces/GitLabRegistry.md +51 -0
- package/api/@wtf/release-trains/gitlab/interfaces/HttpResponse.md +47 -0
- package/api/@wtf/release-trains/gitlab/interfaces/PackageQuery.md +72 -0
- package/api/@wtf/release-trains/gitlab/type-aliases/HttpFetch.md +43 -0
- package/api/@wtf/release-trains/interfaces/Train.md +7 -7
- package/api/@wtf/release-trains/links/README.md +54 -0
- package/api/@wtf/release-trains/links/functions/forgetReleased.md +25 -0
- package/api/@wtf/release-trains/links/functions/recordReleased.md +39 -0
- package/api/@wtf/release-trains/links/functions/releaseLinks.md +41 -0
- package/api/@wtf/release-trains/links/functions/releasedOf.md +28 -0
- package/api/@wtf/release-trains/links/interfaces/LinkOptions.md +127 -0
- package/api/@wtf/release-trains/links/interfaces/PackageRegistry.md +41 -0
- package/api/@wtf/release-trains/links/interfaces/ReleaseLink.md +41 -0
- package/api/@wtf/release-trains/links/interfaces/ReleaseRun.md +41 -0
- package/api/@wtf/release-trains/links/interfaces/ReleasedPackage.md +92 -0
- package/api/@wtf/release-trains/packages/functions/dependencyEdges.md +1 -1
- package/api/@wtf/release-trains/packages/functions/dependencyText.md +1 -1
- package/api/@wtf/release-trains/packages/functions/dependsOnErrors.md +1 -1
- package/api/@wtf/release-trains/packages/functions/normalizeDir.md +1 -1
- package/api/@wtf/release-trains/packages/functions/ownersOf.md +1 -1
- package/api/@wtf/release-trains/packages/functions/packagesOf.md +1 -1
- package/api/@wtf/release-trains/packages/functions/publishOrder.md +1 -1
- package/api/@wtf/release-trains/packages/functions/releasedVersions.md +1 -1
- package/api/@wtf/release-trains/packages/functions/trainDependencies.md +1 -1
- package/api/@wtf/release-trains/packages/functions/trainOrder.md +1 -1
- package/api/@wtf/release-trains/packages/functions/unsatisfiedErrors.md +1 -1
- package/api/@wtf/release-trains/packages/interfaces/DependencyEdge.md +6 -6
- package/api/@wtf/release-trains/packages/interfaces/OrderFault.md +4 -4
- package/api/@wtf/release-trains/packages/interfaces/OrderPins.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/PublishOrder.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/TrainDependency.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/VersionsRelease.md +7 -7
- package/api/@wtf/release-trains/paths/functions/filterCommits.md +1 -1
- package/api/@wtf/release-trains/paths/functions/gitFilesOf.md +1 -1
- package/api/@wtf/release-trains/paths/functions/overlapError.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainOfPath.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainsOfCommit.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainsOfPath.md +1 -1
- package/api/@wtf/release-trains/paths/type-aliases/FilesOf.md +1 -1
- package/api/@wtf/release-trains/schema/interfaces/ConfigPart.md +6 -6
- package/api/@wtf/release-trains/schema/interfaces/RootOptions.md +7 -7
- package/api/@wtf/release-trains/schema/type-aliases/DependencyRule.md +1 -1
- package/api/@wtf/release-trains/schema/variables/DEPENDENCY_RULES.md +1 -1
- package/api/@wtf/release-trains/schema/variables/TAG_FORMAT_PATTERN.md +1 -1
- package/api/@wtf/release-trains/schema/variables/TRAIN_NAME_PATTERN.md +1 -1
- package/api/@wtf/release-trains/schema/variables/configSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/rootOptionsSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/trainSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/trainsSchema.md +1 -1
- package/api/@wtf/release-trains/trains/functions/changelogOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/matchersOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/overlapErrors.md +1 -1
- package/api/@wtf/release-trains/trains/functions/selectTrain.md +1 -1
- package/api/@wtf/release-trains/trains/functions/tagFormatOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainHeadedNotes.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainOfRun.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainOfTag.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainsErrors.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainsOfOptions.md +1 -1
- package/api/@wtf/release-trains/trains/variables/TRAIN_VARIABLE.md +1 -1
- package/api/@wtf/release-trains/trains/variables/VERSION.md +1 -1
- package/api/@wtf/release-trains/type-aliases/BranchSpec.md +1 -1
- package/api/@wtf/release-trains/type-aliases/Trains.md +1 -1
- package/api/@wtf/release-trains/verify/functions/unreleasedDependencies.md +1 -1
- package/api/@wtf/release-trains/verify/functions/verifyTrain.md +1 -1
- package/api/@wtf/release-trains/verify/interfaces/UnreleasedDependencies.md +10 -10
- package/api/@wtf/release-trains/verify/interfaces/VerifiedTrain.md +5 -5
- package/api/@wtf/release-trains/verify/interfaces/VerifyRelease.md +8 -8
- package/api/@wtf/release-validate/errors/classes/ValidateError.md +5 -5
- package/api/@wtf/release-validate/errors/type-aliases/ValidateErrorCode.md +1 -1
- package/api/@wtf/release-validate/errors/variables/VALIDATE_ERRORS.md +1 -1
- package/api/@wtf/release-validate/interfaces/ConfigIssue.md +4 -4
- package/api/@wtf/release-validate/json-schema/functions/fromJsonSchema.md +1 -1
- package/api/@wtf/release-validate/json-schema/functions/pathOfPointer.md +1 -1
- package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaError.md +3 -3
- package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaValidator.md +3 -3
- package/api/@wtf/release-validate/validate/functions/configErrors.md +1 -1
- package/api/@wtf/release-validate/validate/functions/isStandardSchema.md +1 -1
- package/api/@wtf/release-validate/validate/functions/pathText.md +1 -1
- package/api/@wtf/release-validate/validate/functions/validateConfig.md +1 -1
- package/api/@wtf/semantic-release-cargo/README.md +3 -1
- package/api/@wtf/semantic-release-cargo/functions/indexLookup.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-cargo/interfaces/CargoPluginOptions.md +12 -12
- package/api/@wtf/semantic-release-cargo/interfaces/CargoRelease.md +3 -3
- package/api/@wtf/semantic-release-cargo/schema/type-aliases/CargoOptions.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/cargoOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/cargoSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/variables/default.md +1 -1
- package/api/@wtf/semantic-release-go/README.md +3 -1
- package/api/@wtf/semantic-release-go/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-go/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-go/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-go/functions/verifyRelease.md +1 -1
- package/api/@wtf/semantic-release-go/interfaces/GoPluginOptions.md +8 -8
- package/api/@wtf/semantic-release-go/interfaces/GoRelease.md +3 -3
- package/api/@wtf/semantic-release-go/schema/type-aliases/GoOptions.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/goOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/goSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-go/variables/default.md +1 -1
- package/api/@wtf/semantic-release-maven/README.md +3 -1
- package/api/@wtf/semantic-release-maven/functions/pomLookup.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-maven/interfaces/LookupAuth.md +3 -3
- package/api/@wtf/semantic-release-maven/interfaces/MavenPluginOptions.md +12 -12
- package/api/@wtf/semantic-release-maven/interfaces/MavenRelease.md +2 -2
- package/api/@wtf/semantic-release-maven/schema/type-aliases/MavenOptions.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/mavenOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/mavenSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/variables/default.md +1 -1
- package/api/@wtf/semantic-release-npm/README.md +4 -1
- package/api/@wtf/semantic-release-npm/functions/addChannel.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/fail.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/loadPublisher.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-npm/interfaces/PublishPluginOptions.md +21 -21
- package/api/@wtf/semantic-release-npm/interfaces/PublishedRelease.md +4 -4
- package/api/@wtf/semantic-release-npm/interfaces/SmokeOption.md +2 -2
- package/api/@wtf/semantic-release-npm/schema/type-aliases/PublishOptions.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/publishOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/publishSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/type-aliases/PublisherSpec.md +1 -1
- package/api/@wtf/semantic-release-npm/variables/default.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/functionOf.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/templatesOf.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-replace/interfaces/ReplacePluginOptions.md +5 -5
- package/api/@wtf/semantic-release-replace/schema/interfaces/ModuleExport.md +3 -3
- package/api/@wtf/semantic-release-replace/schema/interfaces/ReplaceOptions.md +4 -4
- package/api/@wtf/semantic-release-replace/schema/interfaces/RootTemplates.md +2 -2
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacement.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacementSpec.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTemplates.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTo.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplateSet.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplatesOption.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/exportedSetSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/replaceOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/replacementSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/rootTemplatesSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/templateSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/templatesSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/variables/default.md +1 -1
- package/api/@wtf/semantic-release-trains/README.md +2 -1
- package/api/@wtf/semantic-release-trains/config/functions/skipPlugins.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/stepId.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainAssets.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainChangelog.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainOfTag.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainTagFormat.md +1 -1
- package/api/@wtf/semantic-release-trains/config/interfaces/AssetsOptions.md +4 -4
- package/api/@wtf/semantic-release-trains/config/interfaces/SkipOptions.md +3 -3
- package/api/@wtf/semantic-release-trains/config/variables/BRANCHES.md +1 -1
- package/api/@wtf/semantic-release-trains/config/variables/BREAKING.md +1 -1
- package/api/@wtf/semantic-release-trains/config/variables/TITLE.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/README.md +16 -6
- package/api/@wtf/semantic-release-trains/defaults/functions/skipRuleOf.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/skips.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/stepOptionsOf.md +35 -0
- package/api/@wtf/semantic-release-trains/defaults/functions/trainOptionsOf.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/interfaces/SkipContext.md +5 -5
- package/api/@wtf/semantic-release-trains/defaults/interfaces/StepOptionsContext.md +61 -0
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/SkipCheck.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/StepOptions.md +28 -0
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/TrainOptions.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/SKIP_RULES.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_OPTIONS.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_SKIP.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_STEP_OPTIONS.md +16 -0
- package/api/@wtf/semantic-release-trains/defaults/variables/releaseAssets.md +31 -0
- package/api/@wtf/semantic-release-trains/errors/type-aliases/PluginErrorCode.md +1 -1
- package/api/@wtf/semantic-release-trains/errors/variables/PLUGIN_ERRORS.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/decideTrain.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/dotenvOf.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/infoOf.md +1 -1
- package/api/@wtf/semantic-release-trains/info/interfaces/DecideRun.md +4 -4
- package/api/@wtf/semantic-release-trains/info/interfaces/InfoRun.md +8 -8
- package/api/@wtf/semantic-release-trains/info/interfaces/TrainDecision.md +5 -5
- package/api/@wtf/semantic-release-trains/info/interfaces/TrainInfo.md +5 -5
- package/api/@wtf/semantic-release-trains/interfaces/TrainsEntryOptions.md +5 -5
- package/api/@wtf/semantic-release-trains/interfaces/TrainsOptions.md +7 -7
- package/api/@wtf/semantic-release-trains/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/pluginSpecSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/skipRuleSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/trainsEntrySchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/trainsPluginSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/type-aliases/PluginSpec.md +1 -1
- package/api/@wtf/semantic-release-trains/type-aliases/TrainsPluginOptions.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/addChannel.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/analyzeCommits.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/default.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/fail.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/generateNotes.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/prepare.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/publish.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/success.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/verifyRelease.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/configOf.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/loadSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-validate/interfaces/ValidatePluginOptions.md +2 -2
- package/api/@wtf/semantic-release-validate/schema/interfaces/Validator.md +2 -2
- package/api/@wtf/semantic-release-validate/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/schema/variables/validateOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/variables/default.md +1 -1
- package/api/README.md +2 -0
- package/guides/ci-recipes.md +2 -2
- package/guides/getting-started.md +2 -0
- package/guides/publishing-crates.md +15 -2
- package/guides/publishing-go-modules.md +12 -2
- package/guides/publishing-maven.md +15 -1
- package/guides/publishing.md +45 -3
- 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/
|
|
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/
|
|
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/
|
|
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:
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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:
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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.
|