@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
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
[**Release trains**](../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../README.md) / [@wtf/semantic-release-go](../README.md) / prepare
|
|
6
|
+
|
|
7
|
+
# Variable: prepare
|
|
8
|
+
|
|
9
|
+
> `const` **prepare**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/semantic-release-go/src/index.ts:326](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-go/src/index.ts#L326)
|
|
12
|
+
|
|
13
|
+
Runs the ecosystem's `prepare`, of the release `verifyRelease` verified: writes the version of the release into
|
|
14
|
+
each require of a module of the train, and the last release of each other train into each require
|
|
15
|
+
of its modules, in every go.mod of the repo; and reads them again: a require that is not at the
|
|
16
|
+
version of its train fails the run here, before the tags.
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
### pluginConfig
|
|
21
|
+
|
|
22
|
+
[`GoPluginOptions`](../interfaces/GoPluginOptions.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 `prepare` step: the folder, the environment
|
|
31
|
+
and the logger of the run, and the next release.
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
`Promise`\<`void`\>
|
|
36
|
+
|
|
37
|
+
## Throws
|
|
38
|
+
|
|
39
|
+
`EDEPENDENCYNOTRAIN` and `EDEPENDENCYNORELEASE` of a require of a module of no release,
|
|
40
|
+
`EGOVERSION` of a require at another version after the stamp.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
[**Release trains**](../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../README.md) / [@wtf/semantic-release-go](../README.md) / publish
|
|
6
|
+
|
|
7
|
+
# Variable: publish
|
|
8
|
+
|
|
9
|
+
> `const` **publish**: (`pluginConfig`, `context`) => `Promise`\<`false` \| [`GoRelease`](../interfaces/GoRelease.md)\>
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/semantic-release-go/src/index.ts:360](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-go/src/index.ts#L360)
|
|
12
|
+
|
|
13
|
+
Runs the ecosystem's `publish`, which tags the modules of the release: a commit of the stamped
|
|
14
|
+
go.mod files on top of `HEAD`, on no branch, tagged with the tag of each module the remote lacks,
|
|
15
|
+
and the tags pushed to `repositoryUrl` of the run in one atomic push; each the remote has is
|
|
16
|
+
skipped. Then, of the option `proxy`, it asks the Go proxy for each module at its version. Each
|
|
17
|
+
module is recorded for the links of the release of the host.
|
|
18
|
+
|
|
19
|
+
## Parameters
|
|
20
|
+
|
|
21
|
+
### pluginConfig
|
|
22
|
+
|
|
23
|
+
[`GoPluginOptions`](../interfaces/GoPluginOptions.md)
|
|
24
|
+
|
|
25
|
+
The plugin's options of the config, with `trains` of its root.
|
|
26
|
+
|
|
27
|
+
### context
|
|
28
|
+
|
|
29
|
+
`VerifyReleaseContext` & `OfRun`
|
|
30
|
+
|
|
31
|
+
The context of semantic-release's `publish` step: the folder, the environment,
|
|
32
|
+
the options and the logger of the run, and the next release.
|
|
33
|
+
|
|
34
|
+
## Returns
|
|
35
|
+
|
|
36
|
+
`Promise`\<`false` \| [`GoRelease`](../interfaces/GoRelease.md)\>
|
|
37
|
+
|
|
38
|
+
The release of the modules, named of each module, and of `proxy` linked to the first's
|
|
39
|
+
page on pkg.go.dev; `false` of a train of no module to tag.
|
|
40
|
+
|
|
41
|
+
## Throws
|
|
42
|
+
|
|
43
|
+
`EGOVERSION` of a require not at its version, `EGOTAG` of a run of no `repositoryUrl`, a
|
|
44
|
+
remote that cannot be asked or a tag that cannot be made or pushed, `EGOPROXY` of a module the
|
|
45
|
+
proxy cannot give.
|
|
@@ -4,18 +4,19 @@
|
|
|
4
4
|
|
|
5
5
|
[Release trains](../../../README.md) / [@wtf/semantic-release-go](../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-go/src/index.ts:
|
|
11
|
+
Defined in: [packages/semantic-release-go/src/index.ts:277](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-go/src/index.ts#L277)
|
|
12
12
|
|
|
13
13
|
Checks the options of the plugin, by `goSchema` of `./schema` (`EOPTIONS`), that `ecosystems`
|
|
14
14
|
lists `@wtf/semantic-release-go/ecosystem` or `@wtf/release-go` (`EGOECOSYSTEM`), and the train of
|
|
15
|
-
the run (`ETRAINNOTSELECTED`, `ETRAINUNKNOWN`); that the go.mod files read
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
15
|
+
the run (`ETRAINNOTSELECTED`, `ETRAINUNKNOWN`); that the go.mod files read (`EGOMOD`); that no
|
|
16
|
+
module is of two trains (`ETRAINOVERLAP`), and each module of another train the modules of the
|
|
17
|
+
train require has a release, by the trains' own checks of the plan (`EDEPENDENCYNOTRAIN`,
|
|
18
|
+
`EDEPENDENCYNORELEASE`); and that the modules select: `EGOMODULES`, `EGOPRIVATE`. It asks the
|
|
19
|
+
remote nothing.
|
|
19
20
|
|
|
20
21
|
## Parameters
|
|
21
22
|
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
[**Release trains**](../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../README.md) / [@wtf/semantic-release-go](../README.md) / verifyRelease
|
|
6
|
+
|
|
7
|
+
# Variable: verifyRelease
|
|
8
|
+
|
|
9
|
+
> `const` **verifyRelease**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/semantic-release-go/src/index.ts:303](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-go/src/index.ts#L303)
|
|
12
|
+
|
|
13
|
+
Runs the ecosystem's `verify`, which semantic-release can by this step, as it knows the version:
|
|
14
|
+
the version is one Go tags a module of, and the path of each module of the release agrees with
|
|
15
|
+
its major; from v2 on, Go needs the path to end in `/v<major>`, and a path that ends in `/vN`
|
|
16
|
+
needs a release of the major N.
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
### pluginConfig
|
|
21
|
+
|
|
22
|
+
[`GoPluginOptions`](../interfaces/GoPluginOptions.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`\>
|
|
36
|
+
|
|
37
|
+
## Throws
|
|
38
|
+
|
|
39
|
+
`EGOSEMVER` of a version Go tags none of, `EGOMAJOR` of each module whose path does not
|
|
40
|
+
agree with the major, together.
|
|
@@ -17,23 +17,35 @@ Maven (`mavenEcosystem` of `@wtf/release-maven/ecosystem`): the modules of the r
|
|
|
17
17
|
modules of the train, whose `paths` hold their folder (`ownersOf` of
|
|
18
18
|
`@wtf/release-trains/packages`).
|
|
19
19
|
|
|
20
|
+
Each step maps semantic-release's onto the contract of `@wtf/release/contract`: a `Release` of
|
|
21
|
+
the version of the next release, the dry run, the logger, and the folder and the platform of the
|
|
22
|
+
run, each line and error of it named by the train (`runOf` of `@wtf/semantic-release`,
|
|
23
|
+
`stepRelease` and `inTrain` of `@wtf/semantic-release/release`); and the plan of the train, by `planOf` of
|
|
24
|
+
`@wtf/release-trains/plan`, whose `own` is the plugin's selection of the modules of the train
|
|
25
|
+
(`selectArtifacts` and `publishOrder` of `@wtf/release-maven/artifacts`, of `include` and
|
|
26
|
+
`exclude`), and whose `versions` hold each module of a train, those that do not deploy too, at
|
|
27
|
+
the version of its train. Then it runs the step of the ecosystem of Maven:
|
|
28
|
+
|
|
20
29
|
- `verifyConditions` checks the options, reads the poms, selects the modules the release deploys
|
|
21
|
-
and puts them in order,
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
30
|
+
and puts them in order, and works out the plan, of no version yet, which reads the last release
|
|
31
|
+
of each other train, by its tags;
|
|
32
|
+
- `verifyRelease` runs `verify`, once the version is known, which checks it by Maven's rules and
|
|
33
|
+
finds the repository of each module, so a repo that cannot be deployed fails before the tag;
|
|
34
|
+
- `prepare` runs `prepare`, which writes the version of the release into the poms of the train,
|
|
35
|
+
and the last release of each other train into its poms, and each into the parents, dependencies
|
|
36
|
+
and plugins that name them, and reads the poms again, so a module that is not at the version of
|
|
37
|
+
its train fails the run;
|
|
38
|
+
- `publish` runs `publish`, which asks the repository of each module whether it has its pom, then
|
|
39
|
+
deploys each it lacks, in the order of their dependencies, by `mvn -B -N -f <dir>/pom.xml
|
|
40
|
+
deploy`, and skips each it has, so a release that stopped part way is finished by running it
|
|
41
|
+
again, each module the release needs to build and neither deploys nor finds served installed
|
|
42
|
+
before it (`installsOf` of `@wtf/release-maven/artifacts`); and records each module for the
|
|
43
|
+
links of the release of the host (`recordReleased` of `@wtf/semantic-release/links`): its page
|
|
44
|
+
on Maven Central, the repository it was deployed to, as a Maven registry of GitLab, and its
|
|
45
|
+
jar, where the build left one.
|
|
46
|
+
|
|
47
|
+
A dry run of semantic-release runs `verifyConditions` and `verifyRelease` alone of these: it skips
|
|
48
|
+
`prepare` and `publish`, so it stamps and deploys nothing.
|
|
37
49
|
|
|
38
50
|
Maven reads the credentials of the repository of the `<server>` of its settings of the
|
|
39
51
|
repository's `id`, which the job writes, as `-s ci_settings.xml` of `args`. The plugin asks the
|
|
@@ -60,17 +72,23 @@ export default {
|
|
|
60
72
|
|
|
61
73
|
## Interfaces
|
|
62
74
|
|
|
63
|
-
- [LookupAuth](interfaces/LookupAuth.md)
|
|
64
75
|
- [MavenPluginOptions](interfaces/MavenPluginOptions.md)
|
|
65
76
|
- [MavenRelease](interfaces/MavenRelease.md)
|
|
66
77
|
|
|
67
78
|
## Variables
|
|
68
79
|
|
|
69
80
|
- [default](variables/default.md)
|
|
81
|
+
- [prepare](variables/prepare.md)
|
|
82
|
+
- [publish](variables/publish.md)
|
|
83
|
+
- [verifyConditions](variables/verifyConditions.md)
|
|
84
|
+
- [verifyRelease](variables/verifyRelease.md)
|
|
70
85
|
|
|
71
86
|
## Functions
|
|
72
87
|
|
|
73
88
|
- [pomLookup](functions/pomLookup.md)
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
89
|
+
|
|
90
|
+
## References
|
|
91
|
+
|
|
92
|
+
### LookupAuth
|
|
93
|
+
|
|
94
|
+
Re-exports [LookupAuth](../release-maven/repository/interfaces/LookupAuth.md)
|
|
@@ -8,10 +8,10 @@
|
|
|
8
8
|
|
|
9
9
|
> **pomLookup**(`url`, `headers?`): `Promise`\<`boolean`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
11
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:262](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L262)
|
|
12
12
|
|
|
13
|
-
Asks the repository at `url` whether it has the pom there, by a `HEAD` of `fetch` of the
|
|
14
|
-
`headers`, which no error names.
|
|
13
|
+
Asks the repository at `url` whether it has the pom there, by a `HEAD` of Node's `fetch` of the
|
|
14
|
+
headers `headers`, which no error names (`lookupPom` of `@wtf/release-maven/repository`).
|
|
15
15
|
|
|
16
16
|
## Parameters
|
|
17
17
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: MavenPluginOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
9
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:109](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L109)
|
|
10
10
|
|
|
11
11
|
The options of the plugin, in the config of semantic-release or at its root.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ The options of the plugin, in the config of semantic-release or at its root.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` `optional` **args?**: readonly `string`[]
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
19
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:145](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L145)
|
|
20
20
|
|
|
21
21
|
The arguments of each deploy after its goal, as `["-s", "ci_settings.xml", "-P", "release"]`.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ The arguments of each deploy after its goal, as `["-s", "ci_settings.xml", "-P",
|
|
|
26
26
|
|
|
27
27
|
> `readonly` `optional` **command?**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
29
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:143](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L143)
|
|
30
30
|
|
|
31
31
|
Maven, as it is run: `mvn` by default, or a wrapper, as `./mvnw`.
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ Maven, as it is run: `mvn` by default, or a wrapper, as `./mvnw`.
|
|
|
36
36
|
|
|
37
37
|
> `readonly` **ecosystems**: readonly `string`[]
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
39
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:118](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L118)
|
|
40
40
|
|
|
41
41
|
The ecosystems of the repo, of the root of the config, which the trains read the packages of:
|
|
42
42
|
`'@wtf/semantic-release-maven/ecosystem'` or `'@wtf/release-maven'` among them, or
|
|
@@ -49,7 +49,7 @@ deploys.
|
|
|
49
49
|
|
|
50
50
|
> `readonly` `optional` **exclude?**: readonly `string`[]
|
|
51
51
|
|
|
52
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
52
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:127](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L127)
|
|
53
53
|
|
|
54
54
|
The modules of the train not to deploy, by `groupId:artifactId`, as a module of samples.
|
|
55
55
|
|
|
@@ -59,7 +59,7 @@ The modules of the train not to deploy, by `groupId:artifactId`, as a module of
|
|
|
59
59
|
|
|
60
60
|
> `readonly` `optional` **include?**: readonly `string`[]
|
|
61
61
|
|
|
62
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
62
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:125](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L125)
|
|
63
63
|
|
|
64
64
|
The modules of the train to deploy, by `groupId:artifactId`: every module of it that deploys by
|
|
65
65
|
default.
|
|
@@ -70,7 +70,7 @@ default.
|
|
|
70
70
|
|
|
71
71
|
> `readonly` `optional` **lookup?**: `string`
|
|
72
72
|
|
|
73
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
73
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:139](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L139)
|
|
74
74
|
|
|
75
75
|
The base URL the plugin asks for each pom: where each module deploys by default. Maven
|
|
76
76
|
Central, which deploys by the Central Portal, is read at `https://repo1.maven.org/maven2`.
|
|
@@ -79,9 +79,9 @@ Central, which deploys by the Central Portal, is read at `https://repo1.maven.or
|
|
|
79
79
|
|
|
80
80
|
### lookupAuth?
|
|
81
81
|
|
|
82
|
-
> `readonly` `optional` **lookupAuth?**: [`LookupAuth`](LookupAuth.md)
|
|
82
|
+
> `readonly` `optional` **lookupAuth?**: [`LookupAuth`](../../release-maven/repository/interfaces/LookupAuth.md)
|
|
83
83
|
|
|
84
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
84
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:141](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L141)
|
|
85
85
|
|
|
86
86
|
The header each lookup sends, and the variable of its value: none by default.
|
|
87
87
|
|
|
@@ -91,7 +91,7 @@ The header each lookup sends, and the variable of its value: none by default.
|
|
|
91
91
|
|
|
92
92
|
> `readonly` `optional` **repository?**: [`Repository`](../../release-maven/repository/interfaces/Repository.md)
|
|
93
93
|
|
|
94
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
94
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:134](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L134)
|
|
95
95
|
|
|
96
96
|
The repository every module deploys to, as Maven's `altDeploymentRepository`, its `url` of
|
|
97
97
|
`${env.NAME}` of the environment: by default, each module's own of its
|
|
@@ -100,21 +100,11 @@ The repository every module deploys to, as Maven's `altDeploymentRepository`, it
|
|
|
100
100
|
|
|
101
101
|
***
|
|
102
102
|
|
|
103
|
-
### system?
|
|
104
|
-
|
|
105
|
-
> `readonly` `optional` **system?**: [`SystemInput`](../../release-system/system/type-aliases/SystemInput.md)
|
|
106
|
-
|
|
107
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:133](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/semantic-release-maven/src/index.ts#L133)
|
|
108
|
-
|
|
109
|
-
The system the plugin runs by, over Node's.
|
|
110
|
-
|
|
111
|
-
***
|
|
112
|
-
|
|
113
103
|
### train?
|
|
114
104
|
|
|
115
105
|
> `readonly` `optional` **train?**: `string`
|
|
116
106
|
|
|
117
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
107
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:120](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L120)
|
|
118
108
|
|
|
119
109
|
The train of the run: `RELEASE_TRAIN` of the environment of the run by default.
|
|
120
110
|
|
|
@@ -124,6 +114,6 @@ The train of the run: `RELEASE_TRAIN` of the environment of the run by default.
|
|
|
124
114
|
|
|
125
115
|
> `readonly` **trains**: [`Trains`](../../release-trains/type-aliases/Trains.md)
|
|
126
116
|
|
|
127
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
117
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:111](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L111)
|
|
128
118
|
|
|
129
119
|
Every train of the repo: the modules of each are those whose folder its paths hold.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: MavenRelease
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
9
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:149](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L149)
|
|
10
10
|
|
|
11
11
|
The release the plugin gives semantic-release of the modules deployed.
|
|
12
12
|
|
|
@@ -16,6 +16,6 @@ The release the plugin gives semantic-release of the modules deployed.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **name**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
19
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:151](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L151)
|
|
20
20
|
|
|
21
21
|
The repository and the modules, as `gitlab-maven (org.acme:core, org.acme:client)`.
|
|
@@ -6,11 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
# @wtf/semantic-release-maven/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
|
- [mavenSchema](variables/mavenSchema.md): the options the plugin is given, of the root of the config, `trains`,
|
|
13
|
-
`ecosystems
|
|
13
|
+
`ecosystems` and `train`, and of its entry, as it checks them;
|
|
14
14
|
- [mavenOptionsSchema](variables/mavenOptionsSchema.md): the options of its entry, `include`, `exclude`, `repository`,
|
|
15
15
|
`lookup`, `lookupAuth`, `command` and `args`, its own;
|
|
16
16
|
- [configSchema](variables/configSchema.md): this package's part of a whole config of semantic-release, each entry of
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
# Type Alias: MavenOptions
|
|
8
8
|
|
|
9
|
-
> **MavenOptions** = `Omit`\<[`MavenPluginOptions`](../../interfaces/MavenPluginOptions.md), `"train"` \| `"trains"` \| `"ecosystems"
|
|
9
|
+
> **MavenOptions** = `Omit`\<[`MavenPluginOptions`](../../interfaces/MavenPluginOptions.md), `"train"` \| `"trains"` \| `"ecosystems"`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-maven/src/schema.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-maven/src/schema.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/schema.ts#L40)
|
|
12
12
|
|
|
13
13
|
The options of an entry of the plugin, its own: every one of the options but those of the root.
|
|
@@ -6,8 +6,8 @@
|
|
|
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-maven/src/schema.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-maven/src/schema.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/schema.ts#L78)
|
|
12
12
|
|
|
13
13
|
This package's part of a whole config of semantic-release: each entry of `plugins` of the plugin.
|
|
@@ -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-maven/src/schema.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-maven/src/schema.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/schema.ts#L84)
|
|
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: mavenOptionsSchema
|
|
8
8
|
|
|
9
|
-
> `const` **mavenOptionsSchema**: [`Validator`](../../../release
|
|
9
|
+
> `const` **mavenOptionsSchema**: [`Validator`](../../../release/validator/interfaces/Validator.md)\<[`MavenOptions`](../type-aliases/MavenOptions.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-maven/src/schema.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-maven/src/schema.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/schema.ts#L58)
|
|
12
12
|
|
|
13
13
|
The validator of the options of an entry of the plugin, its own.
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
# Variable: mavenSchema
|
|
8
8
|
|
|
9
|
-
> `const` **mavenSchema**: [`Validator`](../../../release
|
|
9
|
+
> `const` **mavenSchema**: [`Validator`](../../../release/validator/interfaces/Validator.md)\<[`RootOptions`](../../../release-trains/schema/interfaces/RootOptions.md) & [`MavenOptions`](../type-aliases/MavenOptions.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-maven/src/schema.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-maven/src/schema.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/schema.ts#L72)
|
|
12
12
|
|
|
13
13
|
The validator of the options the plugin is given: the root's, `trains` and `ecosystems` required,
|
|
14
14
|
and its own.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **default**: `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-maven/src/index.ts:
|
|
11
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:422](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L422)
|
|
12
12
|
|
|
13
13
|
## Type Declaration
|
|
14
14
|
|
|
@@ -16,10 +16,10 @@ Defined in: [packages/semantic-release-maven/src/index.ts:506](https://gitlab.co
|
|
|
16
16
|
|
|
17
17
|
> **prepare**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
train into its poms, and each into the parents, dependencies
|
|
21
|
-
the poms again: a module that is not at the version of its
|
|
22
|
-
property, fails the run here, before the tag's release.
|
|
19
|
+
Runs `prepare` of the ecosystem: writes the version of the release into the poms of the train,
|
|
20
|
+
and the last release of each other train into its poms, and each into the parents, dependencies
|
|
21
|
+
and plugins that name them; and reads the poms again: a module that is not at the version of its
|
|
22
|
+
train, as one whose version is of a property, fails the run here, before the tag's release.
|
|
23
23
|
|
|
24
24
|
#### Parameters
|
|
25
25
|
|
|
@@ -42,18 +42,19 @@ and the logger of the run, and the next release.
|
|
|
42
42
|
|
|
43
43
|
#### Throws
|
|
44
44
|
|
|
45
|
-
`EDEPENDENCYNOTRAIN` and `
|
|
46
|
-
`EMAVENSTAMP` of a pom that cannot be stamped, `EMAVENVERSION` of a
|
|
47
|
-
the stamp.
|
|
45
|
+
`EDEPENDENCYNOTRAIN`, `EDEPENDENCYNORELEASE` and `EDEPENDENCYUNSATISFIED` of a dependency
|
|
46
|
+
on a module of no release, `EMAVENSTAMP` of a pom that cannot be stamped, `EMAVENVERSION` of a
|
|
47
|
+
version Maven does not release, or of a module at another version after the stamp.
|
|
48
48
|
|
|
49
49
|
### publish
|
|
50
50
|
|
|
51
51
|
> **publish**: (`pluginConfig`, `context`) => `Promise`\<`false` \| [`MavenRelease`](../interfaces/MavenRelease.md)\>
|
|
52
52
|
|
|
53
|
-
|
|
54
|
-
the version of the release; each the repository has already is
|
|
55
|
-
needs to build and neither deploys nor finds served, as a test kit
|
|
56
|
-
installed before it (`installsOf` of `@wtf/release-maven/artifacts`).
|
|
53
|
+
Runs `publish` of the ecosystem: deploys each module of the release the repository lacks, in the
|
|
54
|
+
order of their dependencies, at the version of the release; each the repository has already is
|
|
55
|
+
skipped. A module the release needs to build and neither deploys nor finds served, as a test kit
|
|
56
|
+
of `maven.deploy.skip`, is installed before it (`installsOf` of `@wtf/release-maven/artifacts`).
|
|
57
|
+
Then it records each module deployed or skipped for the links of the release of the host.
|
|
57
58
|
|
|
58
59
|
#### Parameters
|
|
59
60
|
|
|
@@ -91,10 +92,9 @@ lists `@wtf/semantic-release-maven/ecosystem` or `@wtf/release-maven` (`EMAVENEC
|
|
|
91
92
|
train of the run (`ETRAINNOTSELECTED`, `ETRAINUNKNOWN`); that the poms read, and the modules of the
|
|
92
93
|
release select and order: `EMAVENPOM`, `EMAVENARTIFACTS`, `EMAVENPRIVATE`, `EMAVENORDER`; that no
|
|
93
94
|
module is of two trains (`ETRAINOVERLAP`), and each module of another train the modules of the
|
|
94
|
-
train depend on has a release, by the trains' own checks
|
|
95
|
-
`EDEPENDENCYNORELEASE`)
|
|
96
|
-
|
|
97
|
-
environment (`EMAVENREPOSITORY`), which a dry run only warns of. It asks the repository nothing.
|
|
95
|
+
train depend on has a release that satisfies it, by the trains' own checks
|
|
96
|
+
(`EDEPENDENCYNOTRAIN`, `EDEPENDENCYNORELEASE`, `EDEPENDENCYUNSATISFIED`). It checks no version
|
|
97
|
+
and no repository: `verifyRelease` does, once the version is known.
|
|
98
98
|
|
|
99
99
|
#### Parameters
|
|
100
100
|
|
|
@@ -114,3 +114,32 @@ environment and the logger of the run.
|
|
|
114
114
|
#### Returns
|
|
115
115
|
|
|
116
116
|
`Promise`\<`void`\>
|
|
117
|
+
|
|
118
|
+
### verifyRelease
|
|
119
|
+
|
|
120
|
+
> **verifyRelease**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
|
|
121
|
+
|
|
122
|
+
Runs `verify` of the ecosystem, once semantic-release knows the version of the release: that the
|
|
123
|
+
version is one Maven releases (`EMAVENVERSION`), and that each module has a repository to deploy
|
|
124
|
+
to, of `repository` or of its pom, but of a `lookup` and no `repository`, and that the variable
|
|
125
|
+
of `lookupAuth` is in the environment (`EMAVENREPOSITORY`), which a dry run only warns of. It asks
|
|
126
|
+
the repository nothing. What it says and throws names the train.
|
|
127
|
+
|
|
128
|
+
#### Parameters
|
|
129
|
+
|
|
130
|
+
##### pluginConfig
|
|
131
|
+
|
|
132
|
+
[`MavenPluginOptions`](../interfaces/MavenPluginOptions.md)
|
|
133
|
+
|
|
134
|
+
The plugin's options of the config, with `trains` of its root.
|
|
135
|
+
|
|
136
|
+
##### context
|
|
137
|
+
|
|
138
|
+
`VerifyReleaseContext` & `OfRun`
|
|
139
|
+
|
|
140
|
+
The context of semantic-release's `verifyRelease` step: the folder, the
|
|
141
|
+
environment and the logger of the run, and the next release.
|
|
142
|
+
|
|
143
|
+
#### Returns
|
|
144
|
+
|
|
145
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
[**Release trains**](../../../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Release trains](../../../README.md) / [@wtf/semantic-release-maven](../README.md) / prepare
|
|
6
|
+
|
|
7
|
+
# Variable: prepare
|
|
8
|
+
|
|
9
|
+
> `const` **prepare**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
|
|
10
|
+
|
|
11
|
+
Defined in: [packages/semantic-release-maven/src/index.ts:343](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L343)
|
|
12
|
+
|
|
13
|
+
Runs `prepare` of the ecosystem: writes the version of the release into the poms of the train,
|
|
14
|
+
and the last release of each other train into its poms, and each into the parents, dependencies
|
|
15
|
+
and plugins that name them; and reads the poms again: a module that is not at the version of its
|
|
16
|
+
train, as one whose version is of a property, fails the run here, before the tag's release.
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
### pluginConfig
|
|
21
|
+
|
|
22
|
+
[`MavenPluginOptions`](../interfaces/MavenPluginOptions.md)
|
|
23
|
+
|
|
24
|
+
The plugin's options of the config, with `trains` of its root.
|
|
25
|
+
|
|
26
|
+
### context
|
|
27
|
+
|
|
28
|
+
`PrepareContext` & `OfRun`
|
|
29
|
+
|
|
30
|
+
The context of semantic-release's `prepare` step: the folder, the environment
|
|
31
|
+
and the logger of the run, and the next release.
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
`Promise`\<`void`\>
|
|
36
|
+
|
|
37
|
+
## Throws
|
|
38
|
+
|
|
39
|
+
`EDEPENDENCYNOTRAIN`, `EDEPENDENCYNORELEASE` and `EDEPENDENCYUNSATISFIED` of a dependency
|
|
40
|
+
on a module of no release, `EMAVENSTAMP` of a pom that cannot be stamped, `EMAVENVERSION` of a
|
|
41
|
+
version Maven does not release, or of a module at another version after the stamp.
|