@wtf/release-docs 9.1.0 → 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 +3 -3
- package/api/.generated +244 -145
- 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 +10 -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 +12 -10
- package/api/@wtf/release-oci/ecosystem/README.md +22 -7
- package/api/@wtf/release-oci/ecosystem/functions/packagesOfImages.md +2 -2
- package/api/@wtf/release-oci/ecosystem/functions/packagesOfRepo.md +4 -4
- package/api/@wtf/release-oci/ecosystem/functions/repositoriesOf.md +27 -0
- package/api/@wtf/release-oci/ecosystem/functions/resolveTag.md +2 -2
- package/api/@wtf/release-oci/ecosystem/functions/satisfiesTag.md +2 -2
- package/api/@wtf/release-oci/ecosystem/interfaces/OciOptions.md +64 -0
- package/api/@wtf/release-oci/ecosystem/interfaces/OciPackage.md +17 -17
- package/api/@wtf/release-oci/ecosystem/interfaces/OciSourceOptions.md +32 -0
- package/api/@wtf/release-oci/ecosystem/variables/ociEcosystem.md +18 -4
- package/api/@wtf/release-oci/errors/README.md +4 -5
- package/api/@wtf/release-oci/errors/classes/OciError.md +17 -32
- package/api/@wtf/release-oci/errors/type-aliases/OciErrorCode.md +1 -1
- package/api/@wtf/release-oci/errors/variables/OCI_ERRORS.md +10 -2
- package/api/@wtf/release-oci/images/README.md +3 -3
- package/api/@wtf/release-oci/images/functions/imageDirOf.md +1 -1
- package/api/@wtf/release-oci/images/functions/imagesAt.md +3 -3
- package/api/@wtf/release-oci/images/functions/imagesOf.md +1 -1
- package/api/@wtf/release-oci/images/functions/isImageManifest.md +1 -1
- package/api/@wtf/release-oci/images/functions/readImages.md +3 -3
- package/api/@wtf/release-oci/images/functions/registryImageOf.md +3 -3
- package/api/@wtf/release-oci/images/functions/repositoryOf.md +1 -1
- package/api/@wtf/release-oci/interfaces/OciImage.md +4 -4
- package/api/@wtf/release-oci/publish/README.md +26 -13
- package/api/@wtf/release-oci/publish/functions/digestOf.md +1 -1
- package/api/@wtf/release-oci/publish/functions/moveImages.md +32 -0
- package/api/@wtf/release-oci/publish/functions/platformsOf.md +1 -1
- package/api/@wtf/release-oci/publish/functions/publishImages.md +8 -6
- package/api/@wtf/release-oci/publish/functions/smokeImages.md +1 -1
- package/api/@wtf/release-oci/publish/interfaces/CraneContext.md +10 -37
- package/api/@wtf/release-oci/publish/interfaces/ImageToPublish.md +3 -3
- package/api/@wtf/release-oci/publish/interfaces/ImagesMove.md +84 -0
- package/api/@wtf/release-oci/publish/interfaces/ImagesRelease.md +18 -17
- package/api/@wtf/release-oci/publish/interfaces/MovedImage.md +41 -0
- package/api/@wtf/release-oci/publish/interfaces/OciSource.md +3 -3
- package/api/@wtf/release-oci/publish/interfaces/PublishedImage.md +11 -21
- package/api/@wtf/release-oci/publish/interfaces/SmokedImage.md +5 -5
- package/api/@wtf/release-oci/registry/README.md +20 -4
- package/api/@wtf/release-oci/registry/functions/checkRegistryAccess.md +28 -0
- package/api/@wtf/release-oci/registry/functions/registryPageOf.md +1 -1
- 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 +20 -8
- 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 +9 -8
- 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 +4 -4
- 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 +17 -14
- package/api/@wtf/semantic-release-oci/interfaces/OciPluginOptions.md +23 -20
- package/api/@wtf/semantic-release-oci/interfaces/OciRelease.md +3 -3
- package/api/@wtf/semantic-release-oci/schema/README.md +3 -3
- package/api/@wtf/semantic-release-oci/schema/type-aliases/OciOptions.md +2 -2
- package/api/@wtf/semantic-release-oci/schema/variables/configSchema.md +2 -2
- package/api/@wtf/semantic-release-oci/schema/variables/jsonSchema.md +2 -2
- package/api/@wtf/semantic-release-oci/schema/variables/ociOptionsSchema.md +2 -2
- package/api/@wtf/semantic-release-oci/schema/variables/ociSchema.md +2 -2
- package/api/@wtf/semantic-release-oci/variables/default.md +40 -7
- package/api/@wtf/semantic-release-oci/variables/publish.md +47 -0
- package/api/@wtf/semantic-release-oci/{functions → variables}/verifyConditions.md +7 -5
- 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 +22 -10
- package/api/trains.json +29 -10
- 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 +43 -25
- package/guides/getting-started.md +12 -10
- 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 +36 -5
- package/guides/publishing.md +105 -84
- package/guides/troubleshooting.md +12 -12
- package/package.json +24 -18
- 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-oci/tags/functions/releaseTagsOf.md +0 -39
- package/api/@wtf/release-oci/tags/functions/tagsOfRelease.md +0 -33
- 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 -46
- 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 -71
- 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-oci/functions/publish.md +0 -44
- package/api/@wtf/semantic-release-replace/interfaces/ReplacePluginOptions.md +0 -71
- package/guides/system.md +0 -175
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **default**: `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-oci/src/index.ts:
|
|
11
|
+
Defined in: [packages/semantic-release-oci/src/index.ts:454](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L454)
|
|
12
12
|
|
|
13
13
|
## Type Declaration
|
|
14
14
|
|
|
@@ -16,10 +16,13 @@ Defined in: [packages/semantic-release-oci/src/index.ts:302](https://gitlab.com/
|
|
|
16
16
|
|
|
17
17
|
> **publish**: (`pluginConfig`, `context`) => `Promise`\<`false` \| [`OciRelease`](../interfaces/OciRelease.md)\>
|
|
18
18
|
|
|
19
|
-
Copies the tested image of each image of the release to the tags of the release
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
19
|
+
Copies the tested image of each image of the release to the tags of the release, by the steps
|
|
20
|
+
`publish` and `move` of the ecosystem of OCI images, which `verifyRelease` verified: its version, skipped of a registry
|
|
21
|
+
that has it at the same digest, so a release that stopped part way is finished by running it
|
|
22
|
+
again; and of a release, its minor and its major, pointed at the version. Each image is given its
|
|
23
|
+
page in the container registry of GitLab, asked by a token of `GL_TOKEN` or `GITLAB_TOKEN`, and
|
|
24
|
+
recorded for the links of the release of the host; and the images it published are written to
|
|
25
|
+
the dotenv file of `dotenv`.
|
|
23
26
|
|
|
24
27
|
#### Parameters
|
|
25
28
|
|
|
@@ -56,8 +59,10 @@ another digest, `EOCITAG` of a copy crane cannot make, `EOCILINK` of a page GitL
|
|
|
56
59
|
Checks the options of the plugin, by `ociSchema` of `./schema` (`EOPTIONS`), that `ecosystems`
|
|
57
60
|
lists `@wtf/semantic-release-oci/ecosystem` or `@wtf/release-oci` (`EOCIECOSYSTEM`), and the train
|
|
58
61
|
of the run (`ETRAINNOTSELECTED`, `ETRAINUNKNOWN`); that no image is of two trains
|
|
59
|
-
(`ETRAINOVERLAP`); and that each image of the train has a repository (`EOCIIMAGE`).
|
|
60
|
-
registry
|
|
62
|
+
(`ETRAINOVERLAP`); and that each image of the train has a repository (`EOCIIMAGE`). Then that
|
|
63
|
+
the run may read the API of the container registry, which the links of `publish` need, by one
|
|
64
|
+
request of no effect (`EOCILINK`): of a token of `GL_TOKEN` or `GITLAB_TOKEN`, which a dry run of
|
|
65
|
+
none, as of a merge request, only warns of. It asks crane nothing.
|
|
61
66
|
|
|
62
67
|
#### Parameters
|
|
63
68
|
|
|
@@ -77,3 +82,31 @@ environment and the logger of the run.
|
|
|
77
82
|
#### Returns
|
|
78
83
|
|
|
79
84
|
`Promise`\<`void`\>
|
|
85
|
+
|
|
86
|
+
### verifyRelease
|
|
87
|
+
|
|
88
|
+
> **verifyRelease**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
|
|
89
|
+
|
|
90
|
+
Runs the step `verify` of the ecosystem of OCI images, once semantic-release knows the version of
|
|
91
|
+
the release: that the version and each tag that moves of it is a tag of an image, none given
|
|
92
|
+
twice (`EOCIVERSION`), and that each image of the train has a repository (`EOCIIMAGE`). It asks
|
|
93
|
+
the registry nothing. What it says and throws names the train.
|
|
94
|
+
|
|
95
|
+
#### Parameters
|
|
96
|
+
|
|
97
|
+
##### pluginConfig
|
|
98
|
+
|
|
99
|
+
[`OciPluginOptions`](../interfaces/OciPluginOptions.md)
|
|
100
|
+
|
|
101
|
+
The plugin's options of the config, with `trains` of its root.
|
|
102
|
+
|
|
103
|
+
##### context
|
|
104
|
+
|
|
105
|
+
`VerifyReleaseContext` & `OfRun`
|
|
106
|
+
|
|
107
|
+
The context of semantic-release's `verifyRelease` step: the folder, the
|
|
108
|
+
environment and the logger of the run, and the next release.
|
|
109
|
+
|
|
110
|
+
#### Returns
|
|
111
|
+
|
|
112
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
[**Release trains**](../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../README.md) / [@wtf/semantic-release-oci](../README.md) / publish
|
|
6
|
+
|
|
7
|
+
# Variable: publish
|
|
8
|
+
|
|
9
|
+
> `const` **publish**: (`pluginConfig`, `context`) => `Promise`\<[`OciRelease`](../interfaces/OciRelease.md) \| `false`\>
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/semantic-release-oci/src/index.ts:390](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L390)
|
|
12
|
+
|
|
13
|
+
Copies the tested image of each image of the release to the tags of the release, by the steps
|
|
14
|
+
`publish` and `move` of the ecosystem of OCI images, which `verifyRelease` verified: its version, skipped of a registry
|
|
15
|
+
that has it at the same digest, so a release that stopped part way is finished by running it
|
|
16
|
+
again; and of a release, its minor and its major, pointed at the version. Each image is given its
|
|
17
|
+
page in the container registry of GitLab, asked by a token of `GL_TOKEN` or `GITLAB_TOKEN`, and
|
|
18
|
+
recorded for the links of the release of the host; and the images it published are written to
|
|
19
|
+
the dotenv file of `dotenv`.
|
|
20
|
+
|
|
21
|
+
## Parameters
|
|
22
|
+
|
|
23
|
+
### pluginConfig
|
|
24
|
+
|
|
25
|
+
[`OciPluginOptions`](../interfaces/OciPluginOptions.md)
|
|
26
|
+
|
|
27
|
+
The plugin's options of the config, with `trains` of its root.
|
|
28
|
+
|
|
29
|
+
### context
|
|
30
|
+
|
|
31
|
+
`PublishContext` & `OfRun`
|
|
32
|
+
|
|
33
|
+
The context of semantic-release's `publish` step: the folder, the environment,
|
|
34
|
+
the options and the logger of the run, and the next release.
|
|
35
|
+
|
|
36
|
+
## Returns
|
|
37
|
+
|
|
38
|
+
`Promise`\<[`OciRelease`](../interfaces/OciRelease.md) \| `false`\>
|
|
39
|
+
|
|
40
|
+
The release of the images, named of each image at its version, and linked to the
|
|
41
|
+
first's page; `false` of a train of no image to tag.
|
|
42
|
+
|
|
43
|
+
## Throws
|
|
44
|
+
|
|
45
|
+
`EOCIIMAGE` of an image of no repository, `EOCISOURCE` of no tag of the tested image,
|
|
46
|
+
`EOCISMOKE` of a tested image the registry has not, `EOCIRETAG` of a version the registry has at
|
|
47
|
+
another digest, `EOCITAG` of a copy crane cannot make, `EOCILINK` of a page GitLab cannot give.
|
|
@@ -4,17 +4,19 @@
|
|
|
4
4
|
|
|
5
5
|
[Release trains](../../../README.md) / [@wtf/semantic-release-oci](../README.md) / verifyConditions
|
|
6
6
|
|
|
7
|
-
#
|
|
7
|
+
# Variable: verifyConditions
|
|
8
8
|
|
|
9
|
-
> **verifyConditions
|
|
9
|
+
> `const` **verifyConditions**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-oci/src/index.ts:
|
|
11
|
+
Defined in: [packages/semantic-release-oci/src/index.ts:298](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L298)
|
|
12
12
|
|
|
13
13
|
Checks the options of the plugin, by `ociSchema` of `./schema` (`EOPTIONS`), that `ecosystems`
|
|
14
14
|
lists `@wtf/semantic-release-oci/ecosystem` or `@wtf/release-oci` (`EOCIECOSYSTEM`), and the train
|
|
15
15
|
of the run (`ETRAINNOTSELECTED`, `ETRAINUNKNOWN`); that no image is of two trains
|
|
16
|
-
(`ETRAINOVERLAP`); and that each image of the train has a repository (`EOCIIMAGE`).
|
|
17
|
-
registry
|
|
16
|
+
(`ETRAINOVERLAP`); and that each image of the train has a repository (`EOCIIMAGE`). Then that
|
|
17
|
+
the run may read the API of the container registry, which the links of `publish` need, by one
|
|
18
|
+
request of no effect (`EOCILINK`): of a token of `GL_TOKEN` or `GITLAB_TOKEN`, which a dry run of
|
|
19
|
+
none, as of a merge request, only warns of. It asks crane nothing.
|
|
18
20
|
|
|
19
21
|
## Parameters
|
|
20
22
|
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
[**Release trains**](../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../README.md) / [@wtf/semantic-release-oci](../README.md) / verifyRelease
|
|
6
|
+
|
|
7
|
+
# Variable: verifyRelease
|
|
8
|
+
|
|
9
|
+
> `const` **verifyRelease**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/semantic-release-oci/src/index.ts:357](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L357)
|
|
12
|
+
|
|
13
|
+
Runs the step `verify` of the ecosystem of OCI images, once semantic-release knows the version of
|
|
14
|
+
the release: that the version and each tag that moves of it is a tag of an image, none given
|
|
15
|
+
twice (`EOCIVERSION`), and that each image of the train has a repository (`EOCIIMAGE`). It asks
|
|
16
|
+
the registry nothing. What it says and throws names the train.
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
### pluginConfig
|
|
21
|
+
|
|
22
|
+
[`OciPluginOptions`](../interfaces/OciPluginOptions.md)
|
|
23
|
+
|
|
24
|
+
The plugin's options of the config, with `trains` of its root.
|
|
25
|
+
|
|
26
|
+
### context
|
|
27
|
+
|
|
28
|
+
`VerifyReleaseContext` & `OfRun`
|
|
29
|
+
|
|
30
|
+
The context of semantic-release's `verifyRelease` step: the folder, the
|
|
31
|
+
environment and the logger of the run, and the next release.
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
`Promise`\<`void`\>
|
|
@@ -50,20 +50,20 @@ export default {
|
|
|
50
50
|
|
|
51
51
|
List it before `@semantic-release/git`, whose `assets` hold the files it replaces.
|
|
52
52
|
|
|
53
|
-
##
|
|
53
|
+
## Type Aliases
|
|
54
54
|
|
|
55
|
-
- [ReplacePluginOptions](
|
|
55
|
+
- [ReplacePluginOptions](type-aliases/ReplacePluginOptions.md)
|
|
56
56
|
|
|
57
57
|
## Variables
|
|
58
58
|
|
|
59
59
|
- [default](variables/default.md)
|
|
60
|
+
- [prepare](variables/prepare.md)
|
|
61
|
+
- [verifyConditions](variables/verifyConditions.md)
|
|
60
62
|
|
|
61
63
|
## Functions
|
|
62
64
|
|
|
63
65
|
- [functionOf](functions/functionOf.md)
|
|
64
|
-
- [prepare](functions/prepare.md)
|
|
65
66
|
- [templatesOf](functions/templatesOf.md)
|
|
66
|
-
- [verifyConditions](functions/verifyConditions.md)
|
|
67
67
|
|
|
68
68
|
## References
|
|
69
69
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **functionOf**(`spec`, `cwd`): `Promise`\<[`ReplaceFunction`](../../release-replace/type-aliases/ReplaceFunction.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/index.ts:
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/index.ts:163](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/index.ts#L163)
|
|
12
12
|
|
|
13
13
|
The function `spec` names, its module imported once a process. Throws `EREPLACEMODULE` of a
|
|
14
14
|
module that cannot be loaded, or an export of no function.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **templatesOf**(`option`, `cwd`): `Promise`\<`Readonly`\<`Record`\<`string`, [`ReplacementOf`](../../release-replace/interfaces/ReplacementOf.md)\<[`PluginTo`](../schema/type-aliases/PluginTo.md)\>\>\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/index.ts:
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/index.ts:207](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/index.ts#L207)
|
|
12
12
|
|
|
13
13
|
The templates of `option`, of the root of the config or of an entry: each set, the export of a
|
|
14
14
|
module (`exportedSetSchema` of `./schema`) or a map of each by its name, a replacement or the
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# @wtf/semantic-release-replace/schema
|
|
8
8
|
|
|
9
|
-
The schema of the options of the plugin, as validators of `@wtf/release
|
|
9
|
+
The schema of the options of the plugin, as validators of `@wtf/release/validator`: each a
|
|
10
10
|
Standard Schema, and a Standard JSON Schema of the JSON Schema of what it checks.
|
|
11
11
|
|
|
12
12
|
- [replaceOptionsSchema](variables/replaceOptionsSchema.md): the options of its entry, `files`, `replacements` and
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ModuleExport
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L58)
|
|
10
10
|
|
|
11
11
|
An export of a module, as a config of JSON names a function, a template or a set of templates of
|
|
12
12
|
one: the module, by its path from the root of the repo or the name of a package, and the name of
|
|
@@ -18,7 +18,7 @@ its export, `default` by default.
|
|
|
18
18
|
|
|
19
19
|
> `readonly` `optional` **export?**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
21
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L62)
|
|
22
22
|
|
|
23
23
|
The name of its export: `default` by default.
|
|
24
24
|
|
|
@@ -28,6 +28,6 @@ The name of its export: `default` by default.
|
|
|
28
28
|
|
|
29
29
|
> `readonly` **module**: `string`
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
31
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L60)
|
|
32
32
|
|
|
33
33
|
The module, by its path from the root of the repo (`./`, `../` or absolute), or a package.
|
|
@@ -6,21 +6,17 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ReplaceOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L90)
|
|
10
10
|
|
|
11
11
|
The options of an entry of the plugin.
|
|
12
12
|
|
|
13
|
-
## Extended by
|
|
14
|
-
|
|
15
|
-
- [`ReplacePluginOptions`](../../interfaces/ReplacePluginOptions.md)
|
|
16
|
-
|
|
17
13
|
## Properties
|
|
18
14
|
|
|
19
15
|
### files
|
|
20
16
|
|
|
21
17
|
> `readonly` **files**: readonly `string`[]
|
|
22
18
|
|
|
23
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L96)
|
|
24
20
|
|
|
25
21
|
The files, from the root of the repo, of the files git tracks, in order: each a path, a glob,
|
|
26
22
|
or of `!` first a negation of what the entries before it hold. A folder holds each file under
|
|
@@ -32,7 +28,7 @@ it.
|
|
|
32
28
|
|
|
33
29
|
> `readonly` **replacements**: readonly [`PluginReplacementSpec`](../type-aliases/PluginReplacementSpec.md)[]
|
|
34
30
|
|
|
35
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
31
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L101)
|
|
36
32
|
|
|
37
33
|
The replacements of each file, in order: each whole; or of a template, `{ template, … }`, each
|
|
38
34
|
option beside its name over the template's own; or the name of a template alone.
|
|
@@ -43,7 +39,7 @@ option beside its name over the template's own; or the name of a template alone.
|
|
|
43
39
|
|
|
44
40
|
> `readonly` `optional` **templates?**: [`TemplatesOption`](../type-aliases/TemplatesOption.md)
|
|
45
41
|
|
|
46
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:106](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
42
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:106](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L106)
|
|
47
43
|
|
|
48
44
|
The templates a replacement names, each by its name, over those of the root of the config of
|
|
49
45
|
the same name: a set, or sets merged in order; none by default.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: RootTemplates
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:278](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:278](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L278)
|
|
10
10
|
|
|
11
11
|
The root of a config, as the plugin reads it: its `templates`, which every entry may name.
|
|
12
12
|
|
|
@@ -16,6 +16,6 @@ The root of a config, as the plugin reads it: its `templates`, which every entry
|
|
|
16
16
|
|
|
17
17
|
> `readonly` `optional` **templates?**: [`TemplatesOption`](../type-aliases/TemplatesOption.md)
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:280](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:280](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L280)
|
|
20
20
|
|
|
21
21
|
The templates of every entry of the plugin: a set, or sets merged in order.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **PluginReplacement** = [`ReplacementOf`](../../../release-replace/interfaces/ReplacementOf.md)\<[`PluginTo`](PluginTo.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L72)
|
|
12
12
|
|
|
13
13
|
A replacement of the plugin: what it matches, what it replaces each match by, and its escape.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **PluginReplacementSpec** = [`ReplacementSpec`](../../../release-replace/type-aliases/ReplacementSpec.md)\<[`PluginTo`](PluginTo.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L75)
|
|
12
12
|
|
|
13
13
|
A replacement of the plugin as its options list it: whole, or of a template.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **PluginTemplates** = [`Templates`](../../../release-replace/type-aliases/Templates.md)\<[`PluginTo`](PluginTo.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L78)
|
|
12
12
|
|
|
13
13
|
The templates of the plugin, each a replacement, by its name, as the library takes them.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **PluginTo** = `string` \| [`ModuleExport`](../interfaces/ModuleExport.md) \| [`ReplaceFunction`](../../../release-replace/type-aliases/ReplaceFunction.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L69)
|
|
12
12
|
|
|
13
13
|
What a replacement of the plugin replaces each match by: a text; a function of a module, which
|
|
14
14
|
the plugin imports; or a function, of a config of JavaScript.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **TemplateSet** = [`ModuleExport`](../interfaces/ModuleExport.md) \| `Readonly`\<`Record`\<`string`, [`PluginReplacement`](PluginReplacement.md) \| [`ModuleExport`](../interfaces/ModuleExport.md)\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L84)
|
|
12
12
|
|
|
13
13
|
A set of templates as a config gives it: each by its name, a replacement or the export of a
|
|
14
14
|
module that is one; or the export of a module that is a set of replacements, each by its name.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **TemplatesOption** = [`TemplateSet`](TemplateSet.md) \| readonly [`TemplateSet`](TemplateSet.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L87)
|
|
12
12
|
|
|
13
13
|
The templates as a config gives them: a set, or sets merged in order, each over those before.
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
# Variable: configSchema
|
|
8
8
|
|
|
9
|
-
> `const` **configSchema**: [`Validator`](../../../release
|
|
9
|
+
> `const` **configSchema**: [`Validator`](../../../release/validator/interfaces/Validator.md)\<`object`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:292](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:292](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L292)
|
|
12
12
|
|
|
13
13
|
This package's part of a whole config of semantic-release: `templates` of its root, and each
|
|
14
14
|
entry of `plugins` of the plugin.
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
# Variable: exportedSetSchema
|
|
8
8
|
|
|
9
|
-
> `const` **exportedSetSchema**: [`Validator`](../../../release
|
|
9
|
+
> `const` **exportedSetSchema**: [`Validator`](../../../release/validator/interfaces/Validator.md)\<`Record`\<`string`, [`PluginReplacement`](../type-aliases/PluginReplacement.md)\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:209](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:209](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L209)
|
|
12
12
|
|
|
13
13
|
The validator of a set of templates a module exports: each a replacement whole, by its name.
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
# Variable: jsonSchema
|
|
8
8
|
|
|
9
|
-
> `const` **jsonSchema**: [`JsonSchema`](../../../release
|
|
9
|
+
> `const` **jsonSchema**: [`JsonSchema`](../../../release/validator/type-aliases/JsonSchema.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:298](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:298](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L298)
|
|
12
12
|
|
|
13
13
|
The JSON Schema of [configSchema](configSchema.md), as the package publishes it, `schema.json`.
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
# Variable: replaceOptionsSchema
|
|
8
8
|
|
|
9
|
-
> `const` **replaceOptionsSchema**: [`Validator`](../../../release
|
|
9
|
+
> `const` **replaceOptionsSchema**: [`Validator`](../../../release/validator/interfaces/Validator.md)\<[`ReplaceOptions`](../interfaces/ReplaceOptions.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:253](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:253](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L253)
|
|
12
12
|
|
|
13
13
|
The validator of the options of an entry of the plugin: `files` and `replacements`, required.
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
# Variable: replacementSchema
|
|
8
8
|
|
|
9
|
-
> `const` **replacementSchema**: [`Validator`](../../../release
|
|
9
|
+
> `const` **replacementSchema**: [`Validator`](../../../release/validator/interfaces/Validator.md)\<[`PluginReplacementSpec`](../type-aliases/PluginReplacementSpec.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:162](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:162](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L162)
|
|
12
12
|
|
|
13
13
|
The validator of a replacement: whole, of `from`, `flags`, `to` and `escape`; of a template,
|
|
14
14
|
`{ template, … }`; or the name of a template alone. Which template a name is of is the run's to
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
# Variable: rootTemplatesSchema
|
|
8
8
|
|
|
9
|
-
> `const` **rootTemplatesSchema**: [`Validator`](../../../release
|
|
9
|
+
> `const` **rootTemplatesSchema**: [`Validator`](../../../release/validator/interfaces/Validator.md)\<[`RootTemplates`](../interfaces/RootTemplates.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:284](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:284](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L284)
|
|
12
12
|
|
|
13
13
|
The validator of the root of a config, as the plugin reads it: `templates`, optional.
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
# Variable: templateSchema
|
|
8
8
|
|
|
9
|
-
> `const` **templateSchema**: [`Validator`](../../../release
|
|
9
|
+
> `const` **templateSchema**: [`Validator`](../../../release/validator/interfaces/Validator.md)\<[`PluginReplacement`](../type-aliases/PluginReplacement.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:202](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:202](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L202)
|
|
12
12
|
|
|
13
13
|
The validator of a replacement whole a template is, as a module exports one: its `to` a text, a
|
|
14
14
|
function or the function of a module; a RegExp that is one, and no escape of a function.
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
# Variable: templatesSchema
|
|
8
8
|
|
|
9
|
-
> `const` **templatesSchema**: [`Validator`](../../../release
|
|
9
|
+
> `const` **templatesSchema**: [`Validator`](../../../release/validator/interfaces/Validator.md)\<[`TemplatesOption`](../type-aliases/TemplatesOption.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:243](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:243](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/schema.ts#L243)
|
|
12
12
|
|
|
13
13
|
The validator of the templates of a config, of its root or of an entry of the plugin: a set, or
|
|
14
14
|
an array of sets, merged in order, each over those before it.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**Release trains**](../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../README.md) / [@wtf/semantic-release-replace](../README.md) / ReplacePluginOptions
|
|
6
|
+
|
|
7
|
+
# Type Alias: ReplacePluginOptions
|
|
8
|
+
|
|
9
|
+
> **ReplacePluginOptions** = [`ReplaceOptions`](../schema/interfaces/ReplaceOptions.md)
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/index.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/index.ts#L88)
|
|
12
|
+
|
|
13
|
+
The options of the plugin, its own.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **default**: `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/index.ts:
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/index.ts:322](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/index.ts#L322)
|
|
12
12
|
|
|
13
13
|
## Type Declaration
|
|
14
14
|
|
|
@@ -23,10 +23,10 @@ text changes, each said; and says so of none.
|
|
|
23
23
|
|
|
24
24
|
##### pluginConfig
|
|
25
25
|
|
|
26
|
-
[`
|
|
26
|
+
[`ReplaceOptions`](../schema/interfaces/ReplaceOptions.md)
|
|
27
27
|
|
|
28
28
|
The plugin's options of the config: `files`, `replacements`, `templates`,
|
|
29
|
-
and the
|
|
29
|
+
and the platform it runs by.
|
|
30
30
|
|
|
31
31
|
##### context
|
|
32
32
|
|
|
@@ -52,10 +52,10 @@ the template of each name (`ETEMPLATE`): so a run fails before it releases.
|
|
|
52
52
|
|
|
53
53
|
##### pluginConfig
|
|
54
54
|
|
|
55
|
-
[`
|
|
55
|
+
[`ReplaceOptions`](../schema/interfaces/ReplaceOptions.md)
|
|
56
56
|
|
|
57
57
|
The plugin's options of the config: `files`, `replacements`, `templates`,
|
|
58
|
-
and the
|
|
58
|
+
and the platform it runs by.
|
|
59
59
|
|
|
60
60
|
##### context
|
|
61
61
|
|
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
[Release trains](../../../README.md) / [@wtf/semantic-release-replace](../README.md) / prepare
|
|
6
6
|
|
|
7
|
-
#
|
|
7
|
+
# Variable: prepare
|
|
8
8
|
|
|
9
|
-
> **prepare
|
|
9
|
+
> `const` **prepare**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/index.ts:
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/index.ts:302](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/index.ts#L302)
|
|
12
12
|
|
|
13
13
|
Replaces each match of each replacement of each file of the plugin, and writes each file whose
|
|
14
14
|
text changes, each said; and says so of none.
|
|
@@ -17,14 +17,14 @@ text changes, each said; and says so of none.
|
|
|
17
17
|
|
|
18
18
|
### pluginConfig
|
|
19
19
|
|
|
20
|
-
[`ReplacePluginOptions`](../
|
|
20
|
+
[`ReplacePluginOptions`](../type-aliases/ReplacePluginOptions.md)
|
|
21
21
|
|
|
22
22
|
The plugin's options of the config: `files`, `replacements`, `templates`,
|
|
23
|
-
and the
|
|
23
|
+
and the platform it runs by.
|
|
24
24
|
|
|
25
25
|
### context
|
|
26
26
|
|
|
27
|
-
`
|
|
27
|
+
`PrepareContext` & `OfRun`
|
|
28
28
|
|
|
29
29
|
The context of semantic-release's step `prepare`: what a function is given
|
|
30
30
|
whole, and a text reads but `env`, as `nextRelease` and `branch`.
|
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
[Release trains](../../../README.md) / [@wtf/semantic-release-replace](../README.md) / verifyConditions
|
|
6
6
|
|
|
7
|
-
#
|
|
7
|
+
# Variable: verifyConditions
|
|
8
8
|
|
|
9
|
-
> **verifyConditions
|
|
9
|
+
> `const` **verifyConditions**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/index.ts:
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/index.ts:285](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-replace/src/index.ts#L285)
|
|
12
12
|
|
|
13
13
|
Checks the options of the plugin, by `replaceOptionsSchema` of `./schema`, and the templates of
|
|
14
14
|
the root (`EOPTIONS`); imports each template, set of templates and function of a module
|
|
@@ -19,10 +19,10 @@ the template of each name (`ETEMPLATE`): so a run fails before it releases.
|
|
|
19
19
|
|
|
20
20
|
### pluginConfig
|
|
21
21
|
|
|
22
|
-
[`ReplacePluginOptions`](../
|
|
22
|
+
[`ReplacePluginOptions`](../type-aliases/ReplacePluginOptions.md)
|
|
23
23
|
|
|
24
24
|
The plugin's options of the config: `files`, `replacements`, `templates`,
|
|
25
|
-
and the
|
|
25
|
+
and the platform it runs by.
|
|
26
26
|
|
|
27
27
|
### context
|
|
28
28
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **skipPlugins**\<`T`\>(`plugins`, `pattern`, `options`): `T`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:270](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:270](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-trains/src/config.ts#L270)
|
|
12
12
|
|
|
13
13
|
The entries of `plugins` but those whose step id ([stepId](stepId.md)) `pattern` matches, the source
|
|
14
14
|
of a RegExp, unanchored, so `exec` matches every step of `@semantic-release/exec`: pin the end of a
|