@wtf/release-docs 8.2.1 → 8.2.2
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 +56 -44
- package/api/@wtf/release-cargo/auth/functions/mask.md +1 -1
- package/api/@wtf/release-cargo/auth/functions/tokenVariableOf.md +1 -1
- package/api/@wtf/release-cargo/auth/functions/trustedPublishing.md +1 -1
- package/api/@wtf/release-cargo/auth/interfaces/HttpResponse.md +5 -5
- package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishing.md +5 -5
- package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishingOptions.md +6 -6
- package/api/@wtf/release-cargo/auth/type-aliases/HttpFetch.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/CRATES_IO_API.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/ID_TOKEN_VARIABLE.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/USER_AGENT.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/publishOrder.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/publishable.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/readWorkspace.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/selectCrates.md +1 -1
- package/api/@wtf/release-cargo/crates/interfaces/Selection.md +5 -5
- package/api/@wtf/release-cargo/ecosystem/functions/packagesAt.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/packagesOfTree.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/packagesOfWorkspace.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/resolveRequirement.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/satisfiesRequirement.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/semverRange.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/interfaces/CargoPackage.md +7 -7
- package/api/@wtf/release-cargo/ecosystem/variables/cargoEcosystem.md +1 -1
- package/api/@wtf/release-cargo/errors/classes/CargoError.md +5 -5
- package/api/@wtf/release-cargo/errors/type-aliases/CargoErrorCode.md +1 -1
- package/api/@wtf/release-cargo/errors/variables/CARGO_ERRORS.md +1 -1
- package/api/@wtf/release-cargo/interfaces/Crate.md +6 -6
- package/api/@wtf/release-cargo/interfaces/CrateDependency.md +6 -6
- package/api/@wtf/release-cargo/interfaces/Workspace.md +3 -3
- package/api/@wtf/release-cargo/publish/functions/publishCrates.md +1 -1
- package/api/@wtf/release-cargo/publish/interfaces/PublishCratesOptions.md +11 -11
- package/api/@wtf/release-cargo/publish/interfaces/PublishedCrate.md +5 -5
- package/api/@wtf/release-cargo/publish/type-aliases/CrateStatus.md +1 -1
- package/api/@wtf/release-cargo/publish/variables/RECHECK_WAITS.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/crateUrl.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/indexHasVersion.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/indexPath.md +1 -1
- package/api/@wtf/release-cargo/registry/variables/CRATES_IO_INDEX.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/inheritsVersion.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/stampManifest.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/stampWorkspace.md +1 -1
- package/api/@wtf/release-cargo/stamp/interfaces/StampOptions.md +4 -4
- package/api/@wtf/release-cargo/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-cargo/stamp/interfaces/StampedWorkspace.md +3 -3
- package/api/@wtf/release-cargo/type-aliases/DependencyKind.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/packagesOfModules.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/packagesOfRepo.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/resolveVersion.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/satisfiesVersion.md +1 -1
- package/api/@wtf/release-go/ecosystem/interfaces/GoPackage.md +7 -7
- package/api/@wtf/release-go/ecosystem/variables/goEcosystem.md +1 -1
- package/api/@wtf/release-go/errors/classes/GoError.md +5 -5
- package/api/@wtf/release-go/errors/type-aliases/GoErrorCode.md +1 -1
- package/api/@wtf/release-go/errors/variables/GO_ERRORS.md +1 -1
- 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/GoModule.md +6 -6
- 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 +1 -1
- package/api/@wtf/release-go/modules/functions/modulesOf.md +1 -1
- package/api/@wtf/release-go/modules/functions/readModules.md +1 -1
- package/api/@wtf/release-go/modules/functions/selectModules.md +1 -1
- package/api/@wtf/release-go/modules/interfaces/Selection.md +4 -4
- 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 +1 -1
- package/api/@wtf/release-go/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-go/stamp/interfaces/StampedModules.md +3 -3
- package/api/@wtf/release-go/tags/functions/askProxy.md +1 -1
- package/api/@wtf/release-go/tags/functions/maskCredentials.md +1 -1
- package/api/@wtf/release-go/tags/functions/releaseCommit.md +1 -1
- package/api/@wtf/release-go/tags/functions/remoteTags.md +1 -1
- package/api/@wtf/release-go/tags/functions/tagModules.md +1 -1
- 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/TagModulesOptions.md +8 -8
- package/api/@wtf/release-go/tags/interfaces/TaggedModule.md +5 -5
- package/api/@wtf/release-go/tags/type-aliases/ModuleStatus.md +1 -1
- package/api/@wtf/release-go/tags/variables/RELEASE_AUTHOR.md +1 -1
- 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 +1 -1
- package/api/@wtf/release-maven/artifacts/functions/readPoms.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/selectArtifacts.md +1 -1
- package/api/@wtf/release-maven/artifacts/interfaces/Selection.md +4 -4
- 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/Restriction.md +3 -3
- package/api/@wtf/release-maven/ecosystem/variables/mavenEcosystem.md +1 -1
- package/api/@wtf/release-maven/errors/classes/MavenError.md +5 -5
- package/api/@wtf/release-maven/errors/type-aliases/MavenErrorCode.md +1 -1
- package/api/@wtf/release-maven/errors/variables/MAVEN_ERRORS.md +1 -1
- package/api/@wtf/release-maven/interfaces/MavenModule.md +14 -14
- 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/functions/deployModules.md +1 -1
- package/api/@wtf/release-maven/publish/interfaces/DeployModulesOptions.md +11 -11
- package/api/@wtf/release-maven/publish/interfaces/DeployedModule.md +4 -4
- package/api/@wtf/release-maven/publish/type-aliases/ModuleStatus.md +1 -1
- 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/pomPath.md +1 -1
- package/api/@wtf/release-maven/repository/functions/pomUrl.md +1 -1
- 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/functions/checkVersions.md +1 -1
- package/api/@wtf/release-maven/stamp/functions/stampModules.md +1 -1
- 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 +3 -3
- package/api/@wtf/release-npm/check/functions/checkPackages.md +1 -1
- package/api/@wtf/release-npm/check/functions/formatIssue.md +1 -1
- package/api/@wtf/release-npm/check/interfaces/CheckOptions.md +6 -6
- package/api/@wtf/release-npm/check/interfaces/Issue.md +5 -5
- package/api/@wtf/release-npm/check/type-aliases/CheckedPackage.md +1 -1
- package/api/@wtf/release-npm/check/type-aliases/IssueCode.md +1 -1
- package/api/@wtf/release-npm/ecosystem/variables/npmEcosystem.md +1 -1
- package/api/@wtf/release-npm/errors/type-aliases/NpmErrorCode.md +1 -1
- package/api/@wtf/release-npm/errors/variables/NPM_ERRORS.md +1 -1
- package/api/@wtf/release-npm/interfaces/Lookup.md +3 -3
- package/api/@wtf/release-npm/interfaces/PublishOptions.md +6 -6
- package/api/@wtf/release-npm/interfaces/PublishPackage.md +5 -5
- package/api/@wtf/release-npm/interfaces/PublishTrainOptions.md +13 -13
- package/api/@wtf/release-npm/interfaces/Publisher.md +7 -7
- package/api/@wtf/release-npm/interfaces/PublisherContext.md +7 -7
- package/api/@wtf/release-npm/manifests/functions/concreteRange.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/manifestsAt.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/packageOf.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/packagesOfManifests.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/readManifests.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/resolveSpecifier.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/runtimeDependenciesOf.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/satisfiesRange.md +1 -1
- package/api/@wtf/release-npm/manifests/interfaces/Manifest.md +5 -5
- package/api/@wtf/release-npm/manifests/interfaces/NpmPackage.md +7 -7
- package/api/@wtf/release-npm/manifests/type-aliases/DependencyField.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/DEPENDENCY_FIELDS.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/FIELD_KINDS.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/RUNTIME_FIELDS.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/isTypeScriptSource.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/prepareManifest.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/stripSourceConditions.md +1 -1
- package/api/@wtf/release-npm/prepare/interfaces/PrepareOptions.md +5 -5
- package/api/@wtf/release-npm/prepare/interfaces/PreparedManifest.md +6 -6
- package/api/@wtf/release-npm/prepare/variables/SOURCE_CONDITIONS.md +1 -1
- package/api/@wtf/release-npm/publishers/functions/builtInPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/functions/isPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/NPM_REGISTRY.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/PUBLISHERS.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/npmPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/pnpmPublisher.md +1 -1
- package/api/@wtf/release-npm/release/functions/checkTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/distTagOf.md +1 -1
- package/api/@wtf/release-npm/release/functions/packTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishPacked.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishedOf.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishedOfResolved.md +1 -1
- package/api/@wtf/release-npm/release/functions/releaseTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/resolveManifests.md +1 -1
- package/api/@wtf/release-npm/release/functions/tagTrain.md +1 -1
- package/api/@wtf/release-npm/release/interfaces/CheckRelease.md +16 -16
- package/api/@wtf/release-npm/release/interfaces/PackOptions.md +8 -8
- package/api/@wtf/release-npm/release/interfaces/PackedTrain.md +12 -12
- package/api/@wtf/release-npm/release/interfaces/PublishRun.md +11 -11
- package/api/@wtf/release-npm/release/interfaces/PublishedOf.md +4 -4
- package/api/@wtf/release-npm/release/interfaces/PublishedPackage.md +7 -7
- package/api/@wtf/release-npm/release/interfaces/PublishedTrain.md +5 -5
- package/api/@wtf/release-npm/release/interfaces/ResolveRelease.md +17 -17
- package/api/@wtf/release-npm/release/interfaces/ResolvedPackage.md +4 -4
- package/api/@wtf/release-npm/release/interfaces/ResolvedTrain.md +6 -6
- package/api/@wtf/release-npm/release/interfaces/TagRelease.md +14 -14
- package/api/@wtf/release-npm/release/type-aliases/LookedUpTrain.md +1 -1
- package/api/@wtf/release-npm/release/type-aliases/ReleaseRun.md +1 -1
- package/api/@wtf/release-npm/release/variables/ID_TOKENS.md +1 -1
- package/api/@wtf/release-npm/release/variables/RUNNER_ENVIRONMENTS.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/pnpmWorkspaceGlobs.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/publishableOf.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/readWorkspace.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/workspaceFolders.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/workspaceGlobs.md +1 -1
- package/api/@wtf/release-npm/workspace/interfaces/WorkspaceGlobs.md +3 -3
- package/api/@wtf/release-npm/workspace/interfaces/WorkspaceOptions.md +2 -2
- package/api/@wtf/release-replace/errors/classes/ReplaceError.md +5 -5
- package/api/@wtf/release-replace/errors/type-aliases/ReplaceErrorCode.md +1 -1
- package/api/@wtf/release-replace/errors/variables/REPLACE_ERRORS.md +1 -1
- package/api/@wtf/release-replace/files/functions/filesMatcher.md +1 -1
- package/api/@wtf/release-replace/interfaces/ReplaceMatch.md +5 -5
- package/api/@wtf/release-replace/interfaces/ReplacementOf.md +5 -5
- package/api/@wtf/release-replace/replace/functions/regExpOf.md +1 -1
- package/api/@wtf/release-replace/replace/functions/replaceFiles.md +1 -1
- package/api/@wtf/release-replace/replace/functions/replaceText.md +1 -1
- package/api/@wtf/release-replace/replace/interfaces/ReplaceOptions.md +10 -10
- package/api/@wtf/release-replace/replace/interfaces/TextOptions.md +5 -5
- package/api/@wtf/release-replace/replace/type-aliases/To.md +1 -1
- package/api/@wtf/release-replace/templates/functions/mergeTemplates.md +1 -1
- package/api/@wtf/release-replace/templates/functions/resolveReplacement.md +1 -1
- package/api/@wtf/release-replace/templates/functions/resolveReplacements.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Escape.md +1 -1
- package/api/@wtf/release-replace/type-aliases/ReplaceFunction.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Replacement.md +1 -1
- package/api/@wtf/release-replace/type-aliases/ReplacementSpec.md +1 -1
- package/api/@wtf/release-replace/type-aliases/TemplateUse.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Templates.md +1 -1
- package/api/@wtf/release-replace/values/functions/escapeValue.md +1 -1
- package/api/@wtf/release-replace/values/functions/textOf.md +1 -1
- package/api/@wtf/release-replace/values/functions/valueAt.md +1 -1
- package/api/@wtf/release-replace/values/variables/ESCAPES.md +1 -1
- package/api/@wtf/release-replace/values/variables/VALUE.md +1 -1
- package/api/@wtf/release-system/errors/classes/ReleaseError.md +5 -5
- package/api/@wtf/release-system/errors/functions/throwAll.md +1 -1
- package/api/@wtf/release-system/errors/type-aliases/ErrorClass.md +1 -1
- package/api/@wtf/release-system/errors/type-aliases/SystemErrorCode.md +1 -1
- package/api/@wtf/release-system/errors/variables/SYSTEM_ERRORS.md +1 -1
- package/api/@wtf/release-system/git/functions/commitsSince.md +1 -1
- package/api/@wtf/release-system/git/functions/filesOfCommits.md +1 -1
- package/api/@wtf/release-system/git/functions/git.md +1 -1
- package/api/@wtf/release-system/git/functions/gitOf.md +1 -1
- package/api/@wtf/release-system/git/functions/trackedFiles.md +1 -1
- package/api/@wtf/release-system/git/interfaces/GitContext.md +4 -4
- package/api/@wtf/release-system/git/interfaces/LogCommit.md +5 -5
- package/api/@wtf/release-system/node/functions/nodeSystem.md +1 -1
- package/api/@wtf/release-system/node/functions/realPathOf.md +1 -1
- package/api/@wtf/release-system/node/functions/systemOf.md +1 -1
- package/api/@wtf/release-system/paths/functions/normalizePath.md +1 -1
- package/api/@wtf/release-system/paths/functions/pathMatcher.md +1 -1
- package/api/@wtf/release-system/paths/type-aliases/PathMatcher.md +1 -1
- package/api/@wtf/release-system/posix/functions/basenameOf.md +1 -1
- package/api/@wtf/release-system/posix/functions/dirnameOf.md +1 -1
- package/api/@wtf/release-system/posix/functions/joinPath.md +1 -1
- package/api/@wtf/release-system/posix/functions/relativePath.md +1 -1
- package/api/@wtf/release-system/posix/functions/resolvePath.md +1 -1
- package/api/@wtf/release-system/system/interfaces/DirEntry.md +3 -3
- package/api/@wtf/release-system/system/interfaces/ExecOptions.md +4 -4
- package/api/@wtf/release-system/system/interfaces/ExecResult.md +4 -4
- package/api/@wtf/release-system/system/interfaces/System.md +7 -7
- package/api/@wtf/release-system/system/interfaces/SystemFs.md +8 -8
- package/api/@wtf/release-system/system/type-aliases/Exec.md +1 -1
- package/api/@wtf/release-system/system/type-aliases/SystemInput.md +1 -1
- package/api/@wtf/release-system/validator/functions/allOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/anyObject.md +1 -1
- package/api/@wtf/release-system/validator/functions/anyOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/arrayOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/booleanOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/errorOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/errorsOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/exclusive.md +1 -1
- package/api/@wtf/release-system/validator/functions/issuesOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/objectOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/oneOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/orFunction.md +1 -1
- package/api/@wtf/release-system/validator/functions/pathText.md +1 -1
- package/api/@wtf/release-system/validator/functions/pluginEntriesOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/recordOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/refined.md +1 -1
- package/api/@wtf/release-system/validator/functions/stringOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/tupleOf.md +1 -1
- package/api/@wtf/release-system/validator/interfaces/ArrayOptions.md +5 -5
- package/api/@wtf/release-system/validator/interfaces/IssueOptions.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/ObjectOptions.md +5 -5
- package/api/@wtf/release-system/validator/interfaces/OptionIssue.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/Property.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/RecordOptions.md +6 -6
- package/api/@wtf/release-system/validator/interfaces/StringOptions.md +6 -6
- package/api/@wtf/release-system/validator/interfaces/Validator.md +4 -4
- package/api/@wtf/release-system/validator/type-aliases/JsonSchema.md +1 -1
- package/api/@wtf/release-system/validator/type-aliases/Path.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadeNotes.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadeText.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadeType.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadesOf.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/higherType.md +1 -1
- package/api/@wtf/release-trains/cascade/interfaces/Cascade.md +11 -11
- package/api/@wtf/release-trains/cascade/interfaces/CascadeCheck.md +8 -8
- package/api/@wtf/release-trains/cascade/type-aliases/CascadeKind.md +1 -1
- package/api/@wtf/release-trains/cascade/type-aliases/ReleaseType.md +1 -1
- package/api/@wtf/release-trains/cascade/variables/RELEASE_TYPES.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/isEcosystem.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/loadEcosystems.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/readPackages.md +1 -1
- package/api/@wtf/release-trains/ecosystem/interfaces/Dependency.md +4 -4
- package/api/@wtf/release-trains/ecosystem/interfaces/Ecosystem.md +5 -5
- package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemContext.md +5 -5
- package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemPackages.md +3 -3
- package/api/@wtf/release-trains/ecosystem/interfaces/Package.md +6 -6
- package/api/@wtf/release-trains/ecosystem/type-aliases/DependencyKind.md +1 -1
- package/api/@wtf/release-trains/ecosystem/type-aliases/ModuleLoader.md +1 -1
- package/api/@wtf/release-trains/ecosystem/variables/DEPENDENCY_KINDS.md +1 -1
- package/api/@wtf/release-trains/errors/classes/TrainsError.md +5 -5
- package/api/@wtf/release-trains/errors/type-aliases/TrainsErrorCode.md +1 -1
- package/api/@wtf/release-trains/errors/variables/TRAINS_ERRORS.md +1 -1
- package/api/@wtf/release-trains/generated/functions/filesIn.md +1 -1
- package/api/@wtf/release-trains/generated/functions/formatGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/listGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/parseGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/readGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/stageGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/stageGeneratedFolders.md +1 -1
- package/api/@wtf/release-trains/generated/functions/unlistedIn.md +1 -1
- package/api/@wtf/release-trains/generated/interfaces/GeneratedOptions.md +2 -2
- package/api/@wtf/release-trains/generated/interfaces/StageOptions.md +6 -6
- package/api/@wtf/release-trains/generated/variables/GENERATED.md +1 -1
- package/api/@wtf/release-trains/git/functions/tagOf.md +1 -1
- package/api/@wtf/release-trains/git/functions/tagsOf.md +1 -1
- package/api/@wtf/release-trains/git/functions/versionOfTag.md +1 -1
- package/api/@wtf/release-trains/git/interfaces/TrainTag.md +3 -3
- package/api/@wtf/release-trains/interfaces/Train.md +7 -7
- package/api/@wtf/release-trains/packages/functions/dependencyEdges.md +1 -1
- package/api/@wtf/release-trains/packages/functions/dependencyText.md +1 -1
- package/api/@wtf/release-trains/packages/functions/dependsOnErrors.md +1 -1
- package/api/@wtf/release-trains/packages/functions/normalizeDir.md +1 -1
- package/api/@wtf/release-trains/packages/functions/ownersOf.md +1 -1
- package/api/@wtf/release-trains/packages/functions/packagesOf.md +1 -1
- package/api/@wtf/release-trains/packages/functions/publishOrder.md +1 -1
- package/api/@wtf/release-trains/packages/functions/releasedVersions.md +1 -1
- package/api/@wtf/release-trains/packages/functions/trainDependencies.md +1 -1
- package/api/@wtf/release-trains/packages/functions/trainOrder.md +1 -1
- package/api/@wtf/release-trains/packages/functions/unsatisfiedErrors.md +1 -1
- package/api/@wtf/release-trains/packages/interfaces/DependencyEdge.md +6 -6
- package/api/@wtf/release-trains/packages/interfaces/OrderFault.md +4 -4
- package/api/@wtf/release-trains/packages/interfaces/OrderPins.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/PublishOrder.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/TrainDependency.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/VersionsRelease.md +7 -7
- package/api/@wtf/release-trains/paths/functions/filterCommits.md +1 -1
- package/api/@wtf/release-trains/paths/functions/gitFilesOf.md +1 -1
- package/api/@wtf/release-trains/paths/functions/overlapError.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainOfPath.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainsOfCommit.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainsOfPath.md +1 -1
- package/api/@wtf/release-trains/paths/type-aliases/FilesOf.md +1 -1
- package/api/@wtf/release-trains/schema/interfaces/ConfigPart.md +6 -6
- package/api/@wtf/release-trains/schema/interfaces/RootOptions.md +7 -7
- package/api/@wtf/release-trains/schema/type-aliases/DependencyRule.md +1 -1
- package/api/@wtf/release-trains/schema/variables/DEPENDENCY_RULES.md +1 -1
- package/api/@wtf/release-trains/schema/variables/TAG_FORMAT_PATTERN.md +1 -1
- package/api/@wtf/release-trains/schema/variables/TRAIN_NAME_PATTERN.md +1 -1
- package/api/@wtf/release-trains/schema/variables/configSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/rootOptionsSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/trainSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/trainsSchema.md +1 -1
- package/api/@wtf/release-trains/trains/functions/changelogOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/matchersOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/overlapErrors.md +1 -1
- package/api/@wtf/release-trains/trains/functions/selectTrain.md +1 -1
- package/api/@wtf/release-trains/trains/functions/tagFormatOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainHeadedNotes.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainOfRun.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainOfTag.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainsErrors.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainsOfOptions.md +1 -1
- package/api/@wtf/release-trains/trains/variables/TRAIN_VARIABLE.md +1 -1
- package/api/@wtf/release-trains/trains/variables/VERSION.md +1 -1
- package/api/@wtf/release-trains/type-aliases/BranchSpec.md +1 -1
- package/api/@wtf/release-trains/type-aliases/Trains.md +1 -1
- package/api/@wtf/release-trains/verify/functions/unreleasedDependencies.md +1 -1
- package/api/@wtf/release-trains/verify/functions/verifyTrain.md +1 -1
- package/api/@wtf/release-trains/verify/interfaces/UnreleasedDependencies.md +10 -10
- package/api/@wtf/release-trains/verify/interfaces/VerifiedTrain.md +5 -5
- package/api/@wtf/release-trains/verify/interfaces/VerifyRelease.md +8 -8
- package/api/@wtf/release-validate/errors/classes/ValidateError.md +5 -5
- package/api/@wtf/release-validate/errors/type-aliases/ValidateErrorCode.md +1 -1
- package/api/@wtf/release-validate/errors/variables/VALIDATE_ERRORS.md +1 -1
- package/api/@wtf/release-validate/interfaces/ConfigIssue.md +4 -4
- package/api/@wtf/release-validate/json-schema/functions/fromJsonSchema.md +1 -1
- package/api/@wtf/release-validate/json-schema/functions/pathOfPointer.md +1 -1
- package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaError.md +3 -3
- package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaValidator.md +3 -3
- package/api/@wtf/release-validate/validate/functions/configErrors.md +1 -1
- package/api/@wtf/release-validate/validate/functions/isStandardSchema.md +1 -1
- package/api/@wtf/release-validate/validate/functions/pathText.md +1 -1
- package/api/@wtf/release-validate/validate/functions/validateConfig.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/indexLookup.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-cargo/interfaces/CargoPluginOptions.md +12 -12
- package/api/@wtf/semantic-release-cargo/interfaces/CargoRelease.md +3 -3
- package/api/@wtf/semantic-release-cargo/schema/type-aliases/CargoOptions.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/cargoOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/cargoSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/variables/default.md +1 -1
- package/api/@wtf/semantic-release-go/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-go/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-go/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-go/functions/verifyRelease.md +1 -1
- package/api/@wtf/semantic-release-go/interfaces/GoPluginOptions.md +8 -8
- package/api/@wtf/semantic-release-go/interfaces/GoRelease.md +3 -3
- package/api/@wtf/semantic-release-go/schema/type-aliases/GoOptions.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/goOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/goSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-go/variables/default.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/pomLookup.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-maven/interfaces/LookupAuth.md +3 -3
- package/api/@wtf/semantic-release-maven/interfaces/MavenPluginOptions.md +12 -12
- package/api/@wtf/semantic-release-maven/interfaces/MavenRelease.md +2 -2
- package/api/@wtf/semantic-release-maven/schema/type-aliases/MavenOptions.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/mavenOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/mavenSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/variables/default.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/addChannel.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/fail.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/loadPublisher.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-npm/interfaces/PublishPluginOptions.md +18 -18
- package/api/@wtf/semantic-release-npm/interfaces/PublishedRelease.md +4 -4
- package/api/@wtf/semantic-release-npm/interfaces/SmokeOption.md +2 -2
- package/api/@wtf/semantic-release-npm/schema/type-aliases/PublishOptions.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/publishOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/publishSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/type-aliases/PublisherSpec.md +1 -1
- package/api/@wtf/semantic-release-npm/variables/default.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/functionOf.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/templatesOf.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-replace/interfaces/ReplacePluginOptions.md +5 -5
- package/api/@wtf/semantic-release-replace/schema/interfaces/ModuleExport.md +3 -3
- package/api/@wtf/semantic-release-replace/schema/interfaces/ReplaceOptions.md +4 -4
- package/api/@wtf/semantic-release-replace/schema/interfaces/RootTemplates.md +2 -2
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacement.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacementSpec.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTemplates.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTo.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplateSet.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplatesOption.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/exportedSetSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/replaceOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/replacementSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/rootTemplatesSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/templateSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/templatesSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/variables/default.md +1 -1
- package/api/@wtf/semantic-release-trains/config/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/skipRuleOf.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/skips.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/trainOptionsOf.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/interfaces/SkipContext.md +5 -5
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/SkipCheck.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/errors/type-aliases/PluginErrorCode.md +1 -1
- package/api/@wtf/semantic-release-trains/errors/variables/PLUGIN_ERRORS.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/decideTrain.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/dotenvOf.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/infoOf.md +1 -1
- package/api/@wtf/semantic-release-trains/info/interfaces/DecideRun.md +4 -4
- package/api/@wtf/semantic-release-trains/info/interfaces/InfoRun.md +8 -8
- package/api/@wtf/semantic-release-trains/info/interfaces/TrainDecision.md +5 -5
- package/api/@wtf/semantic-release-trains/info/interfaces/TrainInfo.md +5 -5
- package/api/@wtf/semantic-release-trains/interfaces/TrainsEntryOptions.md +5 -5
- package/api/@wtf/semantic-release-trains/interfaces/TrainsOptions.md +7 -7
- package/api/@wtf/semantic-release-trains/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/pluginSpecSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/skipRuleSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/trainsEntrySchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/trainsPluginSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/type-aliases/PluginSpec.md +1 -1
- package/api/@wtf/semantic-release-trains/type-aliases/TrainsPluginOptions.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/addChannel.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/analyzeCommits.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/default.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/fail.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/generateNotes.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/prepare.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/publish.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/success.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/verifyRelease.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/configOf.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/loadSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-validate/interfaces/ValidatePluginOptions.md +2 -2
- package/api/@wtf/semantic-release-validate/schema/interfaces/Validator.md +2 -2
- package/api/@wtf/semantic-release-validate/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/schema/variables/validateOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/variables/default.md +1 -1
- package/guides/changelogs.md +39 -28
- package/guides/ci-recipes.md +393 -271
- package/guides/configuring-trains.md +291 -203
- package/guides/dependency-rules.md +171 -113
- package/guides/ecosystems.md +222 -156
- package/guides/getting-started.md +135 -69
- package/guides/publishing-crates.md +208 -143
- package/guides/publishing-go-modules.md +170 -110
- package/guides/publishing-maven.md +197 -123
- package/guides/publishing.md +278 -191
- package/guides/system.md +50 -34
- package/guides/troubleshooting.md +358 -92
- package/guides/validating-a-config.md +68 -49
- package/package.json +1 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Cascade
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-trains/src/cascade.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-trains/src/cascade.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L58)
|
|
10
10
|
|
|
11
11
|
A range of a package of a train on a package of another train that the other train's last release
|
|
12
12
|
has left: the train's next release publishes it again, of that release.
|
|
@@ -17,7 +17,7 @@ has left: the train's next release publishes it again, of that release.
|
|
|
17
17
|
|
|
18
18
|
> `readonly` **ecosystem**: `string`
|
|
19
19
|
|
|
20
|
-
Defined in: [packages/release-trains/src/cascade.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
20
|
+
Defined in: [packages/release-trains/src/cascade.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L60)
|
|
21
21
|
|
|
22
22
|
The name of the ecosystem of both packages.
|
|
23
23
|
|
|
@@ -27,7 +27,7 @@ The name of the ecosystem of both packages.
|
|
|
27
27
|
|
|
28
28
|
> `readonly` **from**: `string`
|
|
29
29
|
|
|
30
|
-
Defined in: [packages/release-trains/src/cascade.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
30
|
+
Defined in: [packages/release-trains/src/cascade.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L62)
|
|
31
31
|
|
|
32
32
|
The package of the train that depends on the other.
|
|
33
33
|
|
|
@@ -37,7 +37,7 @@ The package of the train that depends on the other.
|
|
|
37
37
|
|
|
38
38
|
> `readonly` **kind**: [`CascadeKind`](../type-aliases/CascadeKind.md)
|
|
39
39
|
|
|
40
|
-
Defined in: [packages/release-trains/src/cascade.ts:66](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
40
|
+
Defined in: [packages/release-trains/src/cascade.ts:66](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L66)
|
|
41
41
|
|
|
42
42
|
How it depends on it, as `HEAD` has it, which the next release publishes.
|
|
43
43
|
|
|
@@ -47,7 +47,7 @@ How it depends on it, as `HEAD` has it, which the next release publishes.
|
|
|
47
47
|
|
|
48
48
|
> `readonly` **next**: `string`
|
|
49
49
|
|
|
50
|
-
Defined in: [packages/release-trains/src/cascade.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
50
|
+
Defined in: [packages/release-trains/src/cascade.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L72)
|
|
51
51
|
|
|
52
52
|
The range the next release publishes, of the other train's last release, as `^8.0.0`.
|
|
53
53
|
|
|
@@ -57,7 +57,7 @@ The range the next release publishes, of the other train's last release, as `^8.
|
|
|
57
57
|
|
|
58
58
|
> `readonly` **published**: `string`
|
|
59
59
|
|
|
60
|
-
Defined in: [packages/release-trains/src/cascade.ts:70](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
60
|
+
Defined in: [packages/release-trains/src/cascade.ts:70](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L70)
|
|
61
61
|
|
|
62
62
|
The range the train's last release published, as `^7.0.0`.
|
|
63
63
|
|
|
@@ -67,7 +67,7 @@ The range the train's last release published, as `^7.0.0`.
|
|
|
67
67
|
|
|
68
68
|
> `readonly` **range**: `string`
|
|
69
69
|
|
|
70
|
-
Defined in: [packages/release-trains/src/cascade.ts:68](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
70
|
+
Defined in: [packages/release-trains/src/cascade.ts:68](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L68)
|
|
71
71
|
|
|
72
72
|
The range as the train's last release had it in its manifest, as `workspace:^`.
|
|
73
73
|
|
|
@@ -77,7 +77,7 @@ The range as the train's last release had it in its manifest, as `workspace:^`.
|
|
|
77
77
|
|
|
78
78
|
> `readonly` **to**: `string`
|
|
79
79
|
|
|
80
|
-
Defined in: [packages/release-trains/src/cascade.ts:64](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
80
|
+
Defined in: [packages/release-trains/src/cascade.ts:64](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L64)
|
|
81
81
|
|
|
82
82
|
The package it depends on, of the other train.
|
|
83
83
|
|
|
@@ -87,7 +87,7 @@ The package it depends on, of the other train.
|
|
|
87
87
|
|
|
88
88
|
> `readonly` **train**: `string`
|
|
89
89
|
|
|
90
|
-
Defined in: [packages/release-trains/src/cascade.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
90
|
+
Defined in: [packages/release-trains/src/cascade.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L74)
|
|
91
91
|
|
|
92
92
|
The other train.
|
|
93
93
|
|
|
@@ -97,7 +97,7 @@ The other train.
|
|
|
97
97
|
|
|
98
98
|
> `readonly` **type**: `"major"` \| `"patch"`
|
|
99
99
|
|
|
100
|
-
Defined in: [packages/release-trains/src/cascade.ts:81](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
100
|
+
Defined in: [packages/release-trains/src/cascade.ts:81](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L81)
|
|
101
101
|
|
|
102
102
|
The type of release it makes of the train: `major` of a peer that a major of the other train
|
|
103
103
|
left, `patch` of any other.
|
|
@@ -108,6 +108,6 @@ left, `patch` of any other.
|
|
|
108
108
|
|
|
109
109
|
> `readonly` **version**: `string`
|
|
110
110
|
|
|
111
|
-
Defined in: [packages/release-trains/src/cascade.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
111
|
+
Defined in: [packages/release-trains/src/cascade.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L76)
|
|
112
112
|
|
|
113
113
|
The other train's last release, which the published range does not take, as `8.0.0`.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: CascadeCheck
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-trains/src/cascade.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-trains/src/cascade.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L85)
|
|
10
10
|
|
|
11
11
|
A train to find the releases it owes the trains it depends on, and where.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ A train to find the releases it owes the trains it depends on, and where.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` `optional` **cwd?**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-trains/src/cascade.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-trains/src/cascade.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L95)
|
|
20
20
|
|
|
21
21
|
The folder of the repo: the system's working folder by default.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ The folder of the repo: the system's working folder by default.
|
|
|
26
26
|
|
|
27
27
|
> `readonly` **ecosystems**: readonly [`Ecosystem`](../../ecosystem/interfaces/Ecosystem.md)[]
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-trains/src/cascade.ts:93](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-trains/src/cascade.ts:93](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L93)
|
|
30
30
|
|
|
31
31
|
The ecosystems of the repo, whose packages are read at the last release and at `HEAD`.
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ The ecosystems of the repo, whose packages are read at the last release and at `
|
|
|
36
36
|
|
|
37
37
|
> `readonly` `optional` **env?**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/release-trains/src/cascade.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
39
|
+
Defined in: [packages/release-trains/src/cascade.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L97)
|
|
40
40
|
|
|
41
41
|
The environment git runs in: the system's by default.
|
|
42
42
|
|
|
@@ -46,7 +46,7 @@ The environment git runs in: the system's by default.
|
|
|
46
46
|
|
|
47
47
|
> `readonly` **last**: `string` \| `undefined`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/release-trains/src/cascade.ts:91](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
49
|
+
Defined in: [packages/release-trains/src/cascade.ts:91](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L91)
|
|
50
50
|
|
|
51
51
|
The tag of the train's last release, as the release tool reads it: `undefined` of none.
|
|
52
52
|
|
|
@@ -56,7 +56,7 @@ The tag of the train's last release, as the release tool reads it: `undefined` o
|
|
|
56
56
|
|
|
57
57
|
> `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
|
|
58
58
|
|
|
59
|
-
Defined in: [packages/release-trains/src/cascade.ts:99](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
59
|
+
Defined in: [packages/release-trains/src/cascade.ts:99](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L99)
|
|
60
60
|
|
|
61
61
|
The system git runs by, which it requires.
|
|
62
62
|
|
|
@@ -66,7 +66,7 @@ The system git runs by, which it requires.
|
|
|
66
66
|
|
|
67
67
|
> `readonly` **train**: `string` \| `undefined`
|
|
68
68
|
|
|
69
|
-
Defined in: [packages/release-trains/src/cascade.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
69
|
+
Defined in: [packages/release-trains/src/cascade.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L89)
|
|
70
70
|
|
|
71
71
|
The train of the release.
|
|
72
72
|
|
|
@@ -76,6 +76,6 @@ The train of the release.
|
|
|
76
76
|
|
|
77
77
|
> `readonly` **trains**: [`Trains`](../../type-aliases/Trains.md)
|
|
78
78
|
|
|
79
|
-
Defined in: [packages/release-trains/src/cascade.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
79
|
+
Defined in: [packages/release-trains/src/cascade.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L87)
|
|
80
80
|
|
|
81
81
|
Every train of the repo.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **CascadeKind** = `Exclude`\<[`DependencyKind`](../../ecosystem/type-aliases/DependencyKind.md), `"dev"`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/cascade.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/cascade.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L46)
|
|
12
12
|
|
|
13
13
|
A kind of dependency a release cascades by: any but `dev`, which no user installs.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **ReleaseType** = *typeof* [`RELEASE_TYPES`](../variables/RELEASE_TYPES.md)\[`number`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/cascade.ts:52](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/cascade.ts:52](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L52)
|
|
12
12
|
|
|
13
13
|
A type of release: `major`, `minor` or `patch`.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **RELEASE\_TYPES**: readonly \[`"major"`, `"minor"`, `"patch"`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/cascade.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/cascade.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/cascade.ts#L49)
|
|
12
12
|
|
|
13
13
|
A type of release, of a commit analyzer, from the highest.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **isEcosystem**(`value`): `value is Ecosystem`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:132](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:132](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L132)
|
|
12
12
|
|
|
13
13
|
Whether `value` is an [Ecosystem](../interfaces/Ecosystem.md): of a name, and the three methods.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **loadEcosystems**(`names`, `load`): `Promise`\<[`Ecosystem`](../interfaces/Ecosystem.md)[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:163](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:163](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L163)
|
|
12
12
|
|
|
13
13
|
The ecosystems of `names`, as a config names them in `ecosystems`, each the default export of
|
|
14
14
|
the module of its name, which `load` loads, as a plugin loads it of the repo. Throws `EECOSYSTEM`
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **readPackages**(`ecosystems`, `context`): `Promise`\<[`EcosystemPackages`](../interfaces/EcosystemPackages.md)[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:227](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:227](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L227)
|
|
12
12
|
|
|
13
13
|
The packages of each ecosystem of `ecosystems` in the repo of `context`, at its `ref`.
|
|
14
14
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Dependency
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L46)
|
|
10
10
|
|
|
11
11
|
A dependency of a package on another package of its ecosystem in the repo.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ A dependency of a package on another package of its ecosystem in the repo.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **kind**: [`DependencyKind`](../type-aliases/DependencyKind.md)
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:50](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:50](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L50)
|
|
20
20
|
|
|
21
21
|
How it depends on it.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ How it depends on it.
|
|
|
26
26
|
|
|
27
27
|
> `readonly` **name**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L48)
|
|
30
30
|
|
|
31
31
|
The name of the package it depends on, of the same ecosystem, in this repo.
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ The name of the package it depends on, of the same ecosystem, in this repo.
|
|
|
36
36
|
|
|
37
37
|
> `readonly` **range**: `string` \| `undefined`
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:56](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
39
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:56](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L56)
|
|
40
40
|
|
|
41
41
|
The range as the manifest writes it, which a release publishes of the version of the package
|
|
42
42
|
it names, by [Ecosystem.resolve](Ecosystem.md#resolve), as `workspace:^` of npm; `undefined` where nothing of it
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Ecosystem
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:93](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:93](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L93)
|
|
10
10
|
|
|
11
11
|
An ecosystem: the packages of one kind of manifest of a repo, and its rules of ranges. A package
|
|
12
12
|
of an ecosystem's own, as `@wtf/release-npm`, gives one as its default export, which a config of
|
|
@@ -18,7 +18,7 @@ semantic-release names in `ecosystems`.
|
|
|
18
18
|
|
|
19
19
|
> `readonly` **name**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
21
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L95)
|
|
22
22
|
|
|
23
23
|
Its name, as an error, the notes and a key of the trains say it: `npm`, `cargo`.
|
|
24
24
|
|
|
@@ -28,7 +28,7 @@ Its name, as an error, the notes and a key of the trains say it: `npm`, `cargo`.
|
|
|
28
28
|
|
|
29
29
|
> **packages**(`context`): `Promise`\<readonly [`Package`](Package.md)[]\>
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
31
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L103)
|
|
32
32
|
|
|
33
33
|
The packages of the ecosystem in the repo of `context`, at its `ref`, by the system it gives:
|
|
34
34
|
each manifest of the repo, of its dependencies on the other packages of the ecosystem in it.
|
|
@@ -53,7 +53,7 @@ The packages, in an order of the ecosystem's own.
|
|
|
53
53
|
|
|
54
54
|
> **resolve**(`range`, `version`): `string`
|
|
55
55
|
|
|
56
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
56
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L113)
|
|
57
57
|
|
|
58
58
|
The range a release publishes of `range`, a range of a [Dependency](Dependency.md), of `version`, the
|
|
59
59
|
release of the package it names: `^7.0.0` of npm's `workspace:^` and `7.0.0`. A range of its
|
|
@@ -85,7 +85,7 @@ The range the release publishes.
|
|
|
85
85
|
|
|
86
86
|
> **satisfies**(`range`, `version`): `boolean`
|
|
87
87
|
|
|
88
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:123](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
88
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:123](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L123)
|
|
89
89
|
|
|
90
90
|
Whether `version` is within `range`, by the ecosystem's own rules of ranges: a prerelease within
|
|
91
91
|
its bounds too, as `7.1.0-beta.1` of `^7.0.0`. A range that names no version, as a tag or a
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: EcosystemContext
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L80)
|
|
10
10
|
|
|
11
11
|
Where an ecosystem reads its packages: the repo, its environment, the system, and the commit.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Where an ecosystem reads its packages: the repo, its environment, the system, an
|
|
|
20
20
|
|
|
21
21
|
> `readonly` `optional` **cwd?**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/release-system/src/git.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
23
|
+
Defined in: [packages/release-system/src/git.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/git.ts#L26)
|
|
24
24
|
|
|
25
25
|
The folder of the repo: the system's working folder by default.
|
|
26
26
|
|
|
@@ -34,7 +34,7 @@ The folder of the repo: the system's working folder by default.
|
|
|
34
34
|
|
|
35
35
|
> `readonly` `optional` **env?**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/release-system/src/git.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
37
|
+
Defined in: [packages/release-system/src/git.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/git.ts#L28)
|
|
38
38
|
|
|
39
39
|
The environment of git: the system's by default.
|
|
40
40
|
|
|
@@ -48,7 +48,7 @@ The environment of git: the system's by default.
|
|
|
48
48
|
|
|
49
49
|
> `readonly` `optional` **ref?**: `string`
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
51
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L85)
|
|
52
52
|
|
|
53
53
|
The commit to read the packages at, by git, as `HEAD` or the tag of a release: the files of the
|
|
54
54
|
working tree that git tracks by default.
|
|
@@ -59,7 +59,7 @@ working tree that git tracks by default.
|
|
|
59
59
|
|
|
60
60
|
> `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
|
|
61
61
|
|
|
62
|
-
Defined in: [packages/release-system/src/git.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
62
|
+
Defined in: [packages/release-system/src/git.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/git.ts#L30)
|
|
63
63
|
|
|
64
64
|
The system git runs by, which it requires.
|
|
65
65
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: EcosystemPackages
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:215](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:215](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L215)
|
|
10
10
|
|
|
11
11
|
The packages of one ecosystem of a repo, as [readPackages](../functions/readPackages.md) reads them.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ The packages of one ecosystem of a repo, as [readPackages](../functions/readPack
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **ecosystem**: [`Ecosystem`](Ecosystem.md)
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:216](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:216](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L216)
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
@@ -24,4 +24,4 @@ Defined in: [packages/release-trains/src/ecosystem.ts:216](https://gitlab.com/we
|
|
|
24
24
|
|
|
25
25
|
> `readonly` **packages**: readonly [`Package`](Package.md)[]
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:217](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
27
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:217](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L217)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Package
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L60)
|
|
10
10
|
|
|
11
11
|
A package of an ecosystem in the repo: one manifest, and its folder.
|
|
12
12
|
|
|
@@ -23,7 +23,7 @@ A package of an ecosystem in the repo: one manifest, and its folder.
|
|
|
23
23
|
|
|
24
24
|
> `readonly` **dependencies**: readonly [`Dependency`](Dependency.md)[]
|
|
25
25
|
|
|
26
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
26
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L76)
|
|
27
27
|
|
|
28
28
|
Its dependencies on the other packages of its ecosystem in the repo.
|
|
29
29
|
|
|
@@ -33,7 +33,7 @@ Its dependencies on the other packages of its ecosystem in the repo.
|
|
|
33
33
|
|
|
34
34
|
> `readonly` **dir**: `string`
|
|
35
35
|
|
|
36
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
36
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L67)
|
|
37
37
|
|
|
38
38
|
Its folder, from the root of the repo, as `packages/core`; `.` of the root. A train holds it
|
|
39
39
|
when the train's `paths` hold this folder.
|
|
@@ -44,7 +44,7 @@ when the train's `paths` hold this folder.
|
|
|
44
44
|
|
|
45
45
|
> `readonly` **manifest**: `string`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
47
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L69)
|
|
48
48
|
|
|
49
49
|
Its manifest, from the root of the repo, as `packages/core/package.json`.
|
|
50
50
|
|
|
@@ -54,7 +54,7 @@ Its manifest, from the root of the repo, as `packages/core/package.json`.
|
|
|
54
54
|
|
|
55
55
|
> `readonly` **name**: `string`
|
|
56
56
|
|
|
57
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
57
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L62)
|
|
58
58
|
|
|
59
59
|
Its name, the one its ecosystem's registry knows it by: unique of the ecosystem in the repo.
|
|
60
60
|
|
|
@@ -64,7 +64,7 @@ Its name, the one its ecosystem's registry knows it by: unique of the ecosystem
|
|
|
64
64
|
|
|
65
65
|
> `readonly` **published**: `boolean`
|
|
66
66
|
|
|
67
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
67
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L74)
|
|
68
68
|
|
|
69
69
|
Whether a release publishes it: not of an npm package that is private, nor of a crate of
|
|
70
70
|
`publish = false`.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **DependencyKind** = `"runtime"` \| `"peer"` \| `"build"` \| `"dev"`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L40)
|
|
12
12
|
|
|
13
13
|
How a package depends on another: `runtime`, what it runs with; `peer`, what its users install
|
|
14
14
|
beside it; `build`, what its build runs with; and `dev`, what its own tests and tools run with,
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **ModuleLoader** = (`name`) => `Promise`\<`unknown`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:151](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:151](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L151)
|
|
12
12
|
|
|
13
13
|
What loads a module of its name, as `import()` of a plugin does, of where the plugin finds it:
|
|
14
14
|
the module's namespace, of its default export.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **DEPENDENCY\_KINDS**: readonly [`DependencyKind`](../type-aliases/DependencyKind.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L43)
|
|
12
12
|
|
|
13
13
|
Each [DependencyKind](../type-aliases/DependencyKind.md), in the order a cascade judges them.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: TrainsError
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-trains/src/errors.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-trains/src/errors.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/errors.ts#L46)
|
|
10
10
|
|
|
11
11
|
An error of a train, or of a package of release trains: a stable `code`, of
|
|
12
12
|
[TRAINS\_ERRORS](../variables/TRAINS_ERRORS.md) or of the package's own, its `message` what is wrong, and its `details` how
|
|
@@ -22,7 +22,7 @@ to fix it. semantic-release prints it as a `SemanticReleaseError`.
|
|
|
22
22
|
|
|
23
23
|
> **new TrainsError**(`code`, `message`, `details`): `TrainsError`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/release-system/src/errors.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
25
|
+
Defined in: [packages/release-system/src/errors.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L54)
|
|
26
26
|
|
|
27
27
|
An error of `code`, of its `message` and its `details`, named `SemanticReleaseError`, as
|
|
28
28
|
semantic-release prints one.
|
|
@@ -73,7 +73,7 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
|
|
|
73
73
|
|
|
74
74
|
> `readonly` **code**: `string`
|
|
75
75
|
|
|
76
|
-
Defined in: [packages/release-system/src/errors.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
76
|
+
Defined in: [packages/release-system/src/errors.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L40)
|
|
77
77
|
|
|
78
78
|
The stable code of the error, as `EGIT`.
|
|
79
79
|
|
|
@@ -87,7 +87,7 @@ The stable code of the error, as `EGIT`.
|
|
|
87
87
|
|
|
88
88
|
> `readonly` **details**: `string`
|
|
89
89
|
|
|
90
|
-
Defined in: [packages/release-system/src/errors.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
90
|
+
Defined in: [packages/release-system/src/errors.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L42)
|
|
91
91
|
|
|
92
92
|
How to fix it.
|
|
93
93
|
|
|
@@ -125,7 +125,7 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
|
|
|
125
125
|
|
|
126
126
|
> `readonly` **semanticRelease**: `true`
|
|
127
127
|
|
|
128
|
-
Defined in: [packages/release-system/src/errors.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
128
|
+
Defined in: [packages/release-system/src/errors.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L44)
|
|
129
129
|
|
|
130
130
|
The mark semantic-release prints an error of a plugin by.
|
|
131
131
|
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **TrainsErrorCode** = keyof *typeof* [`TRAINS_ERRORS`](../variables/TRAINS_ERRORS.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/errors.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/errors.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/errors.ts#L39)
|
|
12
12
|
|
|
13
13
|
A code of [TRAINS\_ERRORS](../variables/TRAINS_ERRORS.md).
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **TRAINS\_ERRORS**: `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/errors.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/errors.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/errors.ts#L15)
|
|
12
12
|
|
|
13
13
|
The codes of the errors of the trains themselves, each with what it means.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **filesIn**(`folder`, `options`): `Promise`\<`string`[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/generated.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/generated.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L49)
|
|
12
12
|
|
|
13
13
|
Each file in `folder` and the folders in it, relative to it, with `/`, in order.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **formatGenerated**(`files`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/generated.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/generated.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L69)
|
|
12
12
|
|
|
13
13
|
The text of a list of `files`: each, and the list itself, once, in order, one a line.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **listGenerated**(`root`, `dir`, `options`): `Promise`\<`string`[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/generated.ts:91](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/generated.ts:91](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L91)
|
|
12
12
|
|
|
13
13
|
Lists each file in the folder `dir` of `root`, as the build generated it, in its
|
|
14
14
|
[GENERATED](../variables/GENERATED.md), the list too, and gives them. Run it once the build has written the folder
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **parseGenerated**(`text`): `string`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/generated.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/generated.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L78)
|
|
12
12
|
|
|
13
13
|
The files a list names, of its text.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **readGenerated**(`root`, `dir`, `options`): `Promise`\<`string`[] \| `undefined`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/generated.ts:117](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/generated.ts:117](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L117)
|
|
12
12
|
|
|
13
13
|
The files the [GENERATED](../variables/GENERATED.md) of the folder `dir` of `root` lists; `undefined`, of no list.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **stageGenerated**(`dir`, `listed`): `string`[][]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/generated.ts:161](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/generated.ts:161](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L161)
|
|
12
12
|
|
|
13
13
|
The git commands that stage the folder `dir` for the release commit, each its arguments: as its
|
|
14
14
|
[GENERATED](../variables/GENERATED.md) lists it, of `listed`, each file of it unstaged, each one the list names staged,
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **stageGeneratedFolders**(`options`): `Promise`\<`string`[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-trains/src/generated.ts:197](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-trains/src/generated.ts:197](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/generated.ts#L197)
|
|
12
12
|
|
|
13
13
|
Stages each of `folders` for the release commit, as [stageGenerated](stageGenerated.md) does, by git of the
|
|
14
14
|
system: run it once the build has written them, and before the commit. Gives each it staged.
|