@wtf/release-docs 8.1.0 → 8.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -4
- package/api/.generated +155 -29
- 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 +5 -4
- 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 +2 -2
- 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/README.md +34 -0
- package/api/@wtf/release-go/ecosystem/README.md +40 -0
- package/api/@wtf/release-go/ecosystem/functions/packagesOfModules.md +30 -0
- package/api/@wtf/release-go/ecosystem/functions/packagesOfRepo.md +32 -0
- package/api/@wtf/release-go/ecosystem/functions/resolveVersion.md +35 -0
- package/api/@wtf/release-go/ecosystem/functions/satisfiesVersion.md +35 -0
- package/api/@wtf/release-go/ecosystem/interfaces/GoPackage.md +97 -0
- package/api/@wtf/release-go/ecosystem/variables/goEcosystem.md +15 -0
- package/api/@wtf/release-go/errors/README.md +25 -0
- package/api/@wtf/release-go/errors/classes/GoError.md +268 -0
- package/api/@wtf/release-go/errors/type-aliases/GoErrorCode.md +13 -0
- package/api/@wtf/release-go/errors/variables/GO_ERRORS.md +47 -0
- package/api/@wtf/release-go/gomod/README.md +39 -0
- package/api/@wtf/release-go/gomod/functions/entriesOf.md +29 -0
- package/api/@wtf/release-go/gomod/functions/linesOf.md +27 -0
- package/api/@wtf/release-go/gomod/functions/readGoMod.md +28 -0
- package/api/@wtf/release-go/gomod/functions/tokensOf.md +29 -0
- package/api/@wtf/release-go/gomod/interfaces/Entry.md +41 -0
- package/api/@wtf/release-go/gomod/interfaces/GoMod.md +41 -0
- package/api/@wtf/release-go/gomod/interfaces/GoReplace.md +61 -0
- package/api/@wtf/release-go/gomod/interfaces/GoRequire.md +41 -0
- package/api/@wtf/release-go/gomod/interfaces/Token.md +51 -0
- package/api/@wtf/release-go/interfaces/GoModule.md +61 -0
- package/api/@wtf/release-go/modules/README.md +39 -0
- package/api/@wtf/release-go/modules/functions/isFetchable.md +28 -0
- package/api/@wtf/release-go/modules/functions/isGoMod.md +28 -0
- package/api/@wtf/release-go/modules/functions/majorErrors.md +37 -0
- package/api/@wtf/release-go/modules/functions/majorOfPath.md +28 -0
- package/api/@wtf/release-go/modules/functions/modulesAt.md +39 -0
- package/api/@wtf/release-go/modules/functions/modulesOf.md +29 -0
- package/api/@wtf/release-go/modules/functions/readModules.md +33 -0
- package/api/@wtf/release-go/modules/functions/selectModules.md +44 -0
- package/api/@wtf/release-go/modules/interfaces/Selection.md +43 -0
- package/api/@wtf/release-go/stamp/README.md +44 -0
- package/api/@wtf/release-go/stamp/functions/checkVersions.md +38 -0
- package/api/@wtf/release-go/stamp/functions/stampGoMod.md +35 -0
- package/api/@wtf/release-go/stamp/functions/stampModules.md +42 -0
- package/api/@wtf/release-go/stamp/interfaces/Stamped.md +31 -0
- package/api/@wtf/release-go/stamp/interfaces/StampedModules.md +31 -0
- package/api/@wtf/release-go/tags/README.md +48 -0
- package/api/@wtf/release-go/tags/functions/askProxy.md +44 -0
- package/api/@wtf/release-go/tags/functions/maskCredentials.md +28 -0
- package/api/@wtf/release-go/tags/functions/releaseCommit.md +48 -0
- package/api/@wtf/release-go/tags/functions/remoteTags.md +43 -0
- package/api/@wtf/release-go/tags/functions/tagModules.md +36 -0
- package/api/@wtf/release-go/tags/functions/tagOfModule.md +34 -0
- package/api/@wtf/release-go/tags/functions/tagPrefix.md +29 -0
- package/api/@wtf/release-go/tags/interfaces/TagModulesOptions.md +93 -0
- package/api/@wtf/release-go/tags/interfaces/TaggedModule.md +51 -0
- package/api/@wtf/release-go/tags/type-aliases/ModuleStatus.md +13 -0
- package/api/@wtf/release-go/tags/variables/RELEASE_AUTHOR.md +23 -0
- package/api/@wtf/release-maven/README.md +33 -0
- package/api/@wtf/release-maven/artifacts/README.md +41 -0
- package/api/@wtf/release-maven/artifacts/functions/groupIdOf.md +33 -0
- package/api/@wtf/release-maven/artifacts/functions/installsOf.md +44 -0
- package/api/@wtf/release-maven/artifacts/functions/isPomFile.md +28 -0
- package/api/@wtf/release-maven/artifacts/functions/isRange.md +27 -0
- package/api/@wtf/release-maven/artifacts/functions/modulesOf.md +44 -0
- package/api/@wtf/release-maven/artifacts/functions/nameOf.md +33 -0
- package/api/@wtf/release-maven/artifacts/functions/publishOrder.md +34 -0
- package/api/@wtf/release-maven/artifacts/functions/readModules.md +31 -0
- package/api/@wtf/release-maven/artifacts/functions/readPoms.md +32 -0
- package/api/@wtf/release-maven/artifacts/functions/selectArtifacts.md +44 -0
- package/api/@wtf/release-maven/artifacts/interfaces/Selection.md +42 -0
- package/api/@wtf/release-maven/ecosystem/README.md +41 -0
- package/api/@wtf/release-maven/ecosystem/functions/compareVersions.md +38 -0
- package/api/@wtf/release-maven/ecosystem/functions/parseRange.md +28 -0
- package/api/@wtf/release-maven/ecosystem/functions/resolveVersion.md +36 -0
- package/api/@wtf/release-maven/ecosystem/functions/satisfiesVersion.md +36 -0
- package/api/@wtf/release-maven/ecosystem/interfaces/Bound.md +31 -0
- package/api/@wtf/release-maven/ecosystem/interfaces/Restriction.md +31 -0
- package/api/@wtf/release-maven/ecosystem/variables/mavenEcosystem.md +15 -0
- package/api/@wtf/release-maven/errors/README.md +25 -0
- package/api/@wtf/release-maven/errors/classes/MavenError.md +268 -0
- package/api/@wtf/release-maven/errors/type-aliases/MavenErrorCode.md +13 -0
- package/api/@wtf/release-maven/errors/variables/MAVEN_ERRORS.md +51 -0
- package/api/@wtf/release-maven/interfaces/MavenModule.md +169 -0
- package/api/@wtf/release-maven/pom/README.md +48 -0
- package/api/@wtf/release-maven/pom/functions/childOf.md +33 -0
- package/api/@wtf/release-maven/pom/functions/childrenOf.md +33 -0
- package/api/@wtf/release-maven/pom/functions/dependencyOf.md +27 -0
- package/api/@wtf/release-maven/pom/functions/escapeXml.md +27 -0
- package/api/@wtf/release-maven/pom/functions/parseXml.md +39 -0
- package/api/@wtf/release-maven/pom/functions/readPom.md +39 -0
- package/api/@wtf/release-maven/pom/functions/textAt.md +34 -0
- package/api/@wtf/release-maven/pom/interfaces/Pom.md +151 -0
- package/api/@wtf/release-maven/pom/interfaces/PomDependency.md +51 -0
- package/api/@wtf/release-maven/pom/interfaces/PomParent.md +41 -0
- package/api/@wtf/release-maven/pom/interfaces/PomPlugin.md +51 -0
- package/api/@wtf/release-maven/pom/interfaces/PomRepository.md +31 -0
- package/api/@wtf/release-maven/pom/interfaces/Span.md +35 -0
- package/api/@wtf/release-maven/pom/interfaces/XmlElement.md +83 -0
- package/api/@wtf/release-maven/pom/variables/PLUGIN_GROUP.md +13 -0
- package/api/@wtf/release-maven/publish/README.md +45 -0
- package/api/@wtf/release-maven/publish/functions/deployModules.md +35 -0
- package/api/@wtf/release-maven/publish/interfaces/DeployModulesOptions.md +146 -0
- package/api/@wtf/release-maven/publish/interfaces/DeployedModule.md +42 -0
- package/api/@wtf/release-maven/publish/type-aliases/ModuleStatus.md +13 -0
- package/api/@wtf/release-maven/repository/README.md +38 -0
- package/api/@wtf/release-maven/repository/functions/deployTargets.md +46 -0
- package/api/@wtf/release-maven/repository/functions/expandValues.md +42 -0
- package/api/@wtf/release-maven/repository/functions/hasPom.md +38 -0
- package/api/@wtf/release-maven/repository/functions/pomPath.md +40 -0
- package/api/@wtf/release-maven/repository/functions/pomUrl.md +45 -0
- package/api/@wtf/release-maven/repository/interfaces/Repository.md +31 -0
- package/api/@wtf/release-maven/repository/interfaces/ValuesOf.md +31 -0
- package/api/@wtf/release-maven/repository/variables/MAVEN_CENTRAL.md +13 -0
- package/api/@wtf/release-maven/stamp/README.md +50 -0
- package/api/@wtf/release-maven/stamp/functions/checkVersions.md +36 -0
- package/api/@wtf/release-maven/stamp/functions/stampModules.md +55 -0
- package/api/@wtf/release-maven/stamp/functions/stampPom.md +45 -0
- package/api/@wtf/release-maven/stamp/interfaces/PomStampOptions.md +51 -0
- package/api/@wtf/release-maven/stamp/interfaces/Stamped.md +31 -0
- package/api/@wtf/release-maven/stamp/interfaces/StampedModules.md +31 -0
- 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 +13 -13
- 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/functions/builtInPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/functions/isPublisher.md +1 -1
- 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 +16 -16
- package/api/@wtf/release-npm/release/interfaces/PackOptions.md +8 -8
- package/api/@wtf/release-npm/release/interfaces/PackedTrain.md +12 -12
- 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 +7 -7
- package/api/@wtf/release-npm/release/interfaces/PublishedTrain.md +5 -5
- package/api/@wtf/release-npm/release/interfaces/ResolveRelease.md +17 -17
- 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 +7 -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/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 +8 -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 +1 -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/interfaces/Train.md +7 -7
- 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/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 +73 -0
- package/api/@wtf/semantic-release-go/functions/prepare.md +41 -0
- package/api/@wtf/semantic-release-go/functions/publish.md +43 -0
- package/api/@wtf/semantic-release-go/functions/verifyConditions.md +37 -0
- package/api/@wtf/semantic-release-go/functions/verifyRelease.md +38 -0
- package/api/@wtf/semantic-release-go/interfaces/GoPluginOptions.md +84 -0
- package/api/@wtf/semantic-release-go/interfaces/GoRelease.md +31 -0
- package/api/@wtf/semantic-release-go/schema/README.md +37 -0
- package/api/@wtf/semantic-release-go/schema/type-aliases/GoOptions.md +13 -0
- package/api/@wtf/{semantic-release-trains-changelog → semantic-release-go}/schema/variables/configSchema.md +2 -2
- package/api/@wtf/semantic-release-go/schema/variables/goOptionsSchema.md +13 -0
- package/api/@wtf/semantic-release-go/schema/variables/goSchema.md +14 -0
- package/api/@wtf/{semantic-release-trains-changelog → semantic-release-go}/schema/variables/jsonSchema.md +2 -2
- package/api/@wtf/semantic-release-go/variables/default.md +144 -0
- package/api/@wtf/semantic-release-maven/README.md +74 -0
- package/api/@wtf/semantic-release-maven/functions/pomLookup.md +38 -0
- package/api/@wtf/semantic-release-maven/functions/prepare.md +41 -0
- package/api/@wtf/semantic-release-maven/functions/publish.md +43 -0
- package/api/@wtf/semantic-release-maven/functions/verifyConditions.md +40 -0
- package/api/@wtf/semantic-release-maven/interfaces/LookupAuth.md +32 -0
- package/api/@wtf/semantic-release-maven/interfaces/MavenPluginOptions.md +129 -0
- package/api/@wtf/semantic-release-maven/interfaces/MavenRelease.md +21 -0
- package/api/@wtf/semantic-release-maven/schema/README.md +38 -0
- package/api/@wtf/semantic-release-maven/schema/type-aliases/MavenOptions.md +13 -0
- package/api/@wtf/semantic-release-maven/schema/variables/configSchema.md +13 -0
- package/api/@wtf/semantic-release-maven/schema/variables/jsonSchema.md +13 -0
- package/api/@wtf/semantic-release-maven/schema/variables/mavenOptionsSchema.md +13 -0
- package/api/@wtf/semantic-release-maven/schema/variables/mavenSchema.md +14 -0
- package/api/@wtf/semantic-release-maven/variables/default.md +116 -0
- 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 +18 -18
- 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/config/README.md +11 -3
- 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 +3 -4
- 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 +14 -0
- package/api/@wtf/semantic-release-trains/defaults/README.md +42 -0
- package/api/@wtf/semantic-release-trains/defaults/functions/skipRuleOf.md +40 -0
- package/api/@wtf/semantic-release-trains/defaults/functions/skips.md +42 -0
- package/api/@wtf/semantic-release-trains/defaults/functions/trainOptionsOf.md +40 -0
- package/api/@wtf/semantic-release-trains/defaults/interfaces/SkipContext.md +59 -0
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/SkipCheck.md +35 -0
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/TrainOptions.md +33 -0
- package/api/@wtf/semantic-release-trains/defaults/variables/SKIP_RULES.md +13 -0
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_OPTIONS.md +20 -0
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_SKIP.md +17 -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 +15 -8
- package/api/@wtf/semantic-release-trains/interfaces/TrainsOptions.md +7 -7
- package/api/@wtf/semantic-release-trains/schema/README.md +1 -0
- 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 +13 -0
- 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 +20 -5
- package/api/trains.json +9 -3
- package/guides/changelogs.md +30 -123
- package/guides/ci-recipes.md +16 -13
- package/guides/configuring-trains.md +7 -4
- package/guides/ecosystems.md +46 -23
- package/guides/getting-started.md +4 -6
- package/guides/publishing-go-modules.md +208 -0
- package/guides/publishing-maven.md +293 -0
- package/guides/publishing.md +6 -5
- package/guides/system.md +2 -2
- package/guides/validating-a-config.md +7 -9
- package/package.json +12 -10
- package/api/@wtf/release-trains-changelog/README.md +0 -58
- package/api/@wtf/release-trains-changelog/render/README.md +0 -44
- package/api/@wtf/release-trains-changelog/render/functions/changelogSection.md +0 -35
- package/api/@wtf/release-trains-changelog/render/functions/parseCommit.md +0 -28
- package/api/@wtf/release-trains-changelog/render/functions/prependSection.md +0 -40
- package/api/@wtf/release-trains-changelog/render/functions/renderSection.md +0 -37
- package/api/@wtf/release-trains-changelog/render/interfaces/ChangelogCommit.md +0 -27
- package/api/@wtf/release-trains-changelog/render/interfaces/ParsedCommit.md +0 -53
- package/api/@wtf/release-trains-changelog/render/interfaces/RenderOptions.md +0 -65
- package/api/@wtf/release-trains-changelog/render/variables/DEFAULT_TYPES.md +0 -13
- package/api/@wtf/release-trains-changelog/render/variables/TITLE.md +0 -13
- package/api/@wtf/release-trains-changelog/write/README.md +0 -48
- package/api/@wtf/release-trains-changelog/write/functions/changelogErrors.md +0 -33
- package/api/@wtf/release-trains-changelog/write/functions/commitUrlOf.md +0 -29
- package/api/@wtf/release-trains-changelog/write/functions/writeChangelogs.md +0 -35
- package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogOptions.md +0 -68
- package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogRelease.md +0 -176
- package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogTarget.md +0 -146
- package/api/@wtf/release-trains-changelog/write/interfaces/WrittenChangelog.md +0 -37
- package/api/@wtf/semantic-release-trains-changelog/README.md +0 -47
- package/api/@wtf/semantic-release-trains-changelog/functions/prepare.md +0 -33
- package/api/@wtf/semantic-release-trains-changelog/functions/verifyConditions.md +0 -36
- package/api/@wtf/semantic-release-trains-changelog/interfaces/ChangelogPluginOptions.md +0 -126
- package/api/@wtf/semantic-release-trains-changelog/schema/README.md +0 -24
- package/api/@wtf/semantic-release-trains-changelog/schema/variables/changelogOptionsSchema.md +0 -13
- package/api/@wtf/semantic-release-trains-changelog/schema/variables/changelogSchema.md +0 -13
- package/api/@wtf/semantic-release-trains-changelog/variables/default.md +0 -68
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / PomDependency
|
|
6
|
+
|
|
7
|
+
# Interface: PomDependency
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/release-maven/src/pom.ts:227](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L227)
|
|
10
|
+
|
|
11
|
+
A dependency of a pom, as it writes it: each value its text, `undefined` where it has none.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### artifactId
|
|
16
|
+
|
|
17
|
+
> `readonly` **artifactId**: `string` \| `undefined`
|
|
18
|
+
|
|
19
|
+
Defined in: [packages/release-maven/src/pom.ts:231](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L231)
|
|
20
|
+
|
|
21
|
+
Its `artifactId`.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### groupId
|
|
26
|
+
|
|
27
|
+
> `readonly` **groupId**: `string` \| `undefined`
|
|
28
|
+
|
|
29
|
+
Defined in: [packages/release-maven/src/pom.ts:229](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L229)
|
|
30
|
+
|
|
31
|
+
Its `groupId`, as written, as `${project.groupId}`.
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### scope
|
|
36
|
+
|
|
37
|
+
> `readonly` **scope**: `string` \| `undefined`
|
|
38
|
+
|
|
39
|
+
Defined in: [packages/release-maven/src/pom.ts:235](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L235)
|
|
40
|
+
|
|
41
|
+
Its `scope`, as `test`: none, Maven's `compile`.
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### version
|
|
46
|
+
|
|
47
|
+
> `readonly` **version**: `string` \| `undefined`
|
|
48
|
+
|
|
49
|
+
Defined in: [packages/release-maven/src/pom.ts:233](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L233)
|
|
50
|
+
|
|
51
|
+
Its `version`, as written, as `[1.0,2.0)` or `${project.version}`.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / PomParent
|
|
6
|
+
|
|
7
|
+
# Interface: PomParent
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/release-maven/src/pom.ts:251](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L251)
|
|
10
|
+
|
|
11
|
+
The parent of a pom, of its `<parent>`.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### artifactId
|
|
16
|
+
|
|
17
|
+
> `readonly` **artifactId**: `string` \| `undefined`
|
|
18
|
+
|
|
19
|
+
Defined in: [packages/release-maven/src/pom.ts:255](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L255)
|
|
20
|
+
|
|
21
|
+
Its `artifactId`.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### groupId
|
|
26
|
+
|
|
27
|
+
> `readonly` **groupId**: `string` \| `undefined`
|
|
28
|
+
|
|
29
|
+
Defined in: [packages/release-maven/src/pom.ts:253](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L253)
|
|
30
|
+
|
|
31
|
+
Its `groupId`.
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### version
|
|
36
|
+
|
|
37
|
+
> `readonly` **version**: `string` \| `undefined`
|
|
38
|
+
|
|
39
|
+
Defined in: [packages/release-maven/src/pom.ts:257](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L257)
|
|
40
|
+
|
|
41
|
+
Its `version`, as written.
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / PomPlugin
|
|
6
|
+
|
|
7
|
+
# Interface: PomPlugin
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/release-maven/src/pom.ts:239](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L239)
|
|
10
|
+
|
|
11
|
+
A plugin of the build of a pom, as it writes it.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### artifactId
|
|
16
|
+
|
|
17
|
+
> `readonly` **artifactId**: `string` \| `undefined`
|
|
18
|
+
|
|
19
|
+
Defined in: [packages/release-maven/src/pom.ts:243](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L243)
|
|
20
|
+
|
|
21
|
+
Its `artifactId`.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### dependencies
|
|
26
|
+
|
|
27
|
+
> `readonly` **dependencies**: readonly [`PomDependency`](PomDependency.md)[]
|
|
28
|
+
|
|
29
|
+
Defined in: [packages/release-maven/src/pom.ts:247](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L247)
|
|
30
|
+
|
|
31
|
+
The dependencies of the plugin.
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### groupId
|
|
36
|
+
|
|
37
|
+
> `readonly` **groupId**: `string`
|
|
38
|
+
|
|
39
|
+
Defined in: [packages/release-maven/src/pom.ts:241](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L241)
|
|
40
|
+
|
|
41
|
+
Its `groupId`: `org.apache.maven.plugins` where it writes none, as Maven reads it.
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### version
|
|
46
|
+
|
|
47
|
+
> `readonly` **version**: `string` \| `undefined`
|
|
48
|
+
|
|
49
|
+
Defined in: [packages/release-maven/src/pom.ts:245](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L245)
|
|
50
|
+
|
|
51
|
+
Its `version`, as written.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / PomRepository
|
|
6
|
+
|
|
7
|
+
# Interface: PomRepository
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/release-maven/src/pom.ts:261](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L261)
|
|
10
|
+
|
|
11
|
+
The repository a pom deploys to, of its `distributionManagement`.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### id
|
|
16
|
+
|
|
17
|
+
> `readonly` **id**: `string` \| `undefined`
|
|
18
|
+
|
|
19
|
+
Defined in: [packages/release-maven/src/pom.ts:263](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L263)
|
|
20
|
+
|
|
21
|
+
Its `id`, the `<server>` of settings.xml whose credentials Maven deploys by.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### url
|
|
26
|
+
|
|
27
|
+
> `readonly` **url**: `string` \| `undefined`
|
|
28
|
+
|
|
29
|
+
Defined in: [packages/release-maven/src/pom.ts:265](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L265)
|
|
30
|
+
|
|
31
|
+
Its `url`, as written, as `${env.CI_API_V4_URL}/projects/1/packages/maven`.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / Span
|
|
6
|
+
|
|
7
|
+
# Interface: Span
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/release-maven/src/pom.ts:27](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L27)
|
|
10
|
+
|
|
11
|
+
Where a part of the text starts and ends: `end` is the offset after its last character.
|
|
12
|
+
|
|
13
|
+
## Extended by
|
|
14
|
+
|
|
15
|
+
- [`XmlElement`](XmlElement.md)
|
|
16
|
+
|
|
17
|
+
## Properties
|
|
18
|
+
|
|
19
|
+
### end
|
|
20
|
+
|
|
21
|
+
> `readonly` **end**: `number`
|
|
22
|
+
|
|
23
|
+
Defined in: [packages/release-maven/src/pom.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L31)
|
|
24
|
+
|
|
25
|
+
The offset after its last character.
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### start
|
|
30
|
+
|
|
31
|
+
> `readonly` **start**: `number`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/release-maven/src/pom.ts:29](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L29)
|
|
34
|
+
|
|
35
|
+
The offset of its first character.
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / XmlElement
|
|
6
|
+
|
|
7
|
+
# Interface: XmlElement
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/release-maven/src/pom.ts:35](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L35)
|
|
10
|
+
|
|
11
|
+
An element of XML, as [parseXml](../functions/parseXml.md) reads it.
|
|
12
|
+
|
|
13
|
+
## Extends
|
|
14
|
+
|
|
15
|
+
- [`Span`](Span.md)
|
|
16
|
+
|
|
17
|
+
## Properties
|
|
18
|
+
|
|
19
|
+
### children
|
|
20
|
+
|
|
21
|
+
> `readonly` **children**: readonly `XmlElement`[]
|
|
22
|
+
|
|
23
|
+
Defined in: [packages/release-maven/src/pom.ts:41](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L41)
|
|
24
|
+
|
|
25
|
+
Its elements, in order.
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### end
|
|
30
|
+
|
|
31
|
+
> `readonly` **end**: `number`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/release-maven/src/pom.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L31)
|
|
34
|
+
|
|
35
|
+
The offset after its last character.
|
|
36
|
+
|
|
37
|
+
#### Inherited from
|
|
38
|
+
|
|
39
|
+
[`Span`](Span.md).[`end`](Span.md#end)
|
|
40
|
+
|
|
41
|
+
***
|
|
42
|
+
|
|
43
|
+
### inner
|
|
44
|
+
|
|
45
|
+
> `readonly` **inner**: [`Span`](Span.md) \| `undefined`
|
|
46
|
+
|
|
47
|
+
Defined in: [packages/release-maven/src/pom.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L39)
|
|
48
|
+
|
|
49
|
+
Where its content is, between its tags: `undefined` of an element of one tag, as `<version/>`.
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### name
|
|
54
|
+
|
|
55
|
+
> `readonly` **name**: `string`
|
|
56
|
+
|
|
57
|
+
Defined in: [packages/release-maven/src/pom.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L37)
|
|
58
|
+
|
|
59
|
+
Its name, as its tag writes it, as `version`.
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
63
|
+
### start
|
|
64
|
+
|
|
65
|
+
> `readonly` **start**: `number`
|
|
66
|
+
|
|
67
|
+
Defined in: [packages/release-maven/src/pom.ts:29](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L29)
|
|
68
|
+
|
|
69
|
+
The offset of its first character.
|
|
70
|
+
|
|
71
|
+
#### Inherited from
|
|
72
|
+
|
|
73
|
+
[`Span`](Span.md).[`start`](Span.md#start)
|
|
74
|
+
|
|
75
|
+
***
|
|
76
|
+
|
|
77
|
+
### text
|
|
78
|
+
|
|
79
|
+
> `readonly` **text**: `string`
|
|
80
|
+
|
|
81
|
+
Defined in: [packages/release-maven/src/pom.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L43)
|
|
82
|
+
|
|
83
|
+
Its own text, and of its CDATA, the entities read, of no space at either end: not its children's.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/pom](../README.md) / PLUGIN\_GROUP
|
|
6
|
+
|
|
7
|
+
# Variable: PLUGIN\_GROUP
|
|
8
|
+
|
|
9
|
+
> `const` **PLUGIN\_GROUP**: `"org.apache.maven.plugins"` = `'org.apache.maven.plugins'`
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/release-maven/src/pom.ts:301](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/pom.ts#L301)
|
|
12
|
+
|
|
13
|
+
The groupId of a plugin that writes none, as Maven reads it.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
[**Release trains**](../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../README.md) / @wtf/release-maven/publish
|
|
6
|
+
|
|
7
|
+
# @wtf/release-maven/publish
|
|
8
|
+
|
|
9
|
+
The modules of a release deployed, by `mvn` run through the system from the root of the repo:
|
|
10
|
+
each module the repository has not at the version, in the order it is given, the ones it has
|
|
11
|
+
skipped, so a release that failed part way is finished by running it again. Each runs
|
|
12
|
+
`<command> -B -N -f <dir>/pom.xml deploy`, of that pom alone: a deploy installs the module into
|
|
13
|
+
the local repository too, so the next module of the release finds it. A module the release does
|
|
14
|
+
not deploy that one of it needs, as a module of `maven.deploy.skip` its tests depend on, is
|
|
15
|
+
installed in its place in the order (`install` for `deploy`).
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import { deployModules } from '@wtf/release-maven/publish'
|
|
19
|
+
import type { MavenModule } from '@wtf/release-maven'
|
|
20
|
+
import type { System } from '@wtf/release-system'
|
|
21
|
+
|
|
22
|
+
// The modules deployed, of a repository that has none of them yet.
|
|
23
|
+
export const deployAll = (system: System, modules: MavenModule[]) =>
|
|
24
|
+
deployModules({
|
|
25
|
+
system,
|
|
26
|
+
cwd: system.cwd,
|
|
27
|
+
modules,
|
|
28
|
+
version: '1.0.0',
|
|
29
|
+
lookup: async () => false,
|
|
30
|
+
log: console.log
|
|
31
|
+
})
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Interfaces
|
|
35
|
+
|
|
36
|
+
- [DeployedModule](interfaces/DeployedModule.md)
|
|
37
|
+
- [DeployModulesOptions](interfaces/DeployModulesOptions.md)
|
|
38
|
+
|
|
39
|
+
## Type Aliases
|
|
40
|
+
|
|
41
|
+
- [ModuleStatus](type-aliases/ModuleStatus.md)
|
|
42
|
+
|
|
43
|
+
## Functions
|
|
44
|
+
|
|
45
|
+
- [deployModules](functions/deployModules.md)
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/publish](../README.md) / deployModules
|
|
6
|
+
|
|
7
|
+
# Function: deployModules()
|
|
8
|
+
|
|
9
|
+
> **deployModules**(`options`): `Promise`\<[`DeployedModule`](../interfaces/DeployedModule.md)[]\>
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/release-maven/src/publish.ts:110](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L110)
|
|
12
|
+
|
|
13
|
+
Deploys each module of the release the repository lacks, in order, and gives what became of each.
|
|
14
|
+
The repository is asked of every module before the first is deployed, so one it cannot answer of
|
|
15
|
+
stops the run before anything is on it. A version that is there is skipped.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
### options
|
|
20
|
+
|
|
21
|
+
[`DeployModulesOptions`](../interfaces/DeployModulesOptions.md)
|
|
22
|
+
|
|
23
|
+
The system, the modules and the version, the lookup, the command and its
|
|
24
|
+
arguments, the repository and the log.
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
`Promise`\<[`DeployedModule`](../interfaces/DeployedModule.md)[]\>
|
|
29
|
+
|
|
30
|
+
The modules, in the order given, each deployed, skipped or installed.
|
|
31
|
+
|
|
32
|
+
## Throws
|
|
33
|
+
|
|
34
|
+
`EMAVENREPOSITORY` of a repository that cannot be asked, `EMAVENDEPLOY` of an `mvn` that
|
|
35
|
+
cannot be run or fails.
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/publish](../README.md) / DeployModulesOptions
|
|
6
|
+
|
|
7
|
+
# Interface: DeployModulesOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/release-maven/src/publish.ts:53](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L53)
|
|
10
|
+
|
|
11
|
+
What a deploy needs.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### args?
|
|
16
|
+
|
|
17
|
+
> `readonly` `optional` **args?**: readonly `string`[]
|
|
18
|
+
|
|
19
|
+
Defined in: [packages/release-maven/src/publish.ts:81](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L81)
|
|
20
|
+
|
|
21
|
+
The arguments of each run after the goal, as `['-s', 'ci_settings.xml']`.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### command?
|
|
26
|
+
|
|
27
|
+
> `readonly` `optional` **command?**: `string`
|
|
28
|
+
|
|
29
|
+
Defined in: [packages/release-maven/src/publish.ts:79](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L79)
|
|
30
|
+
|
|
31
|
+
Maven, as it is run: `mvn` by default, or a wrapper, as `./mvnw`.
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### cwd
|
|
36
|
+
|
|
37
|
+
> `readonly` **cwd**: `string`
|
|
38
|
+
|
|
39
|
+
Defined in: [packages/release-maven/src/publish.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L57)
|
|
40
|
+
|
|
41
|
+
The folder of the repo, where `mvn` runs.
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### installs?
|
|
46
|
+
|
|
47
|
+
> `readonly` `optional` **installs?**: `ReadonlySet`\<`string`\>
|
|
48
|
+
|
|
49
|
+
Defined in: [packages/release-maven/src/publish.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L67)
|
|
50
|
+
|
|
51
|
+
The modules of `modules` to install rather than deploy, by name (`installsOf` of
|
|
52
|
+
`./artifacts`): none by default.
|
|
53
|
+
|
|
54
|
+
***
|
|
55
|
+
|
|
56
|
+
### log
|
|
57
|
+
|
|
58
|
+
> `readonly` **log**: (`line`) => `void`
|
|
59
|
+
|
|
60
|
+
Defined in: [packages/release-maven/src/publish.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L92)
|
|
61
|
+
|
|
62
|
+
The log of the run, a line at a time.
|
|
63
|
+
|
|
64
|
+
#### Parameters
|
|
65
|
+
|
|
66
|
+
##### line
|
|
67
|
+
|
|
68
|
+
`string`
|
|
69
|
+
|
|
70
|
+
The line to log, of no newline.
|
|
71
|
+
|
|
72
|
+
#### Returns
|
|
73
|
+
|
|
74
|
+
`void`
|
|
75
|
+
|
|
76
|
+
***
|
|
77
|
+
|
|
78
|
+
### lookup
|
|
79
|
+
|
|
80
|
+
> `readonly` **lookup**: (`module`, `version`) => `Promise`\<`boolean`\>
|
|
81
|
+
|
|
82
|
+
Defined in: [packages/release-maven/src/publish.ts:77](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L77)
|
|
83
|
+
|
|
84
|
+
Whether the repository has a module at a version: the plugin asks it for its pom.
|
|
85
|
+
|
|
86
|
+
#### Parameters
|
|
87
|
+
|
|
88
|
+
##### module
|
|
89
|
+
|
|
90
|
+
[`MavenModule`](../../interfaces/MavenModule.md)
|
|
91
|
+
|
|
92
|
+
The module.
|
|
93
|
+
|
|
94
|
+
##### version
|
|
95
|
+
|
|
96
|
+
`string`
|
|
97
|
+
|
|
98
|
+
The version.
|
|
99
|
+
|
|
100
|
+
#### Returns
|
|
101
|
+
|
|
102
|
+
`Promise`\<`boolean`\>
|
|
103
|
+
|
|
104
|
+
Whether the repository has it.
|
|
105
|
+
|
|
106
|
+
***
|
|
107
|
+
|
|
108
|
+
### modules
|
|
109
|
+
|
|
110
|
+
> `readonly` **modules**: readonly [`MavenModule`](../../interfaces/MavenModule.md)[]
|
|
111
|
+
|
|
112
|
+
Defined in: [packages/release-maven/src/publish.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L62)
|
|
113
|
+
|
|
114
|
+
The modules, in the order to deploy them in (`publishOrder` of `./artifacts`), at `version`
|
|
115
|
+
already.
|
|
116
|
+
|
|
117
|
+
***
|
|
118
|
+
|
|
119
|
+
### repository?
|
|
120
|
+
|
|
121
|
+
> `readonly` `optional` **repository?**: [`Repository`](../../repository/interfaces/Repository.md)
|
|
122
|
+
|
|
123
|
+
Defined in: [packages/release-maven/src/publish.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L86)
|
|
124
|
+
|
|
125
|
+
The repository each module deploys to, of the plugin's options, as `altDeploymentRepository`:
|
|
126
|
+
none, each deploys to its pom's `distributionManagement`.
|
|
127
|
+
|
|
128
|
+
***
|
|
129
|
+
|
|
130
|
+
### system
|
|
131
|
+
|
|
132
|
+
> `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
|
|
133
|
+
|
|
134
|
+
Defined in: [packages/release-maven/src/publish.ts:55](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L55)
|
|
135
|
+
|
|
136
|
+
The system `mvn` runs by: its environment holds what the settings of Maven read.
|
|
137
|
+
|
|
138
|
+
***
|
|
139
|
+
|
|
140
|
+
### version
|
|
141
|
+
|
|
142
|
+
> `readonly` **version**: `string`
|
|
143
|
+
|
|
144
|
+
Defined in: [packages/release-maven/src/publish.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L69)
|
|
145
|
+
|
|
146
|
+
The version of the release.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/publish](../README.md) / DeployedModule
|
|
6
|
+
|
|
7
|
+
# Interface: DeployedModule
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/release-maven/src/publish.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L40)
|
|
10
|
+
|
|
11
|
+
A module of the release, and what became of it.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### name
|
|
16
|
+
|
|
17
|
+
> `readonly` **name**: `string`
|
|
18
|
+
|
|
19
|
+
Defined in: [packages/release-maven/src/publish.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L42)
|
|
20
|
+
|
|
21
|
+
The name of the module, `groupId:artifactId`.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### status
|
|
26
|
+
|
|
27
|
+
> `readonly` **status**: [`ModuleStatus`](../type-aliases/ModuleStatus.md)
|
|
28
|
+
|
|
29
|
+
Defined in: [packages/release-maven/src/publish.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L49)
|
|
30
|
+
|
|
31
|
+
Whether it was deployed, skipped as the repository has it, or installed alone, as a module the
|
|
32
|
+
release does not deploy.
|
|
33
|
+
|
|
34
|
+
***
|
|
35
|
+
|
|
36
|
+
### version
|
|
37
|
+
|
|
38
|
+
> `readonly` **version**: `string`
|
|
39
|
+
|
|
40
|
+
Defined in: [packages/release-maven/src/publish.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L44)
|
|
41
|
+
|
|
42
|
+
The version of the module: the release's, but of a module installed of another.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/publish](../README.md) / ModuleStatus
|
|
6
|
+
|
|
7
|
+
# Type Alias: ModuleStatus
|
|
8
|
+
|
|
9
|
+
> **ModuleStatus** = `"deployed"` \| `"skipped"` \| `"installed"`
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/release-maven/src/publish.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/publish.ts#L37)
|
|
12
|
+
|
|
13
|
+
What happened to a module of the release.
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
[**Release trains**](../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../README.md) / @wtf/release-maven/repository
|
|
6
|
+
|
|
7
|
+
# @wtf/release-maven/repository
|
|
8
|
+
|
|
9
|
+
Where a Maven repository serves a module, of no network: the path of a pom in the layout of a
|
|
10
|
+
repository ([pomPath](functions/pomPath.md)) and its URL ([pomUrl](functions/pomUrl.md)), what an answer to a request of it says
|
|
11
|
+
([hasPom](functions/hasPom.md)), the values of `${…}` in a URL a pom writes ([expandValues](functions/expandValues.md)), and the
|
|
12
|
+
repository each module of a release deploys to ([deployTargets](functions/deployTargets.md)). The caller asks the
|
|
13
|
+
repository; a release asks Maven Central at [MAVEN\_CENTRAL](variables/MAVEN_CENTRAL.md), where the Central Portal
|
|
14
|
+
publishes.
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
import { pomUrl } from '@wtf/release-maven/repository'
|
|
18
|
+
|
|
19
|
+
console.log(pomUrl('https://repo1.maven.org/maven2', 'org.acme', 'core', '1.2.3'))
|
|
20
|
+
// https://repo1.maven.org/maven2/org/acme/core/1.2.3/core-1.2.3.pom
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Interfaces
|
|
24
|
+
|
|
25
|
+
- [Repository](interfaces/Repository.md)
|
|
26
|
+
- [ValuesOf](interfaces/ValuesOf.md)
|
|
27
|
+
|
|
28
|
+
## Variables
|
|
29
|
+
|
|
30
|
+
- [MAVEN\_CENTRAL](variables/MAVEN_CENTRAL.md)
|
|
31
|
+
|
|
32
|
+
## Functions
|
|
33
|
+
|
|
34
|
+
- [deployTargets](functions/deployTargets.md)
|
|
35
|
+
- [expandValues](functions/expandValues.md)
|
|
36
|
+
- [hasPom](functions/hasPom.md)
|
|
37
|
+
- [pomPath](functions/pomPath.md)
|
|
38
|
+
- [pomUrl](functions/pomUrl.md)
|