@wtf/release-docs 8.1.0 → 8.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 +19 -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,46 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / deployTargets
|
|
6
|
+
|
|
7
|
+
# Function: deployTargets()
|
|
8
|
+
|
|
9
|
+
> **deployTargets**(`modules`, `option`, `env`): `Map`\<`string`, [`Repository`](../interfaces/Repository.md)\>
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/release-maven/src/repository.ts:126](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/repository.ts#L126)
|
|
12
|
+
|
|
13
|
+
The repository each module deploys to, by its name: `option` where it is given, else the
|
|
14
|
+
repository of its `distributionManagement`, or of its parents' in the repo, each `${…}` of its URL
|
|
15
|
+
written of the module's properties and the environment.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
### modules
|
|
20
|
+
|
|
21
|
+
readonly [`MavenModule`](../../interfaces/MavenModule.md)[]
|
|
22
|
+
|
|
23
|
+
The modules of the release.
|
|
24
|
+
|
|
25
|
+
### option
|
|
26
|
+
|
|
27
|
+
[`Repository`](../interfaces/Repository.md) \| `undefined`
|
|
28
|
+
|
|
29
|
+
The repository the plugin's options name: none, each module's own.
|
|
30
|
+
|
|
31
|
+
### env
|
|
32
|
+
|
|
33
|
+
`Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
|
|
34
|
+
|
|
35
|
+
The environment, which `${env.NAME}` of a URL names.
|
|
36
|
+
|
|
37
|
+
## Returns
|
|
38
|
+
|
|
39
|
+
`Map`\<`string`, [`Repository`](../interfaces/Repository.md)\>
|
|
40
|
+
|
|
41
|
+
The repository of each module, by its name.
|
|
42
|
+
|
|
43
|
+
## Throws
|
|
44
|
+
|
|
45
|
+
`EMAVENREPOSITORY` of each module of no repository, of no `id` or no `url`, or of a URL
|
|
46
|
+
of a `${…}` of no value, together.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / expandValues
|
|
6
|
+
|
|
7
|
+
# Function: expandValues()
|
|
8
|
+
|
|
9
|
+
> **expandValues**(`text`, `values`): `object`
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/release-maven/src/repository.ts:100](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/repository.ts#L100)
|
|
12
|
+
|
|
13
|
+
The text `text` of each `${…}` it holds written as its value: `${env.NAME}` of the environment, any
|
|
14
|
+
other of the properties; the names of those of no value are given apart, and left in the text.
|
|
15
|
+
|
|
16
|
+
## Parameters
|
|
17
|
+
|
|
18
|
+
### text
|
|
19
|
+
|
|
20
|
+
`string`
|
|
21
|
+
|
|
22
|
+
The text, as a pom writes it, as `${env.CI_API_V4_URL}/projects/1/packages/maven`.
|
|
23
|
+
|
|
24
|
+
### values
|
|
25
|
+
|
|
26
|
+
[`ValuesOf`](../interfaces/ValuesOf.md)
|
|
27
|
+
|
|
28
|
+
The properties and the environment.
|
|
29
|
+
|
|
30
|
+
## Returns
|
|
31
|
+
|
|
32
|
+
`object`
|
|
33
|
+
|
|
34
|
+
The text, and the names of no value.
|
|
35
|
+
|
|
36
|
+
### text
|
|
37
|
+
|
|
38
|
+
> `readonly` **text**: `string`
|
|
39
|
+
|
|
40
|
+
### unknown
|
|
41
|
+
|
|
42
|
+
> `readonly` **unknown**: readonly `string`[]
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / hasPom
|
|
6
|
+
|
|
7
|
+
# Function: hasPom()
|
|
8
|
+
|
|
9
|
+
> **hasPom**(`status`, `url`): `boolean`
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/release-maven/src/repository.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/repository.ts#L72)
|
|
12
|
+
|
|
13
|
+
Whether the answer of a repository to a request of a pom says it has it: a 2xx yes, a 404 no.
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
### status
|
|
18
|
+
|
|
19
|
+
`number`
|
|
20
|
+
|
|
21
|
+
The status of the answer.
|
|
22
|
+
|
|
23
|
+
### url
|
|
24
|
+
|
|
25
|
+
`string`
|
|
26
|
+
|
|
27
|
+
The URL of the pom, as an error names it.
|
|
28
|
+
|
|
29
|
+
## Returns
|
|
30
|
+
|
|
31
|
+
`boolean`
|
|
32
|
+
|
|
33
|
+
Whether the repository has the pom.
|
|
34
|
+
|
|
35
|
+
## Throws
|
|
36
|
+
|
|
37
|
+
`EMAVENREPOSITORY` of any other status, as of a repository that refuses the credentials
|
|
38
|
+
or is down: the release cannot know what it has.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / pomPath
|
|
6
|
+
|
|
7
|
+
# Function: pomPath()
|
|
8
|
+
|
|
9
|
+
> **pomPath**(`groupId`, `artifactId`, `version`): `string`
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/release-maven/src/repository.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/repository.ts#L44)
|
|
12
|
+
|
|
13
|
+
The path of the pom of a module at a version in the layout of a Maven repository: the groupId
|
|
14
|
+
of a folder for each part, then the artifactId and the version.
|
|
15
|
+
|
|
16
|
+
## Parameters
|
|
17
|
+
|
|
18
|
+
### groupId
|
|
19
|
+
|
|
20
|
+
`string`
|
|
21
|
+
|
|
22
|
+
The groupId, as `org.acme`.
|
|
23
|
+
|
|
24
|
+
### artifactId
|
|
25
|
+
|
|
26
|
+
`string`
|
|
27
|
+
|
|
28
|
+
The artifactId, as `core`.
|
|
29
|
+
|
|
30
|
+
### version
|
|
31
|
+
|
|
32
|
+
`string`
|
|
33
|
+
|
|
34
|
+
The version, as `1.2.3`.
|
|
35
|
+
|
|
36
|
+
## Returns
|
|
37
|
+
|
|
38
|
+
`string`
|
|
39
|
+
|
|
40
|
+
The path, as `org/acme/core/1.2.3/core-1.2.3.pom`.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / pomUrl
|
|
6
|
+
|
|
7
|
+
# Function: pomUrl()
|
|
8
|
+
|
|
9
|
+
> **pomUrl**(`base`, `groupId`, `artifactId`, `version`): `string`
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/release-maven/src/repository.ts:56](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/repository.ts#L56)
|
|
12
|
+
|
|
13
|
+
The URL of the pom of a module at a version in the repository of `base`.
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
### base
|
|
18
|
+
|
|
19
|
+
`string`
|
|
20
|
+
|
|
21
|
+
The URL of the repository, as `https://repo1.maven.org/maven2`.
|
|
22
|
+
|
|
23
|
+
### groupId
|
|
24
|
+
|
|
25
|
+
`string`
|
|
26
|
+
|
|
27
|
+
The groupId.
|
|
28
|
+
|
|
29
|
+
### artifactId
|
|
30
|
+
|
|
31
|
+
`string`
|
|
32
|
+
|
|
33
|
+
The artifactId.
|
|
34
|
+
|
|
35
|
+
### version
|
|
36
|
+
|
|
37
|
+
`string`
|
|
38
|
+
|
|
39
|
+
The version.
|
|
40
|
+
|
|
41
|
+
## Returns
|
|
42
|
+
|
|
43
|
+
`string`
|
|
44
|
+
|
|
45
|
+
The URL of the pom.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / Repository
|
|
6
|
+
|
|
7
|
+
# Interface: Repository
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/release-maven/src/repository.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/repository.ts#L28)
|
|
10
|
+
|
|
11
|
+
A repository a module deploys to: the `<server>` of settings.xml of its credentials, and its URL.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### id
|
|
16
|
+
|
|
17
|
+
> `readonly` **id**: `string`
|
|
18
|
+
|
|
19
|
+
Defined in: [packages/release-maven/src/repository.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/repository.ts#L30)
|
|
20
|
+
|
|
21
|
+
Its id, which names the `<server>` of settings.xml Maven deploys by.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### url
|
|
26
|
+
|
|
27
|
+
> `readonly` **url**: `string`
|
|
28
|
+
|
|
29
|
+
Defined in: [packages/release-maven/src/repository.ts:32](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/repository.ts#L32)
|
|
30
|
+
|
|
31
|
+
Its URL.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / ValuesOf
|
|
6
|
+
|
|
7
|
+
# Interface: ValuesOf
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/release-maven/src/repository.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/repository.ts#L85)
|
|
10
|
+
|
|
11
|
+
The values a `${…}` of a URL names.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### env
|
|
16
|
+
|
|
17
|
+
> `readonly` **env**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
|
|
18
|
+
|
|
19
|
+
Defined in: [packages/release-maven/src/repository.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/repository.ts#L89)
|
|
20
|
+
|
|
21
|
+
The environment, which `${env.NAME}` names.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### properties
|
|
26
|
+
|
|
27
|
+
> `readonly` **properties**: `ReadonlyMap`\<`string`, `string`\>
|
|
28
|
+
|
|
29
|
+
Defined in: [packages/release-maven/src/repository.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/repository.ts#L87)
|
|
30
|
+
|
|
31
|
+
The properties of the module, of its parents in the repo, its own over theirs.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / MAVEN\_CENTRAL
|
|
6
|
+
|
|
7
|
+
# Variable: MAVEN\_CENTRAL
|
|
8
|
+
|
|
9
|
+
> `const` **MAVEN\_CENTRAL**: `"https://repo1.maven.org/maven2"` = `'https://repo1.maven.org/maven2'`
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/release-maven/src/repository.ts:25](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/repository.ts#L25)
|
|
12
|
+
|
|
13
|
+
Maven Central, as it is read: what the Central Portal publishes is served here.
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
[**Release trains**](../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../README.md) / @wtf/release-maven/stamp
|
|
6
|
+
|
|
7
|
+
# @wtf/release-maven/stamp
|
|
8
|
+
|
|
9
|
+
The versions of the trains written into the poms of a repo, of no XML serializer: the reader of
|
|
10
|
+
`./pom` gives where each element and its text are in the file, and the stamp writes each version
|
|
11
|
+
into the text at its place, so every other byte, the comments, the layout and the line ends, stays
|
|
12
|
+
as it was, and a release commit changes the versions alone. Each module takes the version of its
|
|
13
|
+
train: of the train of the release, the release's; of another train, its last release
|
|
14
|
+
(`releasedVersions` of `@wtf/release-trains/packages`); of no train, none. What it writes, of
|
|
15
|
+
every pom of the repo:
|
|
16
|
+
|
|
17
|
+
- the `<version>` of the project of each module that takes a version, a `${revision}` too;
|
|
18
|
+
- the `<version>` of its `<parent>`, where the parent is a module of the repo that takes a
|
|
19
|
+
version;
|
|
20
|
+
- the `<version>` of each `<dependency>`, wherever the pom holds one (its dependencies, its
|
|
21
|
+
`dependencyManagement`, the dependencies of a plugin, a profile), and of each `<plugin>`, that
|
|
22
|
+
names a module that takes a version, but a range, as `[1.0,2.0)`, which is its author's own.
|
|
23
|
+
|
|
24
|
+
A dependency of no `<version>` is left: it takes the version its `dependencyManagement` gives, which
|
|
25
|
+
is stamped. A module that takes a version and writes no `<version>` of its own takes its parent's,
|
|
26
|
+
so its parent must take the same version: a module of another train than its parent, or whose
|
|
27
|
+
parent is not of the repo, needs a `<version>` of its own (`EMAVENSTAMP`). A module of no train that
|
|
28
|
+
inherits its version moves with its parent.
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
import { stampPom } from '@wtf/release-maven/stamp'
|
|
32
|
+
|
|
33
|
+
const { text } = stampPom(
|
|
34
|
+
'<project>\n <groupId>acme</groupId>\n <artifactId>core</artifactId>\n <!-- the tag is the version -->\n <version>0.0.0-SNAPSHOT</version>\n</project>\n',
|
|
35
|
+
{ groupId: 'acme', version: '1.2.3', parent: undefined, artifacts: new Map() }
|
|
36
|
+
)
|
|
37
|
+
console.log(text)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Interfaces
|
|
41
|
+
|
|
42
|
+
- [PomStampOptions](interfaces/PomStampOptions.md)
|
|
43
|
+
- [Stamped](interfaces/Stamped.md)
|
|
44
|
+
- [StampedModules](interfaces/StampedModules.md)
|
|
45
|
+
|
|
46
|
+
## Functions
|
|
47
|
+
|
|
48
|
+
- [checkVersions](functions/checkVersions.md)
|
|
49
|
+
- [stampModules](functions/stampModules.md)
|
|
50
|
+
- [stampPom](functions/stampPom.md)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/stamp](../README.md) / checkVersions
|
|
6
|
+
|
|
7
|
+
# Function: checkVersions()
|
|
8
|
+
|
|
9
|
+
> **checkVersions**(`modules`, `versions`): `void`
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/release-maven/src/stamp.ts:264](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/stamp.ts#L264)
|
|
12
|
+
|
|
13
|
+
The modules that are not at the version they take, of their poms read again: what a stamp left
|
|
14
|
+
wrong, as a module whose version is of a property the stamp does not write.
|
|
15
|
+
|
|
16
|
+
## Parameters
|
|
17
|
+
|
|
18
|
+
### modules
|
|
19
|
+
|
|
20
|
+
readonly [`MavenModule`](../../interfaces/MavenModule.md)[]
|
|
21
|
+
|
|
22
|
+
The modules, as `readModules` of `./artifacts` gives them after the stamp.
|
|
23
|
+
|
|
24
|
+
### versions
|
|
25
|
+
|
|
26
|
+
`ReadonlyMap`\<`string`, `string`\>
|
|
27
|
+
|
|
28
|
+
The version each module takes, by its name: a module of none is not checked.
|
|
29
|
+
|
|
30
|
+
## Returns
|
|
31
|
+
|
|
32
|
+
`void`
|
|
33
|
+
|
|
34
|
+
## Throws
|
|
35
|
+
|
|
36
|
+
`EMAVENVERSION` of a module at another version.
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/stamp](../README.md) / stampModules
|
|
6
|
+
|
|
7
|
+
# Function: stampModules()
|
|
8
|
+
|
|
9
|
+
> **stampModules**(`system`, `cwd`, `modules`, `versions`): `Promise`\<[`StampedModules`](../interfaces/StampedModules.md)\>
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/release-maven/src/stamp.ts:216](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/stamp.ts#L216)
|
|
12
|
+
|
|
13
|
+
Writes `versions` into the poms of `modules`, as the module says: of each module that takes a
|
|
14
|
+
version, its project's `<version>`, the `<parent>` of each child of it, and each dependency and
|
|
15
|
+
plugin that names it, in every pom of the repo. A module that takes no version, as of no train,
|
|
16
|
+
keeps its own, and what names it is left. A pom of no change is not written.
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
### system
|
|
21
|
+
|
|
22
|
+
[`System`](../../../release-system/system/interfaces/System.md)
|
|
23
|
+
|
|
24
|
+
The system the poms are read and written by.
|
|
25
|
+
|
|
26
|
+
### cwd
|
|
27
|
+
|
|
28
|
+
`string`
|
|
29
|
+
|
|
30
|
+
The folder of the repo.
|
|
31
|
+
|
|
32
|
+
### modules
|
|
33
|
+
|
|
34
|
+
readonly [`MavenModule`](../../interfaces/MavenModule.md)[]
|
|
35
|
+
|
|
36
|
+
The modules of the repo, as `readModules` of `./artifacts` gives them.
|
|
37
|
+
|
|
38
|
+
### versions
|
|
39
|
+
|
|
40
|
+
`ReadonlyMap`\<`string`, `string`\>
|
|
41
|
+
|
|
42
|
+
The version each module takes, by its name: of the modules of the train of the
|
|
43
|
+
release, the release's, and of each other train's, its last release (`releasedVersions` of
|
|
44
|
+
`@wtf/release-trains/packages`).
|
|
45
|
+
|
|
46
|
+
## Returns
|
|
47
|
+
|
|
48
|
+
`Promise`\<[`StampedModules`](../interfaces/StampedModules.md)\>
|
|
49
|
+
|
|
50
|
+
The poms written, and how many values.
|
|
51
|
+
|
|
52
|
+
## Throws
|
|
53
|
+
|
|
54
|
+
`EMAVENSTAMP` of a module that inherits a version its parent does not take, or of a
|
|
55
|
+
version the stamp cannot write, every one of them together.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/stamp](../README.md) / stampPom
|
|
6
|
+
|
|
7
|
+
# Function: stampPom()
|
|
8
|
+
|
|
9
|
+
> **stampPom**(`text`, `options`, `file?`): [`Stamped`](../interfaces/Stamped.md)
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/release-maven/src/stamp.ts:127](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/stamp.ts#L127)
|
|
12
|
+
|
|
13
|
+
The pom `text` with the versions written, as the module says: every byte but those of the
|
|
14
|
+
versions as it was. Idempotent: stamped twice, the second changes nothing.
|
|
15
|
+
|
|
16
|
+
## Parameters
|
|
17
|
+
|
|
18
|
+
### text
|
|
19
|
+
|
|
20
|
+
`string`
|
|
21
|
+
|
|
22
|
+
The pom.xml.
|
|
23
|
+
|
|
24
|
+
### options
|
|
25
|
+
|
|
26
|
+
[`PomStampOptions`](../interfaces/PomStampOptions.md)
|
|
27
|
+
|
|
28
|
+
The groupId of the module, the version of its project and of its parent, and the
|
|
29
|
+
version of each module of the repo that takes one.
|
|
30
|
+
|
|
31
|
+
### file?
|
|
32
|
+
|
|
33
|
+
`string` = `'pom.xml'`
|
|
34
|
+
|
|
35
|
+
The pom, as an error names it.
|
|
36
|
+
|
|
37
|
+
## Returns
|
|
38
|
+
|
|
39
|
+
[`Stamped`](../interfaces/Stamped.md)
|
|
40
|
+
|
|
41
|
+
The pom stamped, and the count of values it wrote.
|
|
42
|
+
|
|
43
|
+
## Throws
|
|
44
|
+
|
|
45
|
+
`EMAVENPOM` of a pom that is no XML, `EMAVENSTAMP` of a version the stamp cannot write.
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/stamp](../README.md) / PomStampOptions
|
|
6
|
+
|
|
7
|
+
# Interface: PomStampOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/release-maven/src/stamp.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/stamp.ts#L46)
|
|
10
|
+
|
|
11
|
+
What to write into a pom.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### artifacts
|
|
16
|
+
|
|
17
|
+
> `readonly` **artifacts**: `ReadonlyMap`\<`string`, `string`\>
|
|
18
|
+
|
|
19
|
+
Defined in: [packages/release-maven/src/stamp.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/stamp.ts#L54)
|
|
20
|
+
|
|
21
|
+
The version of each module of the repo that takes one, by its name, `groupId:artifactId`.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### groupId
|
|
26
|
+
|
|
27
|
+
> `readonly` **groupId**: `string`
|
|
28
|
+
|
|
29
|
+
Defined in: [packages/release-maven/src/stamp.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/stamp.ts#L48)
|
|
30
|
+
|
|
31
|
+
The groupId of the module, which `${project.groupId}` of a dependency names.
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### parent
|
|
36
|
+
|
|
37
|
+
> `readonly` **parent**: `string` \| `undefined`
|
|
38
|
+
|
|
39
|
+
Defined in: [packages/release-maven/src/stamp.ts:52](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/stamp.ts#L52)
|
|
40
|
+
|
|
41
|
+
The version of its `<parent>`, of a parent of the repo that takes one: none, it is left.
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### version
|
|
46
|
+
|
|
47
|
+
> `readonly` **version**: `string` \| `undefined`
|
|
48
|
+
|
|
49
|
+
Defined in: [packages/release-maven/src/stamp.ts:50](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/stamp.ts#L50)
|
|
50
|
+
|
|
51
|
+
The version of the project, of a module that takes one: none, it is left.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/stamp](../README.md) / Stamped
|
|
6
|
+
|
|
7
|
+
# Interface: Stamped
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/release-maven/src/stamp.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/stamp.ts#L58)
|
|
10
|
+
|
|
11
|
+
A pom stamped, and how many values it wrote.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### changes
|
|
16
|
+
|
|
17
|
+
> `readonly` **changes**: `number`
|
|
18
|
+
|
|
19
|
+
Defined in: [packages/release-maven/src/stamp.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/stamp.ts#L62)
|
|
20
|
+
|
|
21
|
+
The values that were another, and are of the versions now.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### text
|
|
26
|
+
|
|
27
|
+
> `readonly` **text**: `string`
|
|
28
|
+
|
|
29
|
+
Defined in: [packages/release-maven/src/stamp.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/stamp.ts#L60)
|
|
30
|
+
|
|
31
|
+
The pom, the versions written.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**Release trains**](../../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../../README.md) / [@wtf/release-maven/stamp](../README.md) / StampedModules
|
|
6
|
+
|
|
7
|
+
# Interface: StampedModules
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/release-maven/src/stamp.ts:164](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/stamp.ts#L164)
|
|
10
|
+
|
|
11
|
+
The result of stamping the poms of a repo: the poms written, and the values in them.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### changes
|
|
16
|
+
|
|
17
|
+
> `readonly` **changes**: `number`
|
|
18
|
+
|
|
19
|
+
Defined in: [packages/release-maven/src/stamp.ts:168](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/stamp.ts#L168)
|
|
20
|
+
|
|
21
|
+
The values written.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### files
|
|
26
|
+
|
|
27
|
+
> `readonly` **files**: readonly `string`[]
|
|
28
|
+
|
|
29
|
+
Defined in: [packages/release-maven/src/stamp.ts:166](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/stamp.ts#L166)
|
|
30
|
+
|
|
31
|
+
The poms whose text changed, from the root of the repo.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **checkPackages**(`packages`, `options?`): [`Issue`](../interfaces/Issue.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/check.ts:147](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/check.ts:147](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-npm/src/check.ts#L147)
|
|
12
12
|
|
|
13
13
|
The faults of `packages`, the packages of a train that publish, as each would publish: those of
|
|
14
14
|
each alone, a dependency of one on a private package of `workspace`, and those of the order of
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **formatIssue**(`issue`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/check.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/check.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-npm/src/check.ts#L74)
|
|
12
12
|
|
|
13
13
|
A fault, as one line: its folder, its package's name, and what it is.
|
|
14
14
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: CheckOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/check.ts:55](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/check.ts:55](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-npm/src/check.ts#L55)
|
|
10
10
|
|
|
11
11
|
What is checked.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ What is checked.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` `optional` **access?**: `"public"` \| `"restricted"`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-npm/src/check.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-npm/src/check.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-npm/src/check.ts#L63)
|
|
20
20
|
|
|
21
21
|
The access every package publishes with, of the option, over each one's own.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ The access every package publishes with, of the option, over each one's own.
|
|
|
26
26
|
|
|
27
27
|
> `readonly` `optional` **conditions?**: readonly `string`[]
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-npm/src/check.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-npm/src/check.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-npm/src/check.ts#L65)
|
|
30
30
|
|
|
31
31
|
The export conditions of the source: `['source']`.
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ The export conditions of the source: `['source']`.
|
|
|
36
36
|
|
|
37
37
|
> `readonly` `optional` **faults?**: readonly [`OrderFault`](../../../release-trains/packages/interfaces/OrderFault.md)[]
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/release-npm/src/check.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
39
|
+
Defined in: [packages/release-npm/src/check.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-npm/src/check.ts#L59)
|
|
40
40
|
|
|
41
41
|
What is wrong with the order of publishing, as `publishOrder` found it.
|
|
42
42
|
|
|
@@ -46,7 +46,7 @@ What is wrong with the order of publishing, as `publishOrder` found it.
|
|
|
46
46
|
|
|
47
47
|
> `readonly` `optional` **prepared?**: `boolean`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/release-npm/src/check.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
49
|
+
Defined in: [packages/release-npm/src/check.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-npm/src/check.ts#L57)
|
|
50
50
|
|
|
51
51
|
Whether the packages are prepared, as they are about to publish: `true`.
|
|
52
52
|
|
|
@@ -56,6 +56,6 @@ Whether the packages are prepared, as they are about to publish: `true`.
|
|
|
56
56
|
|
|
57
57
|
> `readonly` `optional` **workspace?**: readonly [`CheckedPackage`](../type-aliases/CheckedPackage.md)[]
|
|
58
58
|
|
|
59
|
-
Defined in: [packages/release-npm/src/check.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
59
|
+
Defined in: [packages/release-npm/src/check.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-npm/src/check.ts#L61)
|
|
60
60
|
|
|
61
61
|
Every package of the workspace, private ones too, as a dependency is found among them.
|