@wtf/release-docs 9.0.2 → 10.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -4
- package/api/.generated +291 -141
- package/api/@wtf/release/README.md +55 -0
- package/api/@wtf/release/contract/README.md +60 -0
- package/api/@wtf/release/contract/interfaces/Plan.md +46 -0
- package/api/@wtf/release/contract/interfaces/Release.md +96 -0
- package/api/@wtf/release/contract/interfaces/ReleaseSteps.md +203 -0
- package/api/@wtf/release/contract/type-aliases/OptionalStep.md +13 -0
- package/api/@wtf/release/contract/type-aliases/ReleasingEcosystem.md +44 -0
- package/api/@wtf/release/driver/README.md +43 -0
- package/api/@wtf/release/driver/functions/runStep.md +50 -0
- package/api/@wtf/release/driver/interfaces/StepOutcome.md +31 -0
- package/api/@wtf/release/driver/type-aliases/EcosystemsOf.md +14 -0
- package/api/@wtf/release/driver/type-aliases/Step.md +13 -0
- package/api/@wtf/release/driver/variables/STEPS.md +13 -0
- package/api/@wtf/{release-trains → release}/ecosystem/README.md +11 -11
- package/api/@wtf/release/ecosystem/functions/isEcosystem.md +27 -0
- package/api/@wtf/{release-trains → release}/ecosystem/functions/loadEcosystems.md +5 -5
- package/api/@wtf/release/ecosystem/functions/readPackages.md +33 -0
- package/api/@wtf/release/ecosystem/interfaces/Dependency.md +43 -0
- package/api/@wtf/{release-trains → release}/ecosystem/interfaces/Ecosystem.md +23 -14
- package/api/@wtf/release/ecosystem/interfaces/EcosystemContext.md +56 -0
- package/api/@wtf/release/ecosystem/interfaces/EcosystemPackages.md +35 -0
- package/api/@wtf/release/ecosystem/interfaces/Package.md +71 -0
- package/api/@wtf/release/ecosystem/type-aliases/DependencyKind.md +16 -0
- package/api/@wtf/{release-trains → release}/ecosystem/type-aliases/ModuleLoader.md +2 -2
- package/api/@wtf/release/ecosystem/variables/DEPENDENCY_KINDS.md +13 -0
- package/api/@wtf/release/errors/README.md +41 -0
- package/api/@wtf/{release-system → release}/errors/classes/ReleaseError.md +11 -19
- package/api/@wtf/release/errors/functions/isReleaseError.md +28 -0
- package/api/@wtf/release/errors/functions/throwAll.md +26 -0
- package/api/@wtf/{release-system → release}/errors/type-aliases/ErrorClass.md +2 -2
- package/api/@wtf/release/errors/type-aliases/ReleaseErrorCode.md +13 -0
- package/api/@wtf/release/errors/variables/RELEASE_ERRORS.md +35 -0
- package/api/@wtf/release/files/README.md +38 -0
- package/api/@wtf/release/files/functions/copy.md +45 -0
- package/api/@wtf/release/files/functions/exists.md +33 -0
- package/api/@wtf/release/files/functions/makeDir.md +33 -0
- package/api/@wtf/release/files/functions/readBytes.md +33 -0
- package/api/@wtf/release/files/functions/readDir.md +33 -0
- package/api/@wtf/release/files/functions/readFile.md +33 -0
- package/api/@wtf/release/files/functions/remove.md +34 -0
- package/api/@wtf/release/files/functions/writeFile.md +38 -0
- package/api/@wtf/release/files/interfaces/DirEntry.md +27 -0
- package/api/@wtf/release/forge/README.md +49 -0
- package/api/@wtf/release/forge/functions/linksOf.md +49 -0
- package/api/@wtf/release/forge/interfaces/Forge.md +113 -0
- package/api/@wtf/release/forge/interfaces/ForgeRun.md +41 -0
- package/api/@wtf/release/forge/interfaces/LinksOptions.md +43 -0
- package/api/@wtf/release/forge/interfaces/PackageRegistry.md +41 -0
- package/api/@wtf/release/forge/interfaces/ReleaseLink.md +41 -0
- package/api/@wtf/release/forge/interfaces/Released.md +91 -0
- package/api/@wtf/{release-trains → release}/generated/README.md +8 -8
- package/api/@wtf/{release-trains → release}/generated/functions/filesIn.md +4 -4
- package/api/@wtf/{release-trains → release}/generated/functions/formatGenerated.md +2 -2
- package/api/@wtf/release/generated/functions/listGenerated.md +35 -0
- package/api/@wtf/{release-trains → release}/generated/functions/parseGenerated.md +2 -2
- package/api/@wtf/release/generated/functions/readGenerated.md +33 -0
- package/api/@wtf/{release-trains → release}/generated/functions/stageGenerated.md +2 -2
- package/api/@wtf/release/generated/functions/stageGeneratedFolders.md +29 -0
- package/api/@wtf/release/generated/functions/unlistedIn.md +36 -0
- package/api/@wtf/release/generated/interfaces/GeneratedOptions.md +21 -0
- package/api/@wtf/release/generated/interfaces/StageOptions.md +76 -0
- package/api/@wtf/release/generated/variables/GENERATED.md +13 -0
- package/api/@wtf/{release-system → release}/git/README.md +11 -10
- package/api/@wtf/{release-system → release}/git/functions/commitsSince.md +3 -3
- package/api/@wtf/{release-system → release}/git/functions/filesOfCommits.md +3 -3
- package/api/@wtf/{release-system → release}/git/functions/git.md +3 -3
- package/api/@wtf/release/git/functions/revisionOf.md +33 -0
- package/api/@wtf/release/git/functions/tagsOfRepo.md +33 -0
- package/api/@wtf/{release-system → release}/git/functions/trackedFiles.md +3 -3
- package/api/@wtf/release/git/interfaces/GitContext.md +26 -0
- package/api/@wtf/release/git/interfaces/LogCommit.md +43 -0
- package/api/@wtf/release/interfaces/RepoContext.md +57 -0
- package/api/@wtf/release/order/README.md +37 -0
- package/api/@wtf/{release-trains/packages → release/order}/functions/normalizeDir.md +2 -2
- package/api/@wtf/{release-trains/packages → release/order}/functions/publishOrder.md +7 -6
- package/api/@wtf/release/order/interfaces/OrderFault.md +39 -0
- package/api/@wtf/release/order/interfaces/OrderPins.md +27 -0
- package/api/@wtf/release/order/interfaces/PublishOrder.md +35 -0
- package/api/@wtf/{release-system → release}/paths/README.md +4 -4
- package/api/@wtf/{release-system → release}/paths/functions/normalizePath.md +2 -2
- package/api/@wtf/{release-system → release}/paths/functions/pathMatcher.md +2 -2
- package/api/@wtf/{release-system → release}/paths/type-aliases/PathMatcher.md +2 -2
- package/api/@wtf/{release-system → release}/posix/README.md +5 -5
- package/api/@wtf/{release-system → release}/posix/functions/basenameOf.md +2 -2
- package/api/@wtf/{release-system → release}/posix/functions/dirnameOf.md +2 -2
- package/api/@wtf/{release-system → release}/posix/functions/joinPath.md +2 -2
- package/api/@wtf/{release-system → release}/posix/functions/relativePath.md +2 -2
- package/api/@wtf/{release-system → release}/posix/functions/resolvePath.md +3 -3
- package/api/@wtf/release/process/README.md +30 -0
- package/api/@wtf/release/process/functions/envOf.md +34 -0
- package/api/@wtf/release/process/functions/run.md +48 -0
- package/api/@wtf/release/process/interfaces/RunOptions.md +52 -0
- package/api/@wtf/release/process/interfaces/RunResult.md +35 -0
- package/api/@wtf/release/type-aliases/ReleasePlatform.md +22 -0
- package/api/@wtf/release/type-aliases/RepoPlatform.md +21 -0
- package/api/@wtf/{release-system → release}/validator/README.md +6 -5
- package/api/@wtf/{release-system → release}/validator/functions/allOf.md +2 -2
- package/api/@wtf/{release-system → release}/validator/functions/anyObject.md +3 -3
- package/api/@wtf/{release-system → release}/validator/functions/anyOf.md +2 -2
- package/api/@wtf/{release-system → release}/validator/functions/arrayOf.md +2 -2
- package/api/@wtf/{release-system → release}/validator/functions/booleanOf.md +2 -2
- package/api/@wtf/{release-system → release}/validator/functions/errorOf.md +2 -2
- package/api/@wtf/{release-system → release}/validator/functions/errorsOf.md +2 -2
- package/api/@wtf/{release-system → release}/validator/functions/exclusive.md +2 -2
- package/api/@wtf/release/validator/functions/issueOf.md +45 -0
- package/api/@wtf/{release-system → release}/validator/functions/issuesOf.md +2 -2
- package/api/@wtf/{release-system → release}/validator/functions/objectOf.md +2 -2
- package/api/@wtf/{release-system → release}/validator/functions/oneOf.md +2 -2
- package/api/@wtf/{release-system → release}/validator/functions/orFunction.md +2 -2
- package/api/@wtf/{release-system → release}/validator/functions/pathText.md +2 -2
- package/api/@wtf/{release-system → release}/validator/functions/recordOf.md +2 -2
- package/api/@wtf/{release-system → release}/validator/functions/refined.md +2 -2
- package/api/@wtf/{release-system → release}/validator/functions/stringOf.md +2 -2
- package/api/@wtf/{release-system → release}/validator/functions/tupleOf.md +2 -2
- package/api/@wtf/release/validator/functions/validatorOf.md +42 -0
- package/api/@wtf/{release-system → release}/validator/interfaces/ArrayOptions.md +6 -6
- package/api/@wtf/{release-system → release}/validator/interfaces/IssueOptions.md +5 -5
- package/api/@wtf/{release-system → release}/validator/interfaces/ObjectOptions.md +6 -6
- package/api/@wtf/release/validator/interfaces/OptionIssue.md +63 -0
- package/api/@wtf/release/validator/interfaces/Property.md +49 -0
- package/api/@wtf/{release-system → release}/validator/interfaces/RecordOptions.md +7 -7
- package/api/@wtf/{release-system → release}/validator/interfaces/StringOptions.md +7 -7
- package/api/@wtf/{release-system → release}/validator/interfaces/Validator.md +5 -5
- package/api/@wtf/release/validator/type-aliases/JsonSchema.md +17 -0
- package/api/@wtf/release/validator/type-aliases/Path.md +13 -0
- package/api/@wtf/release-cargo/README.md +11 -8
- package/api/@wtf/release-cargo/auth/README.md +1 -1
- 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 +3 -3
- package/api/@wtf/release-cargo/crates/README.md +11 -10
- 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 +9 -8
- package/api/@wtf/release-cargo/crates/functions/selectCrates.md +16 -16
- package/api/@wtf/release-cargo/crates/functions/selects.md +36 -0
- package/api/@wtf/release-cargo/crates/interfaces/Selection.md +15 -15
- package/api/@wtf/release-cargo/ecosystem/README.md +9 -6
- package/api/@wtf/release-cargo/ecosystem/functions/packagesAt.md +6 -6
- package/api/@wtf/release-cargo/ecosystem/functions/packagesOfTree.md +3 -3
- package/api/@wtf/release-cargo/ecosystem/functions/packagesOfWorkspace.md +2 -2
- 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 +17 -17
- package/api/@wtf/release-cargo/ecosystem/variables/cargoEcosystem.md +6 -4
- package/api/@wtf/release-cargo/errors/README.md +4 -5
- package/api/@wtf/release-cargo/errors/classes/CargoError.md +18 -33
- package/api/@wtf/release-cargo/errors/type-aliases/CargoErrorCode.md +1 -1
- package/api/@wtf/release-cargo/errors/variables/CARGO_ERRORS.md +8 -4
- 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/README.md +4 -5
- package/api/@wtf/release-cargo/publish/functions/publishCrates.md +5 -4
- package/api/@wtf/release-cargo/publish/interfaces/PublishCratesOptions.md +33 -20
- 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/README.md +5 -3
- 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/indexLookup.md +50 -0
- 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/release/README.md +54 -0
- package/api/@wtf/release-cargo/release/functions/prepareCrates.md +42 -0
- package/api/@wtf/release-cargo/release/functions/publishPlan.md +53 -0
- package/api/@wtf/release-cargo/release/functions/publishedOf.md +36 -0
- package/api/@wtf/release-cargo/release/functions/verifyCrates.md +44 -0
- package/api/@wtf/release-cargo/release/interfaces/CargoOptions.md +89 -0
- package/api/@wtf/release-cargo/release/type-aliases/CargoPlan.md +13 -0
- package/api/@wtf/release-cargo/stamp/README.md +6 -5
- 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 +19 -10
- package/api/@wtf/release-cargo/stamp/interfaces/StampOptions.md +4 -4
- package/api/@wtf/release-cargo/stamp/interfaces/StampWorkspaceOptions.md +21 -0
- package/api/@wtf/release-cargo/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-cargo/stamp/interfaces/StampedWorkspace.md +4 -4
- package/api/@wtf/release-cargo/type-aliases/DependencyKind.md +1 -1
- package/api/@wtf/release-go/README.md +13 -9
- package/api/@wtf/release-go/ecosystem/README.md +13 -6
- package/api/@wtf/release-go/ecosystem/functions/packagesOfModules.md +2 -2
- package/api/@wtf/release-go/ecosystem/functions/packagesOfRepo.md +4 -4
- package/api/@wtf/release-go/ecosystem/functions/resolveVersion.md +2 -2
- package/api/@wtf/release-go/ecosystem/functions/satisfiesVersion.md +1 -1
- package/api/@wtf/release-go/ecosystem/interfaces/GoPackage.md +17 -17
- package/api/@wtf/release-go/ecosystem/variables/goEcosystem.md +6 -3
- package/api/@wtf/release-go/errors/README.md +4 -5
- package/api/@wtf/release-go/errors/classes/GoError.md +17 -32
- package/api/@wtf/release-go/errors/type-aliases/GoErrorCode.md +1 -1
- package/api/@wtf/release-go/errors/variables/GO_ERRORS.md +8 -4
- package/api/@wtf/release-go/gomod/functions/entriesOf.md +1 -1
- package/api/@wtf/release-go/gomod/functions/linesOf.md +1 -1
- package/api/@wtf/release-go/gomod/functions/readGoMod.md +1 -1
- package/api/@wtf/release-go/gomod/functions/tokensOf.md +1 -1
- package/api/@wtf/release-go/gomod/interfaces/Entry.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/GoMod.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/GoReplace.md +6 -6
- package/api/@wtf/release-go/gomod/interfaces/GoRequire.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/Token.md +5 -5
- package/api/@wtf/release-go/interfaces/GoIdentity.md +31 -0
- package/api/@wtf/release-go/interfaces/GoModule.md +6 -6
- package/api/@wtf/release-go/interfaces/GoOptions.md +86 -0
- package/api/@wtf/release-go/modules/README.md +9 -9
- package/api/@wtf/release-go/modules/functions/isFetchable.md +1 -1
- package/api/@wtf/release-go/modules/functions/isGoMod.md +1 -1
- package/api/@wtf/release-go/modules/functions/majorErrors.md +1 -1
- package/api/@wtf/release-go/modules/functions/majorOfPath.md +1 -1
- package/api/@wtf/release-go/modules/functions/modulesAt.md +3 -3
- package/api/@wtf/release-go/modules/functions/modulesOf.md +1 -1
- package/api/@wtf/release-go/modules/functions/readModules.md +4 -5
- package/api/@wtf/release-go/modules/functions/selectModules.md +13 -11
- package/api/@wtf/release-go/modules/interfaces/Selection.md +10 -11
- package/api/@wtf/release-go/release/README.md +45 -0
- package/api/@wtf/release-go/release/functions/isGoVersion.md +28 -0
- package/api/@wtf/release-go/release/functions/prepareModules.md +47 -0
- package/api/@wtf/release-go/release/functions/publishModules.md +54 -0
- package/api/@wtf/release-go/release/functions/releaseModules.md +48 -0
- package/api/@wtf/release-go/release/functions/releasedOf.md +41 -0
- package/api/@wtf/release-go/release/functions/verifyModules.md +44 -0
- package/api/@wtf/release-go/release/interfaces/ReleaseModules.md +31 -0
- package/api/@wtf/release-go/stamp/README.md +6 -5
- package/api/@wtf/release-go/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-go/stamp/functions/stampGoMod.md +1 -1
- package/api/@wtf/release-go/stamp/functions/stampModules.md +16 -10
- package/api/@wtf/release-go/stamp/interfaces/StampOptions.md +21 -0
- package/api/@wtf/release-go/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-go/stamp/interfaces/StampedModules.md +13 -3
- package/api/@wtf/release-go/tags/README.md +3 -6
- package/api/@wtf/release-go/tags/functions/askProxy.md +6 -6
- package/api/@wtf/release-go/tags/functions/maskCredentials.md +1 -1
- package/api/@wtf/release-go/tags/functions/releaseCommit.md +16 -9
- package/api/@wtf/release-go/tags/functions/remoteTags.md +3 -3
- package/api/@wtf/release-go/tags/functions/tagModules.md +3 -3
- package/api/@wtf/release-go/tags/functions/tagOfModule.md +1 -1
- package/api/@wtf/release-go/tags/functions/tagPrefix.md +1 -1
- package/api/@wtf/release-go/tags/interfaces/CommitIdentity.md +35 -0
- package/api/@wtf/release-go/tags/interfaces/TagModulesOptions.md +42 -10
- package/api/@wtf/release-go/tags/interfaces/TaggedModule.md +5 -5
- package/api/@wtf/release-go/tags/interfaces/TagsContext.md +22 -0
- package/api/@wtf/release-go/tags/type-aliases/ModuleStatus.md +1 -1
- package/api/@wtf/release-maven/README.md +11 -8
- package/api/@wtf/release-maven/artifacts/README.md +11 -6
- package/api/@wtf/release-maven/artifacts/functions/groupIdOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/installsOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/isPomFile.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/isRange.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/modulesOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/nameOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/publishOrder.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/readModules.md +3 -3
- package/api/@wtf/release-maven/artifacts/functions/readPoms.md +4 -4
- package/api/@wtf/release-maven/artifacts/functions/selectArtifacts.md +1 -1
- package/api/@wtf/release-maven/artifacts/interfaces/Selection.md +8 -8
- package/api/@wtf/release-maven/ecosystem/README.md +28 -13
- package/api/@wtf/release-maven/ecosystem/functions/checkReleaseVersion.md +32 -0
- package/api/@wtf/release-maven/ecosystem/functions/compareVersions.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/parseRange.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/resolveVersion.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/satisfiesVersion.md +1 -1
- package/api/@wtf/release-maven/ecosystem/interfaces/Bound.md +3 -3
- package/api/@wtf/release-maven/ecosystem/interfaces/MavenReleaseOptions.md +77 -0
- package/api/@wtf/release-maven/ecosystem/interfaces/Restriction.md +3 -3
- package/api/@wtf/release-maven/ecosystem/variables/mavenEcosystem.md +5 -3
- package/api/@wtf/release-maven/errors/README.md +3 -4
- package/api/@wtf/release-maven/errors/classes/MavenError.md +17 -32
- package/api/@wtf/release-maven/errors/type-aliases/MavenErrorCode.md +1 -1
- package/api/@wtf/release-maven/errors/variables/MAVEN_ERRORS.md +4 -4
- package/api/@wtf/release-maven/interfaces/MavenModule.md +24 -24
- package/api/@wtf/release-maven/pom/functions/childOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/childrenOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/dependencyOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/escapeXml.md +1 -1
- package/api/@wtf/release-maven/pom/functions/parseXml.md +1 -1
- package/api/@wtf/release-maven/pom/functions/readPom.md +1 -1
- package/api/@wtf/release-maven/pom/functions/textAt.md +1 -1
- package/api/@wtf/release-maven/pom/interfaces/Pom.md +15 -15
- package/api/@wtf/release-maven/pom/interfaces/PomDependency.md +5 -5
- package/api/@wtf/release-maven/pom/interfaces/PomParent.md +4 -4
- package/api/@wtf/release-maven/pom/interfaces/PomPlugin.md +5 -5
- package/api/@wtf/release-maven/pom/interfaces/PomRepository.md +3 -3
- package/api/@wtf/release-maven/pom/interfaces/Span.md +3 -3
- package/api/@wtf/release-maven/pom/interfaces/XmlElement.md +7 -7
- package/api/@wtf/release-maven/pom/variables/PLUGIN_GROUP.md +1 -1
- package/api/@wtf/release-maven/publish/README.md +9 -6
- package/api/@wtf/release-maven/publish/functions/deployModules.md +2 -2
- package/api/@wtf/release-maven/publish/functions/releasedModules.md +44 -0
- package/api/@wtf/release-maven/publish/interfaces/DeployModulesOptions.md +18 -27
- package/api/@wtf/release-maven/publish/interfaces/DeployedModule.md +4 -4
- package/api/@wtf/release-maven/publish/interfaces/ReleasedWhere.md +67 -0
- package/api/@wtf/release-maven/publish/type-aliases/ModuleStatus.md +1 -1
- package/api/@wtf/release-maven/repository/README.md +12 -6
- package/api/@wtf/release-maven/repository/functions/deployTargets.md +1 -1
- package/api/@wtf/release-maven/repository/functions/expandValues.md +1 -1
- package/api/@wtf/release-maven/repository/functions/hasPom.md +1 -1
- package/api/@wtf/release-maven/repository/functions/lookupHeaders.md +37 -0
- package/api/@wtf/release-maven/repository/functions/lookupPom.md +44 -0
- package/api/@wtf/release-maven/repository/functions/pomPath.md +1 -1
- package/api/@wtf/release-maven/repository/functions/pomUrl.md +1 -1
- package/api/@wtf/release-maven/repository/functions/releaseTargets.md +46 -0
- package/api/@wtf/release-maven/repository/interfaces/LookupAuth.md +32 -0
- package/api/@wtf/release-maven/repository/interfaces/ReleaseTargets.md +32 -0
- package/api/@wtf/release-maven/repository/interfaces/Repository.md +3 -3
- package/api/@wtf/release-maven/repository/interfaces/ValuesOf.md +3 -3
- package/api/@wtf/release-maven/repository/variables/MAVEN_CENTRAL.md +1 -1
- package/api/@wtf/release-maven/stamp/README.md +8 -8
- package/api/@wtf/release-maven/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-maven/stamp/functions/stampModules.md +15 -15
- package/api/@wtf/release-maven/stamp/functions/stampPom.md +1 -1
- package/api/@wtf/release-maven/stamp/interfaces/PomStampOptions.md +5 -5
- package/api/@wtf/release-maven/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-maven/stamp/interfaces/StampedModules.md +4 -4
- package/api/@wtf/release-npm/README.md +20 -15
- package/api/@wtf/release-npm/check/README.md +1 -1
- package/api/@wtf/release-npm/check/functions/checkPackages.md +3 -3
- package/api/@wtf/release-npm/check/functions/formatIssue.md +1 -1
- package/api/@wtf/release-npm/check/interfaces/CheckOptions.md +7 -7
- package/api/@wtf/release-npm/check/interfaces/Issue.md +6 -6
- package/api/@wtf/release-npm/check/type-aliases/CheckedPackage.md +1 -1
- package/api/@wtf/release-npm/check/type-aliases/IssueCode.md +2 -2
- package/api/@wtf/release-npm/ecosystem/README.md +21 -11
- package/api/@wtf/release-npm/ecosystem/variables/npmEcosystem.md +17 -7
- package/api/@wtf/release-npm/errors/README.md +8 -4
- package/api/@wtf/release-npm/errors/classes/NpmError.md +253 -0
- package/api/@wtf/release-npm/errors/type-aliases/NpmErrorCode.md +1 -1
- package/api/@wtf/release-npm/errors/variables/NPM_ERRORS.md +7 -3
- package/api/@wtf/release-npm/interfaces/Lookup.md +3 -3
- package/api/@wtf/release-npm/interfaces/NpmAside.md +46 -0
- package/api/@wtf/release-npm/interfaces/NpmOptions.md +134 -0
- 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/Publisher.md +11 -11
- package/api/@wtf/release-npm/interfaces/PublisherContext.md +32 -23
- package/api/@wtf/release-npm/manifests/README.md +5 -5
- package/api/@wtf/release-npm/manifests/functions/concreteRange.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/manifestsAt.md +3 -4
- 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 +7 -7
- 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 +16 -16
- 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 +2 -2
- 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 +6 -6
- package/api/@wtf/release-npm/prepare/interfaces/PreparedManifest.md +6 -6
- package/api/@wtf/release-npm/prepare/variables/SOURCE_CONDITIONS.md +1 -1
- package/api/@wtf/release-npm/publishers/README.md +1 -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/functions/registryOf.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/README.md +59 -37
- package/api/@wtf/release-npm/release/functions/checkPlan.md +44 -0
- package/api/@wtf/release-npm/release/functions/discardPacked.md +32 -0
- package/api/@wtf/release-npm/release/functions/moveRelease.md +47 -0
- package/api/@wtf/release-npm/release/functions/packRelease.md +39 -0
- package/api/@wtf/release-npm/release/functions/prepareRelease.md +46 -0
- package/api/@wtf/release-npm/release/functions/publishPacked.md +17 -11
- package/api/@wtf/release-npm/release/functions/publishRelease.md +44 -0
- package/api/@wtf/release-npm/release/functions/publishedOf.md +12 -11
- package/api/@wtf/release-npm/release/functions/resolvePlan.md +49 -0
- package/api/@wtf/release-npm/release/functions/smokeRelease.md +40 -0
- package/api/@wtf/release-npm/release/functions/verifyRelease.md +41 -0
- package/api/@wtf/release-npm/release/interfaces/MovedPackage.md +79 -0
- package/api/@wtf/release-npm/release/interfaces/MovedRelease.md +39 -0
- package/api/@wtf/release-npm/release/interfaces/NpmPlan.md +68 -0
- package/api/@wtf/release-npm/release/interfaces/PackOptions.md +35 -31
- package/api/@wtf/release-npm/release/interfaces/PackedRelease.md +107 -0
- package/api/@wtf/release-npm/release/interfaces/PublishRun.md +35 -50
- package/api/@wtf/release-npm/release/interfaces/PublishedOf.md +4 -14
- package/api/@wtf/release-npm/release/interfaces/PublishedPackage.md +13 -14
- package/api/@wtf/release-npm/release/interfaces/PublishedRelease.md +49 -0
- package/api/@wtf/release-npm/release/interfaces/ResolvedPackage.md +4 -4
- package/api/@wtf/release-npm/release/interfaces/ResolvedRelease.md +37 -0
- package/api/@wtf/release-npm/release/type-aliases/LookedUpRelease.md +13 -0
- 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/release/variables/npmOptionsSchema.md +13 -0
- package/api/@wtf/release-npm/workspace/README.md +7 -3
- 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 +3 -9
- package/api/@wtf/release-npm/workspace/functions/workspaceFolders.md +3 -9
- package/api/@wtf/release-npm/workspace/functions/workspaceGlobs.md +3 -9
- package/api/@wtf/release-npm/workspace/interfaces/WorkspaceGlobs.md +3 -3
- package/api/@wtf/release-oci/README.md +38 -0
- package/api/@wtf/release-oci/ecosystem/README.md +56 -0
- package/api/@wtf/release-oci/ecosystem/functions/packagesOfImages.md +29 -0
- package/api/@wtf/release-oci/ecosystem/functions/packagesOfRepo.md +32 -0
- package/api/@wtf/release-oci/ecosystem/functions/repositoriesOf.md +27 -0
- package/api/@wtf/release-oci/ecosystem/functions/resolveTag.md +35 -0
- package/api/@wtf/release-oci/ecosystem/functions/satisfiesTag.md +34 -0
- package/api/@wtf/release-oci/ecosystem/interfaces/OciOptions.md +64 -0
- package/api/@wtf/release-oci/ecosystem/interfaces/OciPackage.md +97 -0
- package/api/@wtf/release-oci/ecosystem/interfaces/OciSourceOptions.md +32 -0
- package/api/@wtf/release-oci/ecosystem/variables/ociEcosystem.md +29 -0
- package/api/@wtf/release-oci/errors/README.md +24 -0
- package/api/@wtf/release-oci/errors/classes/OciError.md +253 -0
- package/api/@wtf/release-oci/errors/type-aliases/OciErrorCode.md +13 -0
- package/api/@wtf/release-oci/errors/variables/OCI_ERRORS.md +51 -0
- package/api/@wtf/release-oci/images/README.md +35 -0
- package/api/@wtf/release-oci/images/functions/imageDirOf.md +28 -0
- package/api/@wtf/release-oci/images/functions/imagesAt.md +44 -0
- package/api/@wtf/release-oci/images/functions/imagesOf.md +34 -0
- package/api/@wtf/release-oci/images/functions/isImageManifest.md +27 -0
- package/api/@wtf/release-oci/images/functions/readImages.md +34 -0
- package/api/@wtf/release-oci/images/functions/registryImageOf.md +28 -0
- package/api/@wtf/release-oci/images/functions/repositoryOf.md +35 -0
- package/api/@wtf/release-oci/interfaces/OciImage.md +44 -0
- package/api/@wtf/release-oci/publish/README.md +65 -0
- package/api/@wtf/release-oci/publish/functions/digestOf.md +38 -0
- package/api/@wtf/release-oci/publish/functions/moveImages.md +32 -0
- package/api/@wtf/release-oci/publish/functions/platformsOf.md +44 -0
- package/api/@wtf/release-oci/publish/functions/publishImages.md +32 -0
- package/api/@wtf/release-oci/publish/functions/smokeImages.md +41 -0
- package/api/@wtf/release-oci/publish/interfaces/CraneContext.md +40 -0
- package/api/@wtf/release-oci/publish/interfaces/ImageToPublish.md +35 -0
- package/api/@wtf/release-oci/publish/interfaces/ImagesMove.md +84 -0
- package/api/@wtf/release-oci/publish/interfaces/ImagesRelease.md +84 -0
- package/api/@wtf/release-oci/publish/interfaces/MovedImage.md +41 -0
- package/api/@wtf/release-oci/publish/interfaces/OciSource.md +31 -0
- package/api/@wtf/release-oci/publish/interfaces/PublishedImage.md +91 -0
- package/api/@wtf/release-oci/publish/interfaces/SmokedImage.md +67 -0
- package/api/@wtf/release-oci/registry/README.md +50 -0
- package/api/@wtf/release-oci/registry/functions/checkRegistryAccess.md +28 -0
- package/api/@wtf/release-oci/registry/functions/registryPageOf.md +30 -0
- package/api/@wtf/release-oci/registry/interfaces/ContainerRegistry.md +35 -0
- package/api/@wtf/release-oci/registry/interfaces/RegistryProject.md +51 -0
- package/api/@wtf/release-oci/registry/interfaces/RegistryQuery.md +63 -0
- package/api/@wtf/release-oci/registry/interfaces/RegistryResponse.md +47 -0
- package/api/@wtf/release-oci/registry/type-aliases/RegistryAccess.md +13 -0
- package/api/@wtf/release-oci/registry/type-aliases/RegistryFetch.md +39 -0
- package/api/@wtf/release-oci/tags/README.md +28 -0
- package/api/@wtf/release-oci/tags/functions/checkReleaseTags.md +35 -0
- package/api/@wtf/release-oci/tags/functions/isImageTag.md +27 -0
- package/api/@wtf/release-oci/tags/interfaces/ReleaseTags.md +31 -0
- package/api/@wtf/release-replace/README.md +6 -5
- package/api/@wtf/release-replace/errors/README.md +3 -3
- package/api/@wtf/release-replace/errors/classes/ReplaceError.md +17 -32
- 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 +3 -3
- 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/README.md +3 -3
- package/api/@wtf/release-replace/replace/functions/regExpOf.md +1 -1
- package/api/@wtf/release-replace/replace/functions/replaceFiles.md +3 -3
- package/api/@wtf/release-replace/replace/functions/replaceText.md +1 -1
- package/api/@wtf/release-replace/replace/interfaces/ReplaceOptions.md +35 -32
- 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-trains/README.md +9 -8
- package/api/@wtf/release-trains/cascade/README.md +6 -5
- 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 +2 -2
- 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 +30 -27
- package/api/@wtf/release-trains/cascade/type-aliases/CascadeKind.md +2 -2
- 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/errors/README.md +6 -5
- package/api/@wtf/release-trains/errors/classes/TrainsError.md +18 -32
- package/api/@wtf/release-trains/errors/type-aliases/TrainsErrorCode.md +1 -1
- package/api/@wtf/release-trains/errors/variables/TRAINS_ERRORS.md +1 -13
- package/api/@wtf/release-trains/git/README.md +4 -4
- package/api/@wtf/release-trains/git/functions/tagOf.md +1 -1
- package/api/@wtf/release-trains/git/functions/tagsOf.md +4 -4
- package/api/@wtf/release-trains/git/functions/versionOfTag.md +1 -1
- package/api/@wtf/release-trains/git/interfaces/TrainTag.md +3 -3
- package/api/@wtf/release-trains/gitlab/README.md +6 -3
- package/api/@wtf/release-trains/gitlab/functions/findPackage.md +1 -1
- package/api/@wtf/release-trains/gitlab/functions/gitlabForge.md +33 -0
- package/api/@wtf/release-trains/gitlab/functions/gitlabHeadersOf.md +1 -1
- package/api/@wtf/release-trains/gitlab/functions/gitlabProjectOf.md +1 -1
- package/api/@wtf/release-trains/gitlab/functions/gitlabRegistryOf.md +1 -1
- package/api/@wtf/release-trains/gitlab/functions/uploadGeneric.md +1 -1
- package/api/@wtf/release-trains/gitlab/interfaces/GenericUpload.md +8 -8
- package/api/@wtf/release-trains/gitlab/interfaces/GitLabForgeOptions.md +97 -0
- package/api/@wtf/release-trains/gitlab/interfaces/GitLabOptions.md +4 -4
- package/api/@wtf/release-trains/gitlab/interfaces/GitLabProject.md +6 -6
- package/api/@wtf/release-trains/gitlab/interfaces/GitLabRegistry.md +5 -5
- package/api/@wtf/release-trains/gitlab/interfaces/HttpResponse.md +4 -4
- package/api/@wtf/release-trains/gitlab/interfaces/PackageQuery.md +9 -9
- package/api/@wtf/release-trains/gitlab/type-aliases/HttpFetch.md +1 -1
- package/api/@wtf/release-trains/gitlab/variables/LISTING_WAITS.md +1 -1
- package/api/@wtf/release-trains/interfaces/Train.md +7 -7
- package/api/@wtf/release-trains/links/README.md +16 -20
- package/api/@wtf/release-trains/links/functions/releaseLinks.md +15 -13
- package/api/@wtf/release-trains/links/interfaces/LinkOptions.md +56 -33
- package/api/@wtf/release-trains/packages/README.md +11 -16
- package/api/@wtf/release-trains/packages/functions/dependencyEdges.md +2 -2
- package/api/@wtf/release-trains/packages/functions/dependencyText.md +1 -1
- package/api/@wtf/release-trains/packages/functions/dependsOnErrors.md +2 -2
- package/api/@wtf/release-trains/packages/functions/ownersOf.md +2 -2
- package/api/@wtf/release-trains/packages/functions/packagesOf.md +2 -2
- package/api/@wtf/release-trains/packages/functions/releasedVersions.md +2 -2
- package/api/@wtf/release-trains/packages/functions/trainDependencies.md +2 -2
- package/api/@wtf/release-trains/packages/functions/trainOrder.md +2 -2
- package/api/@wtf/release-trains/packages/functions/unsatisfiedErrors.md +5 -4
- package/api/@wtf/release-trains/packages/interfaces/DependencyEdge.md +6 -6
- package/api/@wtf/release-trains/packages/interfaces/TrainDependency.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/VersionsRelease.md +24 -21
- package/api/@wtf/release-trains/paths/README.md +5 -4
- package/api/@wtf/release-trains/paths/functions/filterCommits.md +1 -1
- package/api/@wtf/release-trains/paths/functions/gitFilesOf.md +4 -4
- 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/plan/README.md +38 -0
- package/api/@wtf/release-trains/plan/functions/planOf.md +45 -0
- package/api/@wtf/release-trains/plan/interfaces/PlanRelease.md +113 -0
- package/api/@wtf/release-trains/plan/interfaces/TrainPlan.md +72 -0
- package/api/@wtf/release-trains/schema/README.md +1 -1
- package/api/@wtf/release-trains/schema/interfaces/ConfigPart.md +6 -6
- package/api/@wtf/release-trains/schema/interfaces/RootOptions.md +7 -17
- 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 +2 -2
- package/api/@wtf/release-trains/schema/variables/jsonSchema.md +2 -2
- package/api/@wtf/release-trains/schema/variables/rootOptionsSchema.md +4 -4
- package/api/@wtf/release-trains/schema/variables/trainSchema.md +2 -2
- package/api/@wtf/release-trains/schema/variables/trainsSchema.md +2 -2
- package/api/@wtf/release-trains/trains/functions/changelogOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/matchersOf.md +3 -3
- 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 +4 -9
- 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/README.md +8 -7
- package/api/@wtf/release-trains/verify/functions/unreleasedDependencies.md +3 -3
- package/api/@wtf/release-trains/verify/functions/verifyTrain.md +3 -3
- package/api/@wtf/release-trains/verify/interfaces/UnreleasedDependencies.md +33 -30
- package/api/@wtf/release-trains/verify/interfaces/VerifiedTrain.md +5 -5
- package/api/@wtf/release-trains/verify/interfaces/VerifyRelease.md +27 -24
- package/api/@wtf/release-validate/errors/README.md +3 -4
- package/api/@wtf/release-validate/errors/classes/ValidateError.md +29 -32
- 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/README.md +36 -0
- package/api/@wtf/semantic-release/errors/README.md +32 -0
- package/api/@wtf/semantic-release/errors/functions/marked.md +29 -0
- package/api/@wtf/semantic-release/errors/functions/markedStep.md +36 -0
- package/api/@wtf/semantic-release/errors/variables/SEMANTIC_RELEASE_ERROR.md +13 -0
- package/api/@wtf/{release-system/node → semantic-release}/functions/realPathOf.md +3 -3
- package/api/@wtf/semantic-release/functions/runOf.md +31 -0
- package/api/@wtf/semantic-release/interfaces/RunContext.md +31 -0
- package/api/@wtf/semantic-release/links/README.md +38 -0
- package/api/@wtf/{release-trains → semantic-release}/links/functions/forgetReleased.md +2 -2
- package/api/@wtf/{release-trains → semantic-release}/links/functions/recordReleased.md +3 -3
- package/api/@wtf/semantic-release/links/functions/releasedOf.md +28 -0
- package/api/@wtf/semantic-release/links/interfaces/ReleaseRun.md +41 -0
- package/api/@wtf/semantic-release/release/README.md +47 -0
- package/api/@wtf/semantic-release/release/functions/inTrain.md +42 -0
- package/api/@wtf/semantic-release/release/functions/stepRelease.md +35 -0
- package/api/@wtf/semantic-release/release/functions/trainNamed.md +34 -0
- package/api/@wtf/semantic-release/release/functions/trainPrefix.md +27 -0
- package/api/@wtf/semantic-release/release/interfaces/StepContext.md +63 -0
- package/api/@wtf/semantic-release/release/interfaces/StepOf.md +63 -0
- package/api/@wtf/semantic-release/schema/README.md +23 -0
- package/api/@wtf/{release-system/validator → semantic-release/schema}/functions/pluginEntriesOf.md +5 -5
- package/api/@wtf/semantic-release-cargo/README.md +32 -26
- package/api/@wtf/semantic-release-cargo/functions/indexLookup.md +3 -3
- package/api/@wtf/semantic-release-cargo/interfaces/CargoPluginOptions.md +46 -23
- package/api/@wtf/semantic-release-cargo/interfaces/CargoRelease.md +3 -3
- package/api/@wtf/semantic-release-cargo/schema/README.md +2 -2
- package/api/@wtf/semantic-release-cargo/schema/type-aliases/CargoOptions.md +2 -2
- package/api/@wtf/semantic-release-cargo/schema/variables/cargoOptionsSchema.md +2 -2
- package/api/@wtf/semantic-release-cargo/schema/variables/cargoSchema.md +2 -2
- package/api/@wtf/semantic-release-cargo/schema/variables/configSchema.md +2 -2
- package/api/@wtf/semantic-release-cargo/schema/variables/jsonSchema.md +2 -2
- package/api/@wtf/semantic-release-cargo/variables/default.md +43 -14
- package/api/@wtf/semantic-release-cargo/{functions → variables}/prepare.md +7 -7
- package/api/@wtf/semantic-release-cargo/{functions → variables}/publish.md +6 -5
- package/api/@wtf/semantic-release-cargo/variables/verifyConditions.md +37 -0
- package/api/@wtf/semantic-release-cargo/variables/verifyRelease.md +37 -0
- package/api/@wtf/semantic-release-go/README.md +40 -36
- package/api/@wtf/semantic-release-go/interfaces/GoPluginOptions.md +7 -17
- package/api/@wtf/semantic-release-go/interfaces/GoRelease.md +3 -3
- package/api/@wtf/semantic-release-go/schema/README.md +2 -2
- package/api/@wtf/semantic-release-go/schema/type-aliases/GoOptions.md +2 -2
- package/api/@wtf/semantic-release-go/schema/variables/configSchema.md +2 -2
- package/api/@wtf/semantic-release-go/schema/variables/goOptionsSchema.md +2 -2
- package/api/@wtf/semantic-release-go/schema/variables/goSchema.md +2 -2
- package/api/@wtf/semantic-release-go/schema/variables/jsonSchema.md +2 -2
- package/api/@wtf/semantic-release-go/variables/default.md +26 -22
- package/api/@wtf/semantic-release-go/variables/prepare.md +40 -0
- package/api/@wtf/semantic-release-go/variables/publish.md +45 -0
- package/api/@wtf/semantic-release-go/{functions → variables}/verifyConditions.md +8 -7
- package/api/@wtf/semantic-release-go/variables/verifyRelease.md +40 -0
- package/api/@wtf/semantic-release-maven/README.md +38 -20
- package/api/@wtf/semantic-release-maven/functions/pomLookup.md +3 -3
- package/api/@wtf/semantic-release-maven/interfaces/MavenPluginOptions.md +12 -22
- package/api/@wtf/semantic-release-maven/interfaces/MavenRelease.md +2 -2
- package/api/@wtf/semantic-release-maven/schema/README.md +2 -2
- package/api/@wtf/semantic-release-maven/schema/type-aliases/MavenOptions.md +2 -2
- package/api/@wtf/semantic-release-maven/schema/variables/configSchema.md +2 -2
- package/api/@wtf/semantic-release-maven/schema/variables/jsonSchema.md +2 -2
- package/api/@wtf/semantic-release-maven/schema/variables/mavenOptionsSchema.md +2 -2
- package/api/@wtf/semantic-release-maven/schema/variables/mavenSchema.md +2 -2
- package/api/@wtf/semantic-release-maven/variables/default.md +45 -16
- package/api/@wtf/semantic-release-maven/variables/prepare.md +41 -0
- package/api/@wtf/semantic-release-maven/variables/publish.md +44 -0
- package/api/@wtf/semantic-release-maven/{functions → variables}/verifyConditions.md +6 -7
- package/api/@wtf/semantic-release-maven/variables/verifyRelease.md +36 -0
- package/api/@wtf/semantic-release-npm/README.md +39 -29
- package/api/@wtf/semantic-release-npm/functions/loadPublisher.md +1 -1
- package/api/@wtf/semantic-release-npm/interfaces/PublishPluginOptions.md +24 -82
- 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/README.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/type-aliases/PublishOptions.md +3 -3
- package/api/@wtf/semantic-release-npm/schema/variables/configSchema.md +2 -2
- package/api/@wtf/semantic-release-npm/schema/variables/jsonSchema.md +2 -2
- package/api/@wtf/semantic-release-npm/schema/variables/publishOptionsSchema.md +2 -2
- package/api/@wtf/semantic-release-npm/schema/variables/publishSchema.md +2 -2
- package/api/@wtf/semantic-release-npm/type-aliases/PublisherSpec.md +1 -1
- package/api/@wtf/semantic-release-npm/{functions → variables}/addChannel.md +7 -6
- package/api/@wtf/semantic-release-npm/variables/default.md +51 -15
- package/api/@wtf/semantic-release-npm/variables/fail.md +36 -0
- package/api/@wtf/semantic-release-npm/variables/prepare.md +37 -0
- package/api/@wtf/semantic-release-npm/{functions → variables}/publish.md +8 -6
- package/api/@wtf/semantic-release-npm/{functions → variables}/verifyConditions.md +6 -4
- package/api/@wtf/semantic-release-npm/variables/verifyRelease.md +35 -0
- package/api/@wtf/semantic-release-oci/README.md +64 -0
- package/api/@wtf/semantic-release-oci/interfaces/OciPluginOptions.md +119 -0
- package/api/@wtf/semantic-release-oci/interfaces/OciRelease.md +31 -0
- package/api/@wtf/semantic-release-oci/schema/README.md +38 -0
- package/api/@wtf/semantic-release-oci/schema/type-aliases/OciOptions.md +13 -0
- package/api/@wtf/semantic-release-oci/schema/variables/configSchema.md +13 -0
- package/api/@wtf/semantic-release-oci/schema/variables/jsonSchema.md +13 -0
- package/api/@wtf/semantic-release-oci/schema/variables/ociOptionsSchema.md +13 -0
- package/api/@wtf/semantic-release-oci/schema/variables/ociSchema.md +14 -0
- package/api/@wtf/semantic-release-oci/variables/default.md +112 -0
- package/api/@wtf/semantic-release-oci/variables/publish.md +47 -0
- package/api/@wtf/semantic-release-oci/variables/verifyConditions.md +38 -0
- package/api/@wtf/semantic-release-oci/variables/verifyRelease.md +35 -0
- package/api/@wtf/semantic-release-replace/README.md +4 -4
- package/api/@wtf/semantic-release-replace/functions/functionOf.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/templatesOf.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/README.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/interfaces/ModuleExport.md +3 -3
- package/api/@wtf/semantic-release-replace/schema/interfaces/ReplaceOptions.md +4 -8
- 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 +2 -2
- package/api/@wtf/semantic-release-replace/schema/variables/exportedSetSchema.md +2 -2
- package/api/@wtf/semantic-release-replace/schema/variables/jsonSchema.md +2 -2
- package/api/@wtf/semantic-release-replace/schema/variables/replaceOptionsSchema.md +2 -2
- package/api/@wtf/semantic-release-replace/schema/variables/replacementSchema.md +2 -2
- package/api/@wtf/semantic-release-replace/schema/variables/rootTemplatesSchema.md +2 -2
- package/api/@wtf/semantic-release-replace/schema/variables/templateSchema.md +2 -2
- package/api/@wtf/semantic-release-replace/schema/variables/templatesSchema.md +2 -2
- package/api/@wtf/semantic-release-replace/type-aliases/ReplacePluginOptions.md +13 -0
- package/api/@wtf/semantic-release-replace/variables/default.md +5 -5
- package/api/@wtf/semantic-release-replace/{functions → variables}/prepare.md +6 -6
- package/api/@wtf/semantic-release-replace/{functions → variables}/verifyConditions.md +5 -5
- package/api/@wtf/semantic-release-trains/config/functions/skipPlugins.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/stepId.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainAssets.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainChangelog.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainOfTag.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainTagFormat.md +1 -1
- package/api/@wtf/semantic-release-trains/config/interfaces/AssetsOptions.md +4 -4
- package/api/@wtf/semantic-release-trains/config/interfaces/SkipOptions.md +3 -3
- package/api/@wtf/semantic-release-trains/config/variables/BRANCHES.md +1 -1
- package/api/@wtf/semantic-release-trains/config/variables/BREAKING.md +1 -1
- package/api/@wtf/semantic-release-trains/config/variables/TITLE.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/listingFetchOf.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/skipRuleOf.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/skips.md +3 -2
- package/api/@wtf/semantic-release-trains/defaults/functions/stepOptionsOf.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/trainOptionsOf.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/interfaces/ListingRetry.md +3 -3
- package/api/@wtf/semantic-release-trains/defaults/interfaces/SkipContext.md +35 -12
- package/api/@wtf/semantic-release-trains/defaults/interfaces/StepOptionsContext.md +18 -7
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/SkipCheck.md +3 -2
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/StepOptions.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/TrainOptions.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/SKIP_RULES.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_OPTIONS.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_SKIP.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_STEP_OPTIONS.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/releaseAssets.md +2 -2
- 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/README.md +3 -3
- 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 +3 -2
- package/api/@wtf/semantic-release-trains/info/interfaces/DecideRun.md +4 -4
- package/api/@wtf/semantic-release-trains/info/interfaces/InfoRun.md +36 -33
- package/api/@wtf/semantic-release-trains/info/interfaces/TrainDecision.md +5 -5
- package/api/@wtf/semantic-release-trains/info/interfaces/TrainInfo.md +5 -5
- package/api/@wtf/semantic-release-trains/interfaces/TrainsEntryOptions.md +5 -5
- package/api/@wtf/semantic-release-trains/interfaces/TrainsOptions.md +7 -17
- package/api/@wtf/semantic-release-trains/schema/README.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/configSchema.md +2 -2
- package/api/@wtf/semantic-release-trains/schema/variables/jsonSchema.md +2 -2
- package/api/@wtf/semantic-release-trains/schema/variables/pluginSpecSchema.md +2 -2
- package/api/@wtf/semantic-release-trains/schema/variables/skipRuleSchema.md +2 -2
- package/api/@wtf/semantic-release-trains/schema/variables/trainsEntrySchema.md +2 -2
- package/api/@wtf/semantic-release-trains/schema/variables/trainsPluginSchema.md +2 -2
- 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/README.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/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 +2 -2
- package/api/@wtf/semantic-release-validate/{functions → variables}/verifyConditions.md +5 -5
- package/api/README.md +31 -10
- package/api/trains.json +32 -9
- package/guides/ci-recipes.md +29 -27
- package/guides/configuring-trains.md +24 -20
- package/guides/dependency-rules.md +17 -17
- package/guides/ecosystems.md +69 -32
- package/guides/getting-started.md +26 -21
- package/guides/platform.md +179 -0
- package/guides/publishing-crates.md +58 -17
- package/guides/publishing-go-modules.md +55 -11
- package/guides/publishing-maven.md +48 -10
- package/guides/publishing-oci.md +134 -0
- package/guides/publishing.md +105 -84
- package/guides/troubleshooting.md +13 -12
- package/guides/validating-a-config.md +1 -0
- package/package.json +24 -16
- package/api/@wtf/release-go/tags/variables/RELEASE_AUTHOR.md +0 -23
- package/api/@wtf/release-npm/interfaces/PublishTrainOptions.md +0 -144
- package/api/@wtf/release-npm/release/functions/checkTrain.md +0 -32
- package/api/@wtf/release-npm/release/functions/distTagOf.md +0 -31
- package/api/@wtf/release-npm/release/functions/packTrain.md +0 -39
- package/api/@wtf/release-npm/release/functions/publishTrain.md +0 -37
- package/api/@wtf/release-npm/release/functions/publishedOfResolved.md +0 -36
- package/api/@wtf/release-npm/release/functions/releaseTrain.md +0 -31
- package/api/@wtf/release-npm/release/functions/resolveManifests.md +0 -37
- package/api/@wtf/release-npm/release/functions/tagTrain.md +0 -36
- package/api/@wtf/release-npm/release/interfaces/CheckRelease.md +0 -222
- package/api/@wtf/release-npm/release/interfaces/PackedTrain.md +0 -125
- package/api/@wtf/release-npm/release/interfaces/PublishedTrain.md +0 -47
- package/api/@wtf/release-npm/release/interfaces/ResolveRelease.md +0 -220
- package/api/@wtf/release-npm/release/interfaces/ResolvedTrain.md +0 -55
- package/api/@wtf/release-npm/release/interfaces/TagRelease.md +0 -174
- package/api/@wtf/release-npm/release/type-aliases/LookedUpTrain.md +0 -13
- package/api/@wtf/release-npm/release/type-aliases/ReleaseRun.md +0 -13
- package/api/@wtf/release-npm/workspace/interfaces/WorkspaceOptions.md +0 -19
- package/api/@wtf/release-system/README.md +0 -71
- package/api/@wtf/release-system/errors/README.md +0 -42
- package/api/@wtf/release-system/errors/functions/throwAll.md +0 -26
- package/api/@wtf/release-system/errors/type-aliases/SystemErrorCode.md +0 -13
- package/api/@wtf/release-system/errors/variables/SYSTEM_ERRORS.md +0 -23
- package/api/@wtf/release-system/git/functions/gitOf.md +0 -39
- package/api/@wtf/release-system/git/interfaces/GitContext.md +0 -45
- package/api/@wtf/release-system/git/interfaces/LogCommit.md +0 -43
- package/api/@wtf/release-system/node/README.md +0 -25
- package/api/@wtf/release-system/node/functions/nodeSystem.md +0 -20
- package/api/@wtf/release-system/node/functions/systemOf.md +0 -29
- package/api/@wtf/release-system/system/README.md +0 -39
- package/api/@wtf/release-system/system/interfaces/DirEntry.md +0 -27
- package/api/@wtf/release-system/system/interfaces/ExecOptions.md +0 -41
- package/api/@wtf/release-system/system/interfaces/ExecResult.md +0 -35
- package/api/@wtf/release-system/system/interfaces/System.md +0 -73
- package/api/@wtf/release-system/system/interfaces/SystemFs.md +0 -184
- package/api/@wtf/release-system/system/type-aliases/Exec.md +0 -41
- package/api/@wtf/release-system/system/type-aliases/SystemInput.md +0 -20
- package/api/@wtf/release-system/validator/interfaces/OptionIssue.md +0 -63
- package/api/@wtf/release-system/validator/interfaces/Property.md +0 -49
- package/api/@wtf/release-system/validator/type-aliases/JsonSchema.md +0 -17
- package/api/@wtf/release-system/validator/type-aliases/Path.md +0 -13
- package/api/@wtf/release-trains/ecosystem/functions/isEcosystem.md +0 -27
- package/api/@wtf/release-trains/ecosystem/functions/readPackages.md +0 -33
- package/api/@wtf/release-trains/ecosystem/interfaces/Dependency.md +0 -43
- package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemContext.md +0 -68
- package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemPackages.md +0 -27
- package/api/@wtf/release-trains/ecosystem/interfaces/Package.md +0 -70
- package/api/@wtf/release-trains/ecosystem/type-aliases/DependencyKind.md +0 -16
- package/api/@wtf/release-trains/ecosystem/variables/DEPENDENCY_KINDS.md +0 -13
- package/api/@wtf/release-trains/generated/functions/listGenerated.md +0 -41
- package/api/@wtf/release-trains/generated/functions/readGenerated.md +0 -39
- package/api/@wtf/release-trains/generated/functions/stageGeneratedFolders.md +0 -29
- package/api/@wtf/release-trains/generated/functions/unlistedIn.md +0 -42
- package/api/@wtf/release-trains/generated/interfaces/GeneratedOptions.md +0 -19
- package/api/@wtf/release-trains/generated/interfaces/StageOptions.md +0 -73
- package/api/@wtf/release-trains/generated/variables/GENERATED.md +0 -13
- package/api/@wtf/release-trains/links/functions/releasedOf.md +0 -28
- package/api/@wtf/release-trains/links/interfaces/PackageRegistry.md +0 -41
- package/api/@wtf/release-trains/links/interfaces/ReleaseLink.md +0 -41
- package/api/@wtf/release-trains/links/interfaces/ReleaseRun.md +0 -41
- package/api/@wtf/release-trains/links/interfaces/ReleasedPackage.md +0 -92
- package/api/@wtf/release-trains/packages/interfaces/OrderFault.md +0 -39
- package/api/@wtf/release-trains/packages/interfaces/OrderPins.md +0 -27
- package/api/@wtf/release-trains/packages/interfaces/PublishOrder.md +0 -35
- package/api/@wtf/semantic-release-cargo/functions/verifyConditions.md +0 -39
- package/api/@wtf/semantic-release-go/functions/prepare.md +0 -41
- package/api/@wtf/semantic-release-go/functions/publish.md +0 -43
- package/api/@wtf/semantic-release-go/functions/verifyRelease.md +0 -38
- package/api/@wtf/semantic-release-maven/functions/prepare.md +0 -41
- package/api/@wtf/semantic-release-maven/functions/publish.md +0 -43
- package/api/@wtf/semantic-release-maven/interfaces/LookupAuth.md +0 -32
- package/api/@wtf/semantic-release-npm/functions/fail.md +0 -36
- package/api/@wtf/semantic-release-npm/functions/prepare.md +0 -34
- package/api/@wtf/semantic-release-replace/interfaces/ReplacePluginOptions.md +0 -71
- package/guides/system.md +0 -175
|
@@ -6,9 +6,14 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: UnreleasedDependencies
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-trains/src/verify.ts:140](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-trains/src/verify.ts:140](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L140)
|
|
10
10
|
|
|
11
|
-
The trains a train depends on, to check for commits they have not released, and how
|
|
11
|
+
The trains a train depends on, to check for commits they have not released, and how, in the repo
|
|
12
|
+
of its folder, `root`, by its platform, which git and the ecosystems run by.
|
|
13
|
+
|
|
14
|
+
## Extends
|
|
15
|
+
|
|
16
|
+
- [`RepoContext`](../../../release/interfaces/RepoContext.md)\<[`ReleasePlatform`](../../../release/type-aliases/ReleasePlatform.md)\>
|
|
12
17
|
|
|
13
18
|
## Properties
|
|
14
19
|
|
|
@@ -16,7 +21,7 @@ The trains a train depends on, to check for commits they have not released, and
|
|
|
16
21
|
|
|
17
22
|
> `readonly` **analyze**: (`commits`) => `Promise`\<`string` \| `null` \| `undefined`\>
|
|
18
23
|
|
|
19
|
-
Defined in: [packages/release-trains/src/verify.ts:156](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
24
|
+
Defined in: [packages/release-trains/src/verify.ts:156](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L156)
|
|
20
25
|
|
|
21
26
|
The type of release `commits` make, as a commit analyzer says it: `major`, `minor`, `patch`, or
|
|
22
27
|
none. Asked of each dependency train with commits since its last release.
|
|
@@ -25,7 +30,7 @@ none. Asked of each dependency train with commits since its last release.
|
|
|
25
30
|
|
|
26
31
|
##### commits
|
|
27
32
|
|
|
28
|
-
readonly [`LogCommit`](../../../release
|
|
33
|
+
readonly [`LogCommit`](../../../release/git/interfaces/LogCommit.md)[]
|
|
29
34
|
|
|
30
35
|
The commits of the dependency train since its last release.
|
|
31
36
|
|
|
@@ -37,53 +42,51 @@ The type of release; `null` or `undefined` of none.
|
|
|
37
42
|
|
|
38
43
|
***
|
|
39
44
|
|
|
40
|
-
###
|
|
45
|
+
### ecosystems
|
|
41
46
|
|
|
42
|
-
> `readonly`
|
|
47
|
+
> `readonly` **ecosystems**: readonly [`Ecosystem`](../../../release/ecosystem/interfaces/Ecosystem.md)\<[`Package`](../../../release/ecosystem/interfaces/Package.md)\>[]
|
|
43
48
|
|
|
44
|
-
Defined in: [packages/release-trains/src/verify.ts:
|
|
49
|
+
Defined in: [packages/release-trains/src/verify.ts:148](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L148)
|
|
45
50
|
|
|
46
|
-
The
|
|
51
|
+
The ecosystems of the repo, whose packages make the trains the train depends on.
|
|
47
52
|
|
|
48
53
|
***
|
|
49
54
|
|
|
50
|
-
###
|
|
51
|
-
|
|
52
|
-
> `readonly` **ecosystems**: readonly [`Ecosystem`](../../ecosystem/interfaces/Ecosystem.md)[]
|
|
55
|
+
### platform
|
|
53
56
|
|
|
54
|
-
|
|
57
|
+
> `readonly` **platform**: [`ReleasePlatform`](../../../release/type-aliases/ReleasePlatform.md)
|
|
55
58
|
|
|
56
|
-
|
|
59
|
+
Defined in: [packages/release/src/index.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/index.ts#L80)
|
|
57
60
|
|
|
58
|
-
|
|
61
|
+
The platform, of the folder of the repo as its working folder.
|
|
59
62
|
|
|
60
|
-
|
|
63
|
+
#### Inherited from
|
|
61
64
|
|
|
62
|
-
|
|
65
|
+
[`RepoContext`](../../../release/interfaces/RepoContext.md).[`platform`](../../../release/interfaces/RepoContext.md#platform)
|
|
63
66
|
|
|
64
|
-
|
|
67
|
+
***
|
|
65
68
|
|
|
66
|
-
|
|
69
|
+
### root
|
|
67
70
|
|
|
68
|
-
|
|
71
|
+
> `readonly` **root**: `FileSystemDirectoryHandle`
|
|
69
72
|
|
|
70
|
-
|
|
73
|
+
Defined in: [packages/release/src/index.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/index.ts#L78)
|
|
71
74
|
|
|
72
|
-
|
|
75
|
+
The folder of the repo, a handle of the File System standard.
|
|
73
76
|
|
|
74
|
-
|
|
77
|
+
#### Inherited from
|
|
75
78
|
|
|
76
|
-
|
|
79
|
+
[`RepoContext`](../../../release/interfaces/RepoContext.md).[`root`](../../../release/interfaces/RepoContext.md#root)
|
|
77
80
|
|
|
78
81
|
***
|
|
79
82
|
|
|
80
|
-
###
|
|
83
|
+
### rule
|
|
81
84
|
|
|
82
|
-
> `readonly` **
|
|
85
|
+
> `readonly` **rule**: [`DependencyRule`](../../schema/type-aliases/DependencyRule.md)
|
|
83
86
|
|
|
84
|
-
Defined in: [packages/release-trains/src/verify.ts:
|
|
87
|
+
Defined in: [packages/release-trains/src/verify.ts:146](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L146)
|
|
85
88
|
|
|
86
|
-
|
|
89
|
+
What the train does of a dependency train with commits it has not released.
|
|
87
90
|
|
|
88
91
|
***
|
|
89
92
|
|
|
@@ -91,7 +94,7 @@ The system git and the files run by, which it requires.
|
|
|
91
94
|
|
|
92
95
|
> `readonly` **train**: `string` \| `undefined`
|
|
93
96
|
|
|
94
|
-
Defined in: [packages/release-trains/src/verify.ts:144](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
97
|
+
Defined in: [packages/release-trains/src/verify.ts:144](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L144)
|
|
95
98
|
|
|
96
99
|
The train of the release.
|
|
97
100
|
|
|
@@ -101,7 +104,7 @@ The train of the release.
|
|
|
101
104
|
|
|
102
105
|
> `readonly` **trains**: [`Trains`](../../type-aliases/Trains.md)
|
|
103
106
|
|
|
104
|
-
Defined in: [packages/release-trains/src/verify.ts:142](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
107
|
+
Defined in: [packages/release-trains/src/verify.ts:142](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L142)
|
|
105
108
|
|
|
106
109
|
Every train of the repo.
|
|
107
110
|
|
|
@@ -111,7 +114,7 @@ Every train of the repo.
|
|
|
111
114
|
|
|
112
115
|
> `readonly` `optional` **warn?**: (`line`) => `void`
|
|
113
116
|
|
|
114
|
-
Defined in: [packages/release-trains/src/verify.ts:
|
|
117
|
+
Defined in: [packages/release-trains/src/verify.ts:162](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L162)
|
|
115
118
|
|
|
116
119
|
Where a dependency train that warns is said: nowhere by default.
|
|
117
120
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: VerifiedTrain
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-trains/src/verify.ts:
|
|
9
|
+
Defined in: [packages/release-trains/src/verify.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L87)
|
|
10
10
|
|
|
11
11
|
A train that passed its checks: its name, the train, and its last release, of none yet.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ A train that passed its checks: its name, the train, and its last release, of no
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **last**: [`TrainTag`](../../git/interfaces/TrainTag.md) \| `undefined`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-trains/src/verify.ts:
|
|
19
|
+
Defined in: [packages/release-trains/src/verify.ts:91](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L91)
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
@@ -24,7 +24,7 @@ Defined in: [packages/release-trains/src/verify.ts:93](https://gitlab.com/wetryf
|
|
|
24
24
|
|
|
25
25
|
> `readonly` **name**: `string`
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/release-trains/src/verify.ts:
|
|
27
|
+
Defined in: [packages/release-trains/src/verify.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L88)
|
|
28
28
|
|
|
29
29
|
***
|
|
30
30
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/release-trains/src/verify.ts:90](https://gitlab.com/wetryf
|
|
|
32
32
|
|
|
33
33
|
> `readonly` **tagFormat**: `string`
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/release-trains/src/verify.ts:
|
|
35
|
+
Defined in: [packages/release-trains/src/verify.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L90)
|
|
36
36
|
|
|
37
37
|
***
|
|
38
38
|
|
|
@@ -40,4 +40,4 @@ Defined in: [packages/release-trains/src/verify.ts:92](https://gitlab.com/wetryf
|
|
|
40
40
|
|
|
41
41
|
> `readonly` **train**: [`Train`](../../interfaces/Train.md)
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/release-trains/src/verify.ts:
|
|
43
|
+
Defined in: [packages/release-trains/src/verify.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L89)
|
|
@@ -6,49 +6,52 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: VerifyRelease
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-trains/src/verify.ts:
|
|
9
|
+
Defined in: [packages/release-trains/src/verify.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L75)
|
|
10
10
|
|
|
11
|
-
A train to check before it releases, and how
|
|
11
|
+
A train to check before it releases, and how, in the repo of its folder, `root`, by its platform,
|
|
12
|
+
which git and the ecosystems run by.
|
|
12
13
|
|
|
13
|
-
##
|
|
14
|
-
|
|
15
|
-
### cwd?
|
|
16
|
-
|
|
17
|
-
> `readonly` `optional` **cwd?**: `string`
|
|
14
|
+
## Extends
|
|
18
15
|
|
|
19
|
-
|
|
16
|
+
- [`RepoContext`](../../../release/interfaces/RepoContext.md)\<[`ReleasePlatform`](../../../release/type-aliases/ReleasePlatform.md)\>
|
|
20
17
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
***
|
|
18
|
+
## Properties
|
|
24
19
|
|
|
25
20
|
### ecosystems
|
|
26
21
|
|
|
27
|
-
> `readonly` **ecosystems**: readonly [`Ecosystem`](
|
|
22
|
+
> `readonly` **ecosystems**: readonly [`Ecosystem`](../../../release/ecosystem/interfaces/Ecosystem.md)\<[`Package`](../../../release/ecosystem/interfaces/Package.md)\>[]
|
|
28
23
|
|
|
29
|
-
Defined in: [packages/release-trains/src/verify.ts:
|
|
24
|
+
Defined in: [packages/release-trains/src/verify.ts:83](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L83)
|
|
30
25
|
|
|
31
26
|
The ecosystems of the repo, whose packages its checks read.
|
|
32
27
|
|
|
33
28
|
***
|
|
34
29
|
|
|
35
|
-
###
|
|
30
|
+
### platform
|
|
31
|
+
|
|
32
|
+
> `readonly` **platform**: [`ReleasePlatform`](../../../release/type-aliases/ReleasePlatform.md)
|
|
33
|
+
|
|
34
|
+
Defined in: [packages/release/src/index.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/index.ts#L80)
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
The platform, of the folder of the repo as its working folder.
|
|
38
37
|
|
|
39
|
-
|
|
38
|
+
#### Inherited from
|
|
40
39
|
|
|
41
|
-
|
|
40
|
+
[`RepoContext`](../../../release/interfaces/RepoContext.md).[`platform`](../../../release/interfaces/RepoContext.md#platform)
|
|
42
41
|
|
|
43
42
|
***
|
|
44
43
|
|
|
45
|
-
###
|
|
44
|
+
### root
|
|
45
|
+
|
|
46
|
+
> `readonly` **root**: `FileSystemDirectoryHandle`
|
|
47
|
+
|
|
48
|
+
Defined in: [packages/release/src/index.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/index.ts#L78)
|
|
46
49
|
|
|
47
|
-
|
|
50
|
+
The folder of the repo, a handle of the File System standard.
|
|
48
51
|
|
|
49
|
-
|
|
52
|
+
#### Inherited from
|
|
50
53
|
|
|
51
|
-
|
|
54
|
+
[`RepoContext`](../../../release/interfaces/RepoContext.md).[`root`](../../../release/interfaces/RepoContext.md#root)
|
|
52
55
|
|
|
53
56
|
***
|
|
54
57
|
|
|
@@ -56,7 +59,7 @@ The system git and the files run by, which it requires.
|
|
|
56
59
|
|
|
57
60
|
> `readonly` `optional` **tagFormat?**: `string`
|
|
58
61
|
|
|
59
|
-
Defined in: [packages/release-trains/src/verify.ts:
|
|
62
|
+
Defined in: [packages/release-trains/src/verify.ts:81](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L81)
|
|
60
63
|
|
|
61
64
|
The tag format the release tags by, which must be the train's: unchecked when it is not given.
|
|
62
65
|
|
|
@@ -66,7 +69,7 @@ The tag format the release tags by, which must be the train's: unchecked when it
|
|
|
66
69
|
|
|
67
70
|
> `readonly` **train**: `string` \| `undefined`
|
|
68
71
|
|
|
69
|
-
Defined in: [packages/release-trains/src/verify.ts:
|
|
72
|
+
Defined in: [packages/release-trains/src/verify.ts:79](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L79)
|
|
70
73
|
|
|
71
74
|
The train of the release.
|
|
72
75
|
|
|
@@ -76,6 +79,6 @@ The train of the release.
|
|
|
76
79
|
|
|
77
80
|
> `readonly` **trains**: [`Trains`](../../type-aliases/Trains.md)
|
|
78
81
|
|
|
79
|
-
Defined in: [packages/release-trains/src/verify.ts:
|
|
82
|
+
Defined in: [packages/release-trains/src/verify.ts:77](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-trains/src/verify.ts#L77)
|
|
80
83
|
|
|
81
84
|
Every train of the repo.
|
|
@@ -6,10 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
# @wtf/release-validate/errors
|
|
8
8
|
|
|
9
|
-
What the validation of a config throws: [ValidateError](classes/ValidateError.md),
|
|
10
|
-
what is wrong, and `details` of how to
|
|
11
|
-
|
|
12
|
-
its details, and so prints this one.
|
|
9
|
+
What the validation of a config throws: [ValidateError](classes/ValidateError.md), a `ReleaseError` of
|
|
10
|
+
`@wtf/release/errors`, of a stable `code`, a `message` of what is wrong, and `details` of how to
|
|
11
|
+
fix it. It is a plain error, of no release tool: a plugin marks it as it leaves its step.
|
|
13
12
|
|
|
14
13
|
## Classes
|
|
15
14
|
|
|
@@ -6,14 +6,14 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ValidateError
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-validate/src/errors.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-validate/src/errors.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/errors.ts#L24)
|
|
10
10
|
|
|
11
|
-
An error of the validation of a config: a stable `code
|
|
12
|
-
`details` how to fix it.
|
|
11
|
+
An error of the validation of a config: a stable `code` of [VALIDATE\_ERRORS](../variables/VALIDATE_ERRORS.md), its
|
|
12
|
+
`message` what is wrong, and its `details` how to fix it.
|
|
13
13
|
|
|
14
14
|
## Extends
|
|
15
15
|
|
|
16
|
-
- `
|
|
16
|
+
- [`ReleaseError`](../../../release/errors/classes/ReleaseError.md)
|
|
17
17
|
|
|
18
18
|
## Constructors
|
|
19
19
|
|
|
@@ -21,38 +21,37 @@ An error of the validation of a config: a stable `code`, its `message` what is w
|
|
|
21
21
|
|
|
22
22
|
> **new ValidateError**(`code`, `message`, `details`): `ValidateError`
|
|
23
23
|
|
|
24
|
-
Defined in: [packages/release
|
|
24
|
+
Defined in: [packages/release/src/errors.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/errors.ts#L54)
|
|
25
25
|
|
|
26
|
-
An error of
|
|
27
|
-
`SemanticReleaseError` as semantic-release's own.
|
|
26
|
+
An error of `code`, of its `message` and its `details`, named after its class.
|
|
28
27
|
|
|
29
28
|
#### Parameters
|
|
30
29
|
|
|
31
30
|
##### code
|
|
32
31
|
|
|
33
|
-
`
|
|
32
|
+
`string`
|
|
34
33
|
|
|
35
|
-
The stable code of the error, as `
|
|
34
|
+
The stable code of the error, as `EGIT`.
|
|
36
35
|
|
|
37
36
|
##### message
|
|
38
37
|
|
|
39
38
|
`string`
|
|
40
39
|
|
|
41
|
-
What is wrong.
|
|
40
|
+
What is wrong, as a reader is told it.
|
|
42
41
|
|
|
43
42
|
##### details
|
|
44
43
|
|
|
45
44
|
`string`
|
|
46
45
|
|
|
47
|
-
How to fix it.
|
|
46
|
+
How to fix it, of the steps a reader takes.
|
|
48
47
|
|
|
49
48
|
#### Returns
|
|
50
49
|
|
|
51
50
|
`ValidateError`
|
|
52
51
|
|
|
53
|
-
####
|
|
52
|
+
#### Inherited from
|
|
54
53
|
|
|
55
|
-
`
|
|
54
|
+
[`ReleaseError`](../../../release/errors/classes/ReleaseError.md).[`constructor`](../../../release/errors/classes/ReleaseError.md#constructor)
|
|
56
55
|
|
|
57
56
|
## Properties
|
|
58
57
|
|
|
@@ -64,7 +63,7 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
|
|
|
64
63
|
|
|
65
64
|
#### Inherited from
|
|
66
65
|
|
|
67
|
-
`
|
|
66
|
+
[`ReleaseError`](../../../release/errors/classes/ReleaseError.md).[`cause`](../../../release/errors/classes/ReleaseError.md#cause)
|
|
68
67
|
|
|
69
68
|
***
|
|
70
69
|
|
|
@@ -72,20 +71,28 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
|
|
|
72
71
|
|
|
73
72
|
> `readonly` **code**: `"ECONFIG"` \| `"ESCHEMA"`
|
|
74
73
|
|
|
75
|
-
Defined in: [packages/release-validate/src/errors.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
74
|
+
Defined in: [packages/release-validate/src/errors.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/errors.ts#L26)
|
|
76
75
|
|
|
77
76
|
The stable code of the error, as `ECONFIG`.
|
|
78
77
|
|
|
78
|
+
#### Overrides
|
|
79
|
+
|
|
80
|
+
[`ReleaseError`](../../../release/errors/classes/ReleaseError.md).[`code`](../../../release/errors/classes/ReleaseError.md#code)
|
|
81
|
+
|
|
79
82
|
***
|
|
80
83
|
|
|
81
84
|
### details
|
|
82
85
|
|
|
83
86
|
> `readonly` **details**: `string`
|
|
84
87
|
|
|
85
|
-
Defined in: [packages/release
|
|
88
|
+
Defined in: [packages/release/src/errors.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/errors.ts#L45)
|
|
86
89
|
|
|
87
90
|
How to fix it.
|
|
88
91
|
|
|
92
|
+
#### Inherited from
|
|
93
|
+
|
|
94
|
+
[`ReleaseError`](../../../release/errors/classes/ReleaseError.md).[`details`](../../../release/errors/classes/ReleaseError.md#details)
|
|
95
|
+
|
|
89
96
|
***
|
|
90
97
|
|
|
91
98
|
### message
|
|
@@ -96,7 +103,7 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
|
|
|
96
103
|
|
|
97
104
|
#### Inherited from
|
|
98
105
|
|
|
99
|
-
`
|
|
106
|
+
[`ReleaseError`](../../../release/errors/classes/ReleaseError.md).[`message`](../../../release/errors/classes/ReleaseError.md#message)
|
|
100
107
|
|
|
101
108
|
***
|
|
102
109
|
|
|
@@ -108,17 +115,7 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
|
|
|
108
115
|
|
|
109
116
|
#### Inherited from
|
|
110
117
|
|
|
111
|
-
`
|
|
112
|
-
|
|
113
|
-
***
|
|
114
|
-
|
|
115
|
-
### semanticRelease
|
|
116
|
-
|
|
117
|
-
> `readonly` **semanticRelease**: `true`
|
|
118
|
-
|
|
119
|
-
Defined in: [packages/release-validate/src/errors.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-validate/src/errors.ts#L30)
|
|
120
|
-
|
|
121
|
-
The mark semantic-release prints an error of a plugin by.
|
|
118
|
+
[`ReleaseError`](../../../release/errors/classes/ReleaseError.md).[`name`](../../../release/errors/classes/ReleaseError.md#name)
|
|
122
119
|
|
|
123
120
|
***
|
|
124
121
|
|
|
@@ -130,7 +127,7 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
|
|
|
130
127
|
|
|
131
128
|
#### Inherited from
|
|
132
129
|
|
|
133
|
-
`
|
|
130
|
+
[`ReleaseError`](../../../release/errors/classes/ReleaseError.md).[`stack`](../../../release/errors/classes/ReleaseError.md#stack)
|
|
134
131
|
|
|
135
132
|
***
|
|
136
133
|
|
|
@@ -152,7 +149,7 @@ not capture any frames.
|
|
|
152
149
|
|
|
153
150
|
#### Inherited from
|
|
154
151
|
|
|
155
|
-
`
|
|
152
|
+
[`ReleaseError`](../../../release/errors/classes/ReleaseError.md).[`stackTraceLimit`](../../../release/errors/classes/ReleaseError.md#stacktracelimit)
|
|
156
153
|
|
|
157
154
|
## Methods
|
|
158
155
|
|
|
@@ -222,7 +219,7 @@ a();
|
|
|
222
219
|
|
|
223
220
|
#### Inherited from
|
|
224
221
|
|
|
225
|
-
`
|
|
222
|
+
[`ReleaseError`](../../../release/errors/classes/ReleaseError.md).[`captureStackTrace`](../../../release/errors/classes/ReleaseError.md#capturestacktrace)
|
|
226
223
|
|
|
227
224
|
***
|
|
228
225
|
|
|
@@ -252,4 +249,4 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
252
249
|
|
|
253
250
|
#### Inherited from
|
|
254
251
|
|
|
255
|
-
`
|
|
252
|
+
[`ReleaseError`](../../../release/errors/classes/ReleaseError.md).[`prepareStackTrace`](../../../release/errors/classes/ReleaseError.md#preparestacktrace)
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **ValidateErrorCode** = keyof *typeof* [`VALIDATE_ERRORS`](../variables/VALIDATE_ERRORS.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/errors.ts:18](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/errors.ts:18](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/errors.ts#L18)
|
|
12
12
|
|
|
13
13
|
A code of [VALIDATE\_ERRORS](../variables/VALIDATE_ERRORS.md).
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **VALIDATE\_ERRORS**: `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/errors.ts:12](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/errors.ts:12](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/errors.ts#L12)
|
|
12
12
|
|
|
13
13
|
The codes of the errors of a validation, each with what it means.
|
|
14
14
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ConfigIssue
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-validate/src/index.ts:25](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-validate/src/index.ts:25](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/index.ts#L25)
|
|
10
10
|
|
|
11
11
|
What is wrong with a config, and where.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ What is wrong with a config, and where.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **at**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-validate/src/index.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-validate/src/index.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/index.ts#L31)
|
|
20
20
|
|
|
21
21
|
Where, as a reader writes it: `plugins[2][1].access`, or `the config` of none.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ Where, as a reader writes it: `plugins[2][1].access`, or `the config` of none.
|
|
|
26
26
|
|
|
27
27
|
> `readonly` **message**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-validate/src/index.ts:27](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-validate/src/index.ts:27](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/index.ts#L27)
|
|
30
30
|
|
|
31
31
|
What is wrong, as the schema says it.
|
|
32
32
|
|
|
@@ -36,6 +36,6 @@ What is wrong, as the schema says it.
|
|
|
36
36
|
|
|
37
37
|
> `readonly` **path**: readonly `PropertyKey`[]
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/release-validate/src/index.ts:29](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
39
|
+
Defined in: [packages/release-validate/src/index.ts:29](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/index.ts#L29)
|
|
40
40
|
|
|
41
41
|
Where, in the config: each key, and each index of an array.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **fromJsonSchema**(`schema`, `compile`): `StandardSchemaV1`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/json-schema.ts:82](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/json-schema.ts:82](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/json-schema.ts#L82)
|
|
12
12
|
|
|
13
13
|
A Standard Schema of the JSON Schema `schema`, by `compile`, the engine's, which compiles it
|
|
14
14
|
once: each error of the engine an issue, its `instancePath` its path. A value the engine finds
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **pathOfPointer**(`pointer`): (`string` \| `number`)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/json-schema.ts:56](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/json-schema.ts:56](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/json-schema.ts#L56)
|
|
12
12
|
|
|
13
13
|
The path of an issue of the JSON Pointer `pointer`: each key, and each index a number.
|
|
14
14
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: JsonSchemaError
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-validate/src/json-schema.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-validate/src/json-schema.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/json-schema.ts#L24)
|
|
10
10
|
|
|
11
11
|
An error of a validator of a JSON Schema, as Ajv gives it: where, and what.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ An error of a validator of a JSON Schema, as Ajv gives it: where, and what.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **instancePath**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-validate/src/json-schema.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-validate/src/json-schema.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/json-schema.ts#L26)
|
|
20
20
|
|
|
21
21
|
Where, in the value: a JSON Pointer, as `/plugins/2/1/access`, or `''` of the value.
|
|
22
22
|
|
|
@@ -26,6 +26,6 @@ Where, in the value: a JSON Pointer, as `/plugins/2/1/access`, or `''` of the va
|
|
|
26
26
|
|
|
27
27
|
> `readonly` `optional` **message?**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-validate/src/json-schema.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-validate/src/json-schema.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/json-schema.ts#L28)
|
|
30
30
|
|
|
31
31
|
What is wrong.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: JsonSchemaValidator()
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-validate/src/json-schema.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-validate/src/json-schema.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/json-schema.ts#L36)
|
|
10
10
|
|
|
11
11
|
A validator of a JSON Schema, as Ajv's `compile` gives it: whether a value is valid, and the
|
|
12
12
|
errors of the last value it found not valid. An async validator, of a schema of `$async`, gives a
|
|
@@ -14,7 +14,7 @@ promise that rejects with an error of `errors`.
|
|
|
14
14
|
|
|
15
15
|
> **JsonSchemaValidator**(`value`): `boolean` \| `Promise`\<`unknown`\>
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/release-validate/src/json-schema.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
17
|
+
Defined in: [packages/release-validate/src/json-schema.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/json-schema.ts#L45)
|
|
18
18
|
|
|
19
19
|
Whether `value` is valid: of a sync validator, a boolean; of an async one, a promise that
|
|
20
20
|
rejects of a value not valid.
|
|
@@ -40,6 +40,6 @@ with an error of `errors` of one not valid.
|
|
|
40
40
|
|
|
41
41
|
> `readonly` `optional` **errors?**: readonly [`JsonSchemaError`](JsonSchemaError.md)[] \| `null`
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/release-validate/src/json-schema.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
43
|
+
Defined in: [packages/release-validate/src/json-schema.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/json-schema.ts#L47)
|
|
44
44
|
|
|
45
45
|
The errors of the last value found not valid.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **configErrors**(`schema`, `config`, `name?`): `Promise`\<[`ValidateError`](../../errors/classes/ValidateError.md)[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/validate.ts:109](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/validate.ts:109](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/validate.ts#L109)
|
|
12
12
|
|
|
13
13
|
The errors of the issues of `config` by `schema`, each `ECONFIG` of where it is, as `name` says
|
|
14
14
|
the schema: none of a config it finds valid.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **isStandardSchema**(`value`): `value is StandardSchemaV1<unknown, unknown>`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/validate.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/validate.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/validate.ts#L43)
|
|
12
12
|
|
|
13
13
|
Whether `value` is a Standard Schema, of version 1.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **pathText**(`path`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/validate.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/validate.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-validate/src/validate.ts#L63)
|
|
12
12
|
|
|
13
13
|
`path`, as a reader writes it: `plugins[2][1].access`, or `the config` of none.
|
|
14
14
|
|