@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
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Publisher
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/types.ts:70](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/types.ts:70](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/types.ts#L70)
|
|
10
10
|
|
|
11
11
|
What publishes a package: the release asks it whether a version is published, and publishes each
|
|
12
12
|
that is not, in order. A publisher that packs ([Publisher.pack](#pack)) has every package packed
|
|
@@ -19,7 +19,7 @@ the registry.
|
|
|
19
19
|
|
|
20
20
|
> `readonly` **name**: `string`
|
|
21
21
|
|
|
22
|
-
Defined in: [packages/release-npm/src/types.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
22
|
+
Defined in: [packages/release-npm/src/types.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/types.ts#L72)
|
|
23
23
|
|
|
24
24
|
Its name, as the log says it: `npm`.
|
|
25
25
|
|
|
@@ -29,7 +29,7 @@ Its name, as the log says it: `npm`.
|
|
|
29
29
|
|
|
30
30
|
> **lookup**(`pkg`, `version`, `tag`, `context`, `registry?`): `Promise`\<[`Lookup`](Lookup.md)\>
|
|
31
31
|
|
|
32
|
-
Defined in: [packages/release-npm/src/types.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
32
|
+
Defined in: [packages/release-npm/src/types.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/types.ts#L88)
|
|
33
33
|
|
|
34
34
|
What the registry has of `pkg`, in one question: whether it has it at `version`, and the
|
|
35
35
|
version its dist-tag `tag` points at, where the publisher reads dist-tags; of the registry the
|
|
@@ -62,7 +62,7 @@ The dist-tag asked of, as `latest`.
|
|
|
62
62
|
|
|
63
63
|
[`PublisherContext`](PublisherContext.md)
|
|
64
64
|
|
|
65
|
-
The
|
|
65
|
+
The folder of the repo, the platform and the log the publisher runs in.
|
|
66
66
|
|
|
67
67
|
##### registry?
|
|
68
68
|
|
|
@@ -82,7 +82,7 @@ Whether the registry has the version, and the version the dist-tag points at.
|
|
|
82
82
|
|
|
83
83
|
> `optional` **pack**(`pkg`, `destination`, `context`): `Promise`\<`string`\>
|
|
84
84
|
|
|
85
|
-
Defined in: [packages/release-npm/src/types.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
85
|
+
Defined in: [packages/release-npm/src/types.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/types.ts#L113)
|
|
86
86
|
|
|
87
87
|
Packs `pkg` into the folder `destination`, and gives the tarball's path.
|
|
88
88
|
|
|
@@ -104,7 +104,7 @@ The folder the tarball is written in, absolute.
|
|
|
104
104
|
|
|
105
105
|
[`PublisherContext`](PublisherContext.md)
|
|
106
106
|
|
|
107
|
-
The
|
|
107
|
+
The folder of the repo, the platform and the log the publisher runs in.
|
|
108
108
|
|
|
109
109
|
#### Returns
|
|
110
110
|
|
|
@@ -118,7 +118,7 @@ The path of the tarball.
|
|
|
118
118
|
|
|
119
119
|
> `optional` **page**(`pkg`, `version`, `registry?`): `string` \| `undefined`
|
|
120
120
|
|
|
121
|
-
Defined in: [packages/release-npm/src/types.ts:140](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
121
|
+
Defined in: [packages/release-npm/src/types.ts:140](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/types.ts#L140)
|
|
122
122
|
|
|
123
123
|
The page of `pkg` at `version` on the registry, which the plugin gives as the release's URL.
|
|
124
124
|
|
|
@@ -154,7 +154,7 @@ The URL of the page, or `undefined` of a registry of no page.
|
|
|
154
154
|
|
|
155
155
|
> **publish**(`pkg`, `options`, `context`): `Promise`\<`void`\>
|
|
156
156
|
|
|
157
|
-
Defined in: [packages/release-npm/src/types.ts:104](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
157
|
+
Defined in: [packages/release-npm/src/types.ts:104](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/types.ts#L104)
|
|
158
158
|
|
|
159
159
|
Publishes `pkg`, or, of a dry run, says what it would publish. A version the registry has
|
|
160
160
|
already, as of another run that published it after this one's [Publisher.lookup](#lookup), is
|
|
@@ -178,7 +178,7 @@ Its dist-tag, its access, its provenance, its registry and its tarball.
|
|
|
178
178
|
|
|
179
179
|
[`PublisherContext`](PublisherContext.md)
|
|
180
180
|
|
|
181
|
-
The
|
|
181
|
+
The folder of the repo, the platform and the log the publisher runs in.
|
|
182
182
|
|
|
183
183
|
#### Returns
|
|
184
184
|
|
|
@@ -190,7 +190,7 @@ The system, the folder, the environment and the log the publisher runs in.
|
|
|
190
190
|
|
|
191
191
|
> `optional` **tag**(`pkg`, `version`, `tag`, `context`, `registry?`): `Promise`\<`void`\>
|
|
192
192
|
|
|
193
|
-
Defined in: [packages/release-npm/src/types.ts:125](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
193
|
+
Defined in: [packages/release-npm/src/types.ts:125](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/types.ts#L125)
|
|
194
194
|
|
|
195
195
|
Points the dist-tag `tag` of `pkg` at `version`, which the registry has already, as a release
|
|
196
196
|
moves to another channel; or, of a dry run, says what it would. A publisher without it moves no
|
|
@@ -220,7 +220,7 @@ The dist-tag to move, as `latest`.
|
|
|
220
220
|
|
|
221
221
|
[`PublisherContext`](PublisherContext.md)
|
|
222
222
|
|
|
223
|
-
The
|
|
223
|
+
The folder of the repo, the platform and the log the publisher runs in.
|
|
224
224
|
|
|
225
225
|
##### registry?
|
|
226
226
|
|
|
@@ -6,43 +6,32 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: PublisherContext
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/types.ts:
|
|
9
|
+
Defined in: [packages/release-npm/src/types.ts:21](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/types.ts#L21)
|
|
10
10
|
|
|
11
|
-
What a publisher runs in: the
|
|
11
|
+
What a publisher runs in: the folder of the repo, `root`, the platform, whose working folder is
|
|
12
|
+
the path of that folder and whose environment each program is given, and a log.
|
|
12
13
|
|
|
13
|
-
##
|
|
14
|
-
|
|
15
|
-
### cwd
|
|
16
|
-
|
|
17
|
-
> `readonly` **cwd**: `string`
|
|
14
|
+
## Extends
|
|
18
15
|
|
|
19
|
-
|
|
16
|
+
- [`RepoContext`](../../release/interfaces/RepoContext.md)\<[`ReleasePlatform`](../../release/type-aliases/ReleasePlatform.md)\>
|
|
20
17
|
|
|
21
|
-
|
|
18
|
+
## Properties
|
|
22
19
|
|
|
23
20
|
### dryRun
|
|
24
21
|
|
|
25
22
|
> `readonly` **dryRun**: `boolean`
|
|
26
23
|
|
|
27
|
-
Defined in: [packages/release-npm/src/types.ts:23](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
24
|
+
Defined in: [packages/release-npm/src/types.ts:23](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/types.ts#L23)
|
|
28
25
|
|
|
29
26
|
Whether the run publishes nothing for real, and only says what it would.
|
|
30
27
|
|
|
31
28
|
***
|
|
32
29
|
|
|
33
|
-
### env
|
|
34
|
-
|
|
35
|
-
> `readonly` **env**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
|
|
36
|
-
|
|
37
|
-
Defined in: [packages/release-npm/src/types.ts:21](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/types.ts#L21)
|
|
38
|
-
|
|
39
|
-
***
|
|
40
|
-
|
|
41
30
|
### log
|
|
42
31
|
|
|
43
32
|
> `readonly` **log**: (`line`) => `void`
|
|
44
33
|
|
|
45
|
-
Defined in: [packages/release-npm/src/types.ts:29](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
34
|
+
Defined in: [packages/release-npm/src/types.ts:29](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/types.ts#L29)
|
|
46
35
|
|
|
47
36
|
The log of the run, a line at a time.
|
|
48
37
|
|
|
@@ -64,7 +53,7 @@ The line to log, of no newline.
|
|
|
64
53
|
|
|
65
54
|
> `readonly` `optional` **memo?**: `Map`\<`string`, `unknown`\>
|
|
66
55
|
|
|
67
|
-
Defined in: [packages/release-npm/src/types.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
56
|
+
Defined in: [packages/release-npm/src/types.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/types.ts#L36)
|
|
68
57
|
|
|
69
58
|
A store of what a publisher has asked the registry, for one step of a release, as the npm
|
|
70
59
|
publisher keeps each package's versions and dist-tags of one question: a step that asks of a
|
|
@@ -73,8 +62,28 @@ none by default, as of a publisher that keeps nothing.
|
|
|
73
62
|
|
|
74
63
|
***
|
|
75
64
|
|
|
76
|
-
###
|
|
65
|
+
### platform
|
|
66
|
+
|
|
67
|
+
> `readonly` **platform**: [`ReleasePlatform`](../../release/type-aliases/ReleasePlatform.md)
|
|
68
|
+
|
|
69
|
+
Defined in: [packages/release/src/index.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/index.ts#L80)
|
|
70
|
+
|
|
71
|
+
The platform, of the folder of the repo as its working folder.
|
|
72
|
+
|
|
73
|
+
#### Inherited from
|
|
74
|
+
|
|
75
|
+
[`RepoContext`](../../release/interfaces/RepoContext.md).[`platform`](../../release/interfaces/RepoContext.md#platform)
|
|
76
|
+
|
|
77
|
+
***
|
|
78
|
+
|
|
79
|
+
### root
|
|
80
|
+
|
|
81
|
+
> `readonly` **root**: `FileSystemDirectoryHandle`
|
|
82
|
+
|
|
83
|
+
Defined in: [packages/release/src/index.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/index.ts#L78)
|
|
84
|
+
|
|
85
|
+
The folder of the repo, a handle of the File System standard.
|
|
77
86
|
|
|
78
|
-
|
|
87
|
+
#### Inherited from
|
|
79
88
|
|
|
80
|
-
|
|
89
|
+
[`RepoContext`](../../release/interfaces/RepoContext.md).[`root`](../../release/interfaces/RepoContext.md#root)
|
|
@@ -14,13 +14,13 @@ package depends on ([DEPENDENCY\_FIELDS](variables/DEPENDENCY_FIELDS.md)) and th
|
|
|
14
14
|
manifest as a package of the trains reads it ([packageOf](functions/packageOf.md)), each dependency of its kind.
|
|
15
15
|
|
|
16
16
|
```ts
|
|
17
|
-
import {
|
|
18
|
-
import
|
|
17
|
+
import type { RepoContext } from '@wtf/release'
|
|
18
|
+
import { trackedFiles } from '@wtf/release/git'
|
|
19
19
|
import { packageOf, readManifests, resolveSpecifier } from '@wtf/release-npm/manifests'
|
|
20
20
|
|
|
21
|
-
// The
|
|
22
|
-
declare const
|
|
23
|
-
const manifests = await readManifests(await trackedFiles(
|
|
21
|
+
// The folder of the repo and the platform of the caller: Node's of a plugin, its own of a CLI.
|
|
22
|
+
declare const repo: RepoContext
|
|
23
|
+
const manifests = await readManifests(await trackedFiles(repo), repo.root)
|
|
24
24
|
const names = new Set(manifests.flatMap(({ name }) => (name === undefined ? [] : [name])))
|
|
25
25
|
|
|
26
26
|
manifests.map((manifest) => packageOf(manifest, names)) // each of its dependencies of the repo
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **concreteRange**(`spec`): `string` \| `undefined`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:153](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L153)
|
|
12
12
|
|
|
13
13
|
The semver range a package requires of another, or `undefined` when it names no version, as
|
|
14
14
|
`workspace:*`, `*`, a tag or a path: `workspace:^1.2.0` requires `^1.2.0`.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **manifestsAt**(`ref`, `context`): `Promise`\<[`Manifest`](../interfaces/Manifest.md)[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L103)
|
|
12
12
|
|
|
13
13
|
Each package.json of the repo at `ref`, read by git: each but those in a `node_modules`.
|
|
14
14
|
|
|
@@ -22,10 +22,9 @@ The commit to read them at, as `HEAD` or the tag of a release.
|
|
|
22
22
|
|
|
23
23
|
### context
|
|
24
24
|
|
|
25
|
-
[`GitContext`](../../../release
|
|
25
|
+
[`GitContext`](../../../release/git/interfaces/GitContext.md)
|
|
26
26
|
|
|
27
|
-
Where git runs: the folder
|
|
28
|
-
by.
|
|
27
|
+
Where git runs: the platform, whose working folder is the folder of the repo.
|
|
29
28
|
|
|
30
29
|
## Returns
|
|
31
30
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **packageOf**(`manifest`, `workspace`): [`NpmPackage`](../interfaces/NpmPackage.md) \| `undefined`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:190](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L190)
|
|
12
12
|
|
|
13
13
|
The package of the trains of `manifest`, `undefined` of one of no name: published unless it is
|
|
14
14
|
private, its manifest its package.json, and each dependency on a package of `workspace` of the
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **packagesOfManifests**(`manifests`): [`NpmPackage`](../interfaces/NpmPackage.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:217](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L217)
|
|
12
12
|
|
|
13
13
|
The packages of the trains of `manifests`, each of a name, of its dependencies on the others
|
|
14
14
|
([packageOf](packageOf.md)).
|
|
@@ -6,12 +6,12 @@
|
|
|
6
6
|
|
|
7
7
|
# Function: readManifests()
|
|
8
8
|
|
|
9
|
-
> **readManifests**(`files`, `
|
|
9
|
+
> **readManifests**(`files`, `root`): `Promise`\<[`Manifest`](../interfaces/Manifest.md)[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L87)
|
|
12
12
|
|
|
13
|
-
Each package.json of `files`, the files of a repo, read from its folder
|
|
14
|
-
|
|
13
|
+
Each package.json of `files`, the files of a repo, read from its folder, `root`: each but those
|
|
14
|
+
in a `node_modules`.
|
|
15
15
|
|
|
16
16
|
## Parameters
|
|
17
17
|
|
|
@@ -21,11 +21,11 @@ readonly `string`[]
|
|
|
21
21
|
|
|
22
22
|
The files of the repo, from its root, as git tracks them.
|
|
23
23
|
|
|
24
|
-
###
|
|
24
|
+
### root
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
`FileSystemDirectoryHandle`
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
The folder of the repo, a handle of the File System standard.
|
|
29
29
|
|
|
30
30
|
## Returns
|
|
31
31
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **resolveSpecifier**(`specifier`, `version`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:138](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L138)
|
|
12
12
|
|
|
13
13
|
The range a release publishes of `specifier`, a range of a package.json, of `version`, the
|
|
14
14
|
release of the package it names, by pnpm's rules for the workspace protocol: `workspace:*` and
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **runtimeDependenciesOf**(`json`): `string`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:122](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L122)
|
|
12
12
|
|
|
13
13
|
The names of the packages `json` needs published before it: what it runs with.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **satisfiesRange**(`range`, `version`): `boolean`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:168](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L168)
|
|
12
12
|
|
|
13
13
|
Whether `version` is within `range`, by semver, a prerelease within its bounds too, as
|
|
14
14
|
`7.1.0-beta.1` of `^7.0.0`: of a range that names no version, as `*`, a tag or a path, any.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Manifest
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
9
|
+
Defined in: [packages/release-npm/src/manifests.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L57)
|
|
10
10
|
|
|
11
11
|
A package.json of the repo: where it is, and what it holds.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ A package.json of the repo: where it is, and what it holds.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **dir**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
19
|
+
Defined in: [packages/release-npm/src/manifests.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L61)
|
|
20
20
|
|
|
21
21
|
Its folder, from the root of the repo, as `packages/core`; `.` for the root.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ Its folder, from the root of the repo, as `packages/core`; `.` for the root.
|
|
|
26
26
|
|
|
27
27
|
> `readonly` **file**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
29
|
+
Defined in: [packages/release-npm/src/manifests.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L59)
|
|
30
30
|
|
|
31
31
|
The file, from the root of the repo, as `packages/core/package.json`.
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ The file, from the root of the repo, as `packages/core/package.json`.
|
|
|
36
36
|
|
|
37
37
|
> `readonly` **json**: `Readonly`\<`Record`\<`string`, `unknown`\>\>
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
39
|
+
Defined in: [packages/release-npm/src/manifests.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L65)
|
|
40
40
|
|
|
41
41
|
What it holds.
|
|
42
42
|
|
|
@@ -46,6 +46,6 @@ What it holds.
|
|
|
46
46
|
|
|
47
47
|
> `readonly` **name**: `string` \| `undefined`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
49
|
+
Defined in: [packages/release-npm/src/manifests.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L63)
|
|
50
50
|
|
|
51
51
|
Its name, when it has one.
|
|
@@ -6,27 +6,27 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: NpmPackage
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
9
|
+
Defined in: [packages/release-npm/src/manifests.ts:174](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L174)
|
|
10
10
|
|
|
11
11
|
A package of the trains of a package.json, of what the package.json holds.
|
|
12
12
|
|
|
13
13
|
## Extends
|
|
14
14
|
|
|
15
|
-
- [`Package`](../../../release
|
|
15
|
+
- [`Package`](../../../release/ecosystem/interfaces/Package.md)
|
|
16
16
|
|
|
17
17
|
## Properties
|
|
18
18
|
|
|
19
19
|
### dependencies
|
|
20
20
|
|
|
21
|
-
> `readonly` **dependencies**: readonly [`Dependency`](../../../release
|
|
21
|
+
> `readonly` **dependencies**: readonly [`Dependency`](../../../release/ecosystem/interfaces/Dependency.md)[]
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/release
|
|
23
|
+
Defined in: [packages/release/src/ecosystem.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L74)
|
|
24
24
|
|
|
25
25
|
Its dependencies on the other packages of its ecosystem in the repo.
|
|
26
26
|
|
|
27
27
|
#### Inherited from
|
|
28
28
|
|
|
29
|
-
[`Package`](../../../release
|
|
29
|
+
[`Package`](../../../release/ecosystem/interfaces/Package.md).[`dependencies`](../../../release/ecosystem/interfaces/Package.md#dependencies)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,14 +34,14 @@ Its dependencies on the other packages of its ecosystem in the repo.
|
|
|
34
34
|
|
|
35
35
|
> `readonly` **dir**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/release
|
|
37
|
+
Defined in: [packages/release/src/ecosystem.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L65)
|
|
38
38
|
|
|
39
|
-
Its folder, from the root of the repo, as `packages/core`; `.` of the root. A
|
|
40
|
-
|
|
39
|
+
Its folder, from the root of the repo, as `packages/core`; `.` of the root. A part of the repo,
|
|
40
|
+
as a train, holds it when its paths hold this folder.
|
|
41
41
|
|
|
42
42
|
#### Inherited from
|
|
43
43
|
|
|
44
|
-
[`Package`](../../../release
|
|
44
|
+
[`Package`](../../../release/ecosystem/interfaces/Package.md).[`dir`](../../../release/ecosystem/interfaces/Package.md#dir)
|
|
45
45
|
|
|
46
46
|
***
|
|
47
47
|
|
|
@@ -49,7 +49,7 @@ when the train's `paths` hold this folder.
|
|
|
49
49
|
|
|
50
50
|
> `readonly` **json**: `Readonly`\<`Record`\<`string`, `unknown`\>\>
|
|
51
51
|
|
|
52
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
52
|
+
Defined in: [packages/release-npm/src/manifests.ts:176](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L176)
|
|
53
53
|
|
|
54
54
|
What its package.json holds.
|
|
55
55
|
|
|
@@ -59,13 +59,13 @@ What its package.json holds.
|
|
|
59
59
|
|
|
60
60
|
> `readonly` **manifest**: `string`
|
|
61
61
|
|
|
62
|
-
Defined in: [packages/release
|
|
62
|
+
Defined in: [packages/release/src/ecosystem.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L67)
|
|
63
63
|
|
|
64
64
|
Its manifest, from the root of the repo, as `packages/core/package.json`.
|
|
65
65
|
|
|
66
66
|
#### Inherited from
|
|
67
67
|
|
|
68
|
-
[`Package`](../../../release
|
|
68
|
+
[`Package`](../../../release/ecosystem/interfaces/Package.md).[`manifest`](../../../release/ecosystem/interfaces/Package.md#manifest)
|
|
69
69
|
|
|
70
70
|
***
|
|
71
71
|
|
|
@@ -73,13 +73,13 @@ Its manifest, from the root of the repo, as `packages/core/package.json`.
|
|
|
73
73
|
|
|
74
74
|
> `readonly` **name**: `string`
|
|
75
75
|
|
|
76
|
-
Defined in: [packages/release
|
|
76
|
+
Defined in: [packages/release/src/ecosystem.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L60)
|
|
77
77
|
|
|
78
78
|
Its name, the one its ecosystem's registry knows it by: unique of the ecosystem in the repo.
|
|
79
79
|
|
|
80
80
|
#### Inherited from
|
|
81
81
|
|
|
82
|
-
[`Package`](../../../release
|
|
82
|
+
[`Package`](../../../release/ecosystem/interfaces/Package.md).[`name`](../../../release/ecosystem/interfaces/Package.md#name)
|
|
83
83
|
|
|
84
84
|
***
|
|
85
85
|
|
|
@@ -87,11 +87,11 @@ Its name, the one its ecosystem's registry knows it by: unique of the ecosystem
|
|
|
87
87
|
|
|
88
88
|
> `readonly` **published**: `boolean`
|
|
89
89
|
|
|
90
|
-
Defined in: [packages/release
|
|
90
|
+
Defined in: [packages/release/src/ecosystem.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L72)
|
|
91
91
|
|
|
92
92
|
Whether a release publishes it: not of an npm package that is private, nor of a crate of
|
|
93
93
|
`publish = false`.
|
|
94
94
|
|
|
95
95
|
#### Inherited from
|
|
96
96
|
|
|
97
|
-
[`Package`](../../../release
|
|
97
|
+
[`Package`](../../../release/ecosystem/interfaces/Package.md).[`published`](../../../release/ecosystem/interfaces/Package.md#published)
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **DependencyField** = *typeof* [`DEPENDENCY_FIELDS`](../variables/DEPENDENCY_FIELDS.md)\[`number`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L42)
|
|
12
12
|
|
|
13
13
|
A field of [DEPENDENCY\_FIELDS](../variables/DEPENDENCY_FIELDS.md).
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **DEPENDENCY\_FIELDS**: readonly \[`"dependencies"`, `"devDependencies"`, `"peerDependencies"`, `"optionalDependencies"`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:34](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L34)
|
|
12
12
|
|
|
13
13
|
The fields of a package.json that list the packages it depends on.
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
# Variable: FIELD\_KINDS
|
|
8
8
|
|
|
9
|
-
> `const` **FIELD\_KINDS**: `Readonly`\<`Record`\<[`DependencyField`](../type-aliases/DependencyField.md), [`DependencyKind`](../../../release
|
|
9
|
+
> `const` **FIELD\_KINDS**: `Readonly`\<`Record`\<[`DependencyField`](../type-aliases/DependencyField.md), [`DependencyKind`](../../../release/ecosystem/type-aliases/DependencyKind.md)\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L49)
|
|
12
12
|
|
|
13
13
|
The kind of a dependency of each field, as the trains read it: what a package runs with of
|
|
14
14
|
`dependencies` and `optionalDependencies`, its users' of `peerDependencies`, and its own tests'
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **RUNTIME\_FIELDS**: readonly \[`"dependencies"`, `"peerDependencies"`, `"optionalDependencies"`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/manifests.ts#L113)
|
|
12
12
|
|
|
13
13
|
The fields of a package.json whose packages must be published before it: what it runs with.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **isTypeScriptSource**(`target`): `boolean`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/prepare.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/prepare.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L24)
|
|
12
12
|
|
|
13
13
|
Whether an export target is TypeScript source, `.ts`, `.tsx`, `.mts` or `.cts`, and no
|
|
14
14
|
declaration file: what the workspace's own tooling runs, and no tarball ships.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **prepareManifest**(`manifest`, `options`): [`PreparedManifest`](../interfaces/PreparedManifest.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/prepare.ts:119](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/prepare.ts:119](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L119)
|
|
12
12
|
|
|
13
13
|
A manifest as it publishes: of the version of the release, each `workspace:` range of its
|
|
14
14
|
dependencies resolved to the version of the package it names, and its exports with no export of
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **stripSourceConditions**(`value`, `conditions?`): `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/prepare.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/prepare.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L46)
|
|
12
12
|
|
|
13
13
|
An `exports` value with no condition of `conditions` and no target of TypeScript source, and how
|
|
14
14
|
many it had: Node and every bundler resolve `exports` by the first condition that matches, with
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: PrepareOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/prepare.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/prepare.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L76)
|
|
10
10
|
|
|
11
11
|
How [prepareManifest](../functions/prepareManifest.md) makes a manifest.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ How [prepareManifest](../functions/prepareManifest.md) makes a manifest.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` `optional` **conditions?**: readonly `string`[]
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-npm/src/prepare.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-npm/src/prepare.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L90)
|
|
20
20
|
|
|
21
21
|
The export conditions of the source: [SOURCE\_CONDITIONS](../variables/SOURCE_CONDITIONS.md).
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ The export conditions of the source: [SOURCE\_CONDITIONS](../variables/SOURCE_CO
|
|
|
26
26
|
|
|
27
27
|
> `readonly` **version**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-npm/src/prepare.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-npm/src/prepare.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L78)
|
|
30
30
|
|
|
31
31
|
The version of the release, of the package.
|
|
32
32
|
|
|
@@ -36,10 +36,10 @@ The version of the release, of the package.
|
|
|
36
36
|
|
|
37
37
|
> `readonly` **versionOf**: (`name`) => `string` \| `undefined`
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/release-npm/src/prepare.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
39
|
+
Defined in: [packages/release-npm/src/prepare.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L86)
|
|
40
40
|
|
|
41
41
|
The version of a package of the workspace, by its name, that a `workspace:` range resolves to:
|
|
42
|
-
of a package of the
|
|
42
|
+
of a package of the release, the release's; of another, its own, as released.
|
|
43
43
|
|
|
44
44
|
#### Parameters
|
|
45
45
|
|
|
@@ -61,6 +61,6 @@ Its version, or `undefined` of a package of no version known, as a private one.
|
|
|
61
61
|
|
|
62
62
|
> `readonly` **workspace**: `ReadonlySet`\<`string`\>
|
|
63
63
|
|
|
64
|
-
Defined in: [packages/release-npm/src/prepare.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
64
|
+
Defined in: [packages/release-npm/src/prepare.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L88)
|
|
65
65
|
|
|
66
66
|
The name of each package of the workspace.
|