@wtf/release-docs 8.2.1 → 8.2.3
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 +81 -56
- package/package.json +1 -1
|
@@ -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/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/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/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/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/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/prepare.ts#L78)
|
|
30
30
|
|
|
31
31
|
The version of the release, of the package.
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ 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/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/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
42
|
of a package of the train, the release's; of another train's, its own, as released.
|
|
@@ -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/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/prepare.ts#L88)
|
|
65
65
|
|
|
66
66
|
The name of each package of the workspace.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: PreparedManifest
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/prepare.ts:94](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/prepare.ts:94](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/prepare.ts#L94)
|
|
10
10
|
|
|
11
11
|
What [prepareManifest](../functions/prepareManifest.md) made of a manifest, and what it changed.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ What [prepareManifest](../functions/prepareManifest.md) made of a manifest, and
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **dropped**: `number`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-npm/src/prepare.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-npm/src/prepare.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/prepare.ts#L101)
|
|
20
20
|
|
|
21
21
|
The devDependencies of the workspace by a `workspace:` range of no version dropped.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ The devDependencies of the workspace by a `workspace:` range of no version dropp
|
|
|
26
26
|
|
|
27
27
|
> `readonly` **manifest**: `Record`\<`string`, `unknown`\>
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-npm/src/prepare.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-npm/src/prepare.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/prepare.ts#L95)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/release-npm/src/prepare.ts:95](https://gitlab.com/wetryfun
|
|
|
34
34
|
|
|
35
35
|
> `readonly` **resolved**: `number`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/release-npm/src/prepare.ts:99](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
37
|
+
Defined in: [packages/release-npm/src/prepare.ts:99](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/prepare.ts#L99)
|
|
38
38
|
|
|
39
39
|
The `workspace:` ranges resolved.
|
|
40
40
|
|
|
@@ -44,7 +44,7 @@ The `workspace:` ranges resolved.
|
|
|
44
44
|
|
|
45
45
|
> `readonly` **stripped**: `number`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/release-npm/src/prepare.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
47
|
+
Defined in: [packages/release-npm/src/prepare.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/prepare.ts#L103)
|
|
48
48
|
|
|
49
49
|
The exports of the source stripped.
|
|
50
50
|
|
|
@@ -54,6 +54,6 @@ The exports of the source stripped.
|
|
|
54
54
|
|
|
55
55
|
> `readonly` **versioned**: `boolean`
|
|
56
56
|
|
|
57
|
-
Defined in: [packages/release-npm/src/prepare.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
57
|
+
Defined in: [packages/release-npm/src/prepare.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/prepare.ts#L97)
|
|
58
58
|
|
|
59
59
|
Whether its version was another.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **SOURCE\_CONDITIONS**: readonly `string`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/prepare.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/prepare.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/prepare.ts#L15)
|
|
12
12
|
|
|
13
13
|
The export conditions of the source by default, which no tarball ships.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **builtInPublisher**(`name`): [`Publisher`](../../interfaces/Publisher.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/publishers.ts:375](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/publishers.ts:375](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/publishers.ts#L375)
|
|
12
12
|
|
|
13
13
|
The publisher built in of `name` ([PUBLISHERS](../variables/PUBLISHERS.md)). Throws `EPUBLISHER` of a name none is
|
|
14
14
|
built in of.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **isPublisher**(`value`): `value is Publisher`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/publishers.ts:358](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/publishers.ts:358](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/publishers.ts#L358)
|
|
12
12
|
|
|
13
13
|
Whether `value` is a [Publisher](../../interfaces/Publisher.md): a `name`, and `lookup` and `publish` functions, and
|
|
14
14
|
`pack`, `tag` and `page`, where it has them, functions too.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **NPM\_REGISTRY**: `"https://registry.npmjs.org/"` = `'https://registry.npmjs.org/'`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/publishers.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/publishers.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/publishers.ts#L24)
|
|
12
12
|
|
|
13
13
|
npm's registry, whose pages [npmPublisher](npmPublisher.md) links.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **PUBLISHERS**: `Readonly`\<`Record`\<`string`, [`Publisher`](../../interfaces/Publisher.md)\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/publishers.ts:346](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/publishers.ts:346](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/publishers.ts#L346)
|
|
12
12
|
|
|
13
13
|
The publishers built in, by name.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **npmPublisher**: [`Publisher`](../../interfaces/Publisher.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/publishers.ts:274](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/publishers.ts:274](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/publishers.ts#L274)
|
|
12
12
|
|
|
13
13
|
The publisher of the `npm` bin: whether a version is published, and where a dist-tag points, by
|
|
14
14
|
`npm view`; each package packed by `npm pack`, of no lifecycle script, as the build ran before
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **pnpmPublisher**: [`Publisher`](../../interfaces/Publisher.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/publishers.ts:321](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/publishers.ts:321](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/publishers.ts#L321)
|
|
12
12
|
|
|
13
13
|
The publisher of the `pnpm` bin: whether a version is published, and where a dist-tag points, by
|
|
14
14
|
`npm view`, as pnpm asks npm's registry the same way; each package published from its folder by
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **checkTrain**(`release`): `Promise`\<`string`[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/release.ts:1037](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/release.ts:1037](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L1037)
|
|
12
12
|
|
|
13
13
|
Checks the packages of a train as they are in the repo, before a release makes them ready: each
|
|
14
14
|
scoped one public, of a license and a repository, none running with a private package, and an
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **distTagOf**(`version`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/release.ts:68](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/release.ts:68](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L68)
|
|
12
12
|
|
|
13
13
|
The dist-tag of a version: `latest` of a release, and the first identifier of a prerelease, `beta`
|
|
14
14
|
of `2.1.0-beta.3`, the channel of the branch semantic-release named it after; `prerelease` of one
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **packTrain**(`resolved`, `options`): `Promise`\<[`PackedTrain`](../interfaces/PackedTrain.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/release.ts:354](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/release.ts:354](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L354)
|
|
12
12
|
|
|
13
13
|
Packs the packages of a release, of the manifests [resolveManifests](resolveManifests.md) gave: each package's
|
|
14
14
|
folder copied, but its `node_modules`, into a folder of the system's temporary files, its manifest
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **publishPacked**(`packed`, `run`): `Promise`\<[`PublishedTrain`](../interfaces/PublishedTrain.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/release.ts:837](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/release.ts:837](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L837)
|
|
12
12
|
|
|
13
13
|
Publishes a release [packTrain](packTrain.md) packed, by [publishTrain](publishTrain.md), and removes what it packed:
|
|
14
14
|
every tarball, of a `tarballDir` named too, of a publish that fails, whose error is the one
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **publishTrain**(`packed`, `run`): `Promise`\<[`PublishedTrain`](../interfaces/PublishedTrain.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/release.ts:658](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/release.ts:658](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L658)
|
|
12
12
|
|
|
13
13
|
Publishes the packages [packTrain](packTrain.md) packed, each in order, under the dist-tag of the
|
|
14
14
|
channel, with the provenance of the build where the CI gives an ID token, and skips each the
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **publishedOf**(`packed`, `run`): `Promise`\<[`PublishedOf`](../interfaces/PublishedOf.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/release.ts:510](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/release.ts:510](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L510)
|
|
12
12
|
|
|
13
13
|
The packages of a packed release that the registry has at its version already, by name, asked by
|
|
14
14
|
the publisher's [Publisher.lookup](../../interfaces/Publisher.md#lookup), a few at a time; and, of a publisher that reads
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **publishedOfResolved**(`resolved`, `run`): `Promise`\<[`PublishedOf`](../interfaces/PublishedOf.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/release.ts:530](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/release.ts:530](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L530)
|
|
12
12
|
|
|
13
13
|
[publishedOf](publishedOf.md) of a release [resolveManifests](resolveManifests.md) resolved, packed of nothing: each
|
|
14
14
|
package of its folder in the repo, by the publisher of `run`, npm's by default. As the job of a
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **releaseTrain**(`release`): `Promise`\<[`PublishedTrain`](../interfaces/PublishedTrain.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/release.ts:822](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/release.ts:822](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L822)
|
|
12
12
|
|
|
13
13
|
Publishes a release of a train in one call, as a job of the pipeline of its tag does: its
|
|
14
14
|
manifests resolved ([resolveManifests](resolveManifests.md)), its packages packed ([packTrain](packTrain.md)) and
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **resolveManifests**(`release`): `Promise`\<[`ResolvedTrain`](../interfaces/ResolvedTrain.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/release.ts:196](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/release.ts:196](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L196)
|
|
12
12
|
|
|
13
13
|
The manifest of each package of the train that publishes, as it publishes, in the order to
|
|
14
14
|
publish them in, and checked: of the version of the release; each `workspace:` range of a package
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **tagTrain**(`release`): `Promise`\<[`PublishedTrain`](../interfaces/PublishedTrain.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/release.ts:929](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/release.ts:929](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L929)
|
|
12
12
|
|
|
13
13
|
Moves a release of a train published already to the channel of `channel`: the dist-tag of each
|
|
14
14
|
package of the train that publishes pointed at the version, in the order of publishing, by the
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: CheckRelease
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/release.ts:1015](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/release.ts:1015](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L1015)
|
|
10
10
|
|
|
11
11
|
The packages of a train to check before a release, as they are in the repo.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ The packages of a train to check before a release, as they are in the repo.
|
|
|
20
20
|
|
|
21
21
|
> `readonly` `optional` **access?**: `"public"` \| `"restricted"`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/release-npm/src/types.ts:148](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
23
|
+
Defined in: [packages/release-npm/src/types.ts:148](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/types.ts#L148)
|
|
24
24
|
|
|
25
25
|
The access of each package: its `publishConfig.access` by default.
|
|
26
26
|
|
|
@@ -34,7 +34,7 @@ The access of each package: its `publishConfig.access` by default.
|
|
|
34
34
|
|
|
35
35
|
> `readonly` `optional` **aside?**: readonly `string`[]
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/release-npm/src/types.ts:172](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
37
|
+
Defined in: [packages/release-npm/src/types.ts:172](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/types.ts#L172)
|
|
38
38
|
|
|
39
39
|
The packages, by name, each published under the dist-tag of its major's line where its dist-tag
|
|
40
40
|
points above the release, as one that joined the train at a higher version of its own:
|
|
@@ -52,7 +52,7 @@ other package whose dist-tag points above the release fails it, and nothing is p
|
|
|
52
52
|
|
|
53
53
|
> `readonly` `optional` **check?**: `boolean`
|
|
54
54
|
|
|
55
|
-
Defined in: [packages/release-npm/src/types.ts:164](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
55
|
+
Defined in: [packages/release-npm/src/types.ts:164](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/types.ts#L164)
|
|
56
56
|
|
|
57
57
|
Whether the packages are checked before the first publish: `true`.
|
|
58
58
|
|
|
@@ -66,7 +66,7 @@ Whether the packages are checked before the first publish: `true`.
|
|
|
66
66
|
|
|
67
67
|
> `readonly` `optional` **conditions?**: readonly `string`[]
|
|
68
68
|
|
|
69
|
-
Defined in: [packages/release-npm/src/types.ts:162](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
69
|
+
Defined in: [packages/release-npm/src/types.ts:162](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/types.ts#L162)
|
|
70
70
|
|
|
71
71
|
The export conditions of the source, which no tarball ships: `['source']`.
|
|
72
72
|
|
|
@@ -80,7 +80,7 @@ The export conditions of the source, which no tarball ships: `['source']`.
|
|
|
80
80
|
|
|
81
81
|
> `readonly` `optional` **cwd?**: `string`
|
|
82
82
|
|
|
83
|
-
Defined in: [packages/release-npm/src/release.ts:1021](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
83
|
+
Defined in: [packages/release-npm/src/release.ts:1021](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L1021)
|
|
84
84
|
|
|
85
85
|
The folder of the repo: the system's working folder by default.
|
|
86
86
|
|
|
@@ -90,7 +90,7 @@ The folder of the repo: the system's working folder by default.
|
|
|
90
90
|
|
|
91
91
|
> `readonly` `optional` **distTag?**: `string`
|
|
92
92
|
|
|
93
|
-
Defined in: [packages/release-npm/src/types.ts:191](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
93
|
+
Defined in: [packages/release-npm/src/types.ts:191](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/types.ts#L191)
|
|
94
94
|
|
|
95
95
|
The dist-tag every package is published under, over the one of the channel of the release, as a
|
|
96
96
|
one-off: an empty one is none. The channel's by default.
|
|
@@ -105,7 +105,7 @@ one-off: an empty one is none. The channel's by default.
|
|
|
105
105
|
|
|
106
106
|
> `readonly` `optional` **first?**: `string`
|
|
107
107
|
|
|
108
|
-
Defined in: [packages/release-npm/src/types.ts:158](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
108
|
+
Defined in: [packages/release-npm/src/types.ts:158](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/types.ts#L158)
|
|
109
109
|
|
|
110
110
|
The folder of the package published first, as a base: none by default.
|
|
111
111
|
|
|
@@ -119,7 +119,7 @@ The folder of the package published first, as a base: none by default.
|
|
|
119
119
|
|
|
120
120
|
> `readonly` `optional` **last?**: `string`
|
|
121
121
|
|
|
122
|
-
Defined in: [packages/release-npm/src/types.ts:160](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
122
|
+
Defined in: [packages/release-npm/src/types.ts:160](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/types.ts#L160)
|
|
123
123
|
|
|
124
124
|
The folder of the package published last, as a docs package: none by default.
|
|
125
125
|
|
|
@@ -133,7 +133,7 @@ The folder of the package published last, as a docs package: none by default.
|
|
|
133
133
|
|
|
134
134
|
> `readonly` `optional` **pack?**: readonly `string`[]
|
|
135
135
|
|
|
136
|
-
Defined in: [packages/release-npm/src/types.ts:186](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
136
|
+
Defined in: [packages/release-npm/src/types.ts:186](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/types.ts#L186)
|
|
137
137
|
|
|
138
138
|
The private packages of the train, each by its folder, from the root of the repo, or a glob of
|
|
139
139
|
folders, packed beside those that publish, into the folder of the tarballs, and never published:
|
|
@@ -151,7 +151,7 @@ resolved to it too. None by default.
|
|
|
151
151
|
|
|
152
152
|
> `readonly` `optional` **provenance?**: `boolean` \| `"auto"`
|
|
153
153
|
|
|
154
|
-
Defined in: [packages/release-npm/src/types.ts:154](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
154
|
+
Defined in: [packages/release-npm/src/types.ts:154](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/types.ts#L154)
|
|
155
155
|
|
|
156
156
|
Whether each package is published with the provenance of the build: `auto`, the default, where
|
|
157
157
|
the CI gives an ID token that npm signs it by (`SIGSTORE_ID_TOKEN` on GitLab, GitHub's OIDC),
|
|
@@ -167,7 +167,7 @@ on a runner it hosts: npm refuses provenance of a self-hosted runner.
|
|
|
167
167
|
|
|
168
168
|
> `readonly` `optional` **registry?**: `string`
|
|
169
169
|
|
|
170
|
-
Defined in: [packages/release-npm/src/types.ts:156](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
170
|
+
Defined in: [packages/release-npm/src/types.ts:156](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/types.ts#L156)
|
|
171
171
|
|
|
172
172
|
The registry: each package's `publishConfig.registry`, or the publisher's, by default.
|
|
173
173
|
|
|
@@ -181,7 +181,7 @@ The registry: each package's `publishConfig.registry`, or the publisher's, by de
|
|
|
181
181
|
|
|
182
182
|
> `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
|
|
183
183
|
|
|
184
|
-
Defined in: [packages/release-npm/src/release.ts:1023](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
184
|
+
Defined in: [packages/release-npm/src/release.ts:1023](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L1023)
|
|
185
185
|
|
|
186
186
|
The system it runs by, which it requires.
|
|
187
187
|
|
|
@@ -191,7 +191,7 @@ The system it runs by, which it requires.
|
|
|
191
191
|
|
|
192
192
|
> `readonly` `optional` **tarballDir?**: `string`
|
|
193
193
|
|
|
194
|
-
Defined in: [packages/release-npm/src/types.ts:178](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
194
|
+
Defined in: [packages/release-npm/src/types.ts:178](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/types.ts#L178)
|
|
195
195
|
|
|
196
196
|
The folder the tarballs are packed into, from the root of the repo or absolute, where they stay
|
|
197
197
|
after the release, as assets of the release of the host: one of the system's temporary files by
|
|
@@ -207,7 +207,7 @@ default, which goes.
|
|
|
207
207
|
|
|
208
208
|
> `readonly` **train**: `string` \| `undefined`
|
|
209
209
|
|
|
210
|
-
Defined in: [packages/release-npm/src/release.ts:1019](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
210
|
+
Defined in: [packages/release-npm/src/release.ts:1019](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L1019)
|
|
211
211
|
|
|
212
212
|
The train of the release.
|
|
213
213
|
|
|
@@ -217,6 +217,6 @@ The train of the release.
|
|
|
217
217
|
|
|
218
218
|
> `readonly` **trains**: [`Trains`](../../../release-trains/type-aliases/Trains.md)
|
|
219
219
|
|
|
220
|
-
Defined in: [packages/release-npm/src/release.ts:1017](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
220
|
+
Defined in: [packages/release-npm/src/release.ts:1017](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L1017)
|
|
221
221
|
|
|
222
222
|
Every train of the repo.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: PackOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/release.ts:287](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/release.ts:287](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L287)
|
|
10
10
|
|
|
11
11
|
How [packTrain](../functions/packTrain.md) packs, and [publishTrain](../functions/publishTrain.md) publishes, the packages of a release.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ How [packTrain](../functions/packTrain.md) packs, and [publishTrain](../function
|
|
|
16
16
|
|
|
17
17
|
> `readonly` `optional` **cwd?**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-npm/src/release.ts:291](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-npm/src/release.ts:291](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L291)
|
|
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` `optional` **dryRun?**: `boolean`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-npm/src/release.ts:303](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-npm/src/release.ts:303](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L303)
|
|
30
30
|
|
|
31
31
|
Whether the run publishes nothing for real, and asks the registry and says what it would.
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ Whether the run publishes nothing for real, and asks the registry and says what
|
|
|
36
36
|
|
|
37
37
|
> `readonly` `optional` **env?**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/release-npm/src/release.ts:293](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
39
|
+
Defined in: [packages/release-npm/src/release.ts:293](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L293)
|
|
40
40
|
|
|
41
41
|
The environment the publisher runs in: the system's by default.
|
|
42
42
|
|
|
@@ -46,7 +46,7 @@ The environment the publisher runs in: the system's by default.
|
|
|
46
46
|
|
|
47
47
|
> `readonly` `optional` **log?**: (`line`) => `void`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/release-npm/src/release.ts:309](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
49
|
+
Defined in: [packages/release-npm/src/release.ts:309](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L309)
|
|
50
50
|
|
|
51
51
|
Where each line of what it does goes: nowhere by default.
|
|
52
52
|
|
|
@@ -68,7 +68,7 @@ The line of what it does, of no newline.
|
|
|
68
68
|
|
|
69
69
|
> `readonly` `optional` **publisher?**: [`Publisher`](../../interfaces/Publisher.md)
|
|
70
70
|
|
|
71
|
-
Defined in: [packages/release-npm/src/release.ts:289](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
71
|
+
Defined in: [packages/release-npm/src/release.ts:289](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L289)
|
|
72
72
|
|
|
73
73
|
The publisher: `npmPublisher` of `./publishers` by default.
|
|
74
74
|
|
|
@@ -78,7 +78,7 @@ The publisher: `npmPublisher` of `./publishers` by default.
|
|
|
78
78
|
|
|
79
79
|
> `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
|
|
80
80
|
|
|
81
|
-
Defined in: [packages/release-npm/src/release.ts:295](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
81
|
+
Defined in: [packages/release-npm/src/release.ts:295](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L295)
|
|
82
82
|
|
|
83
83
|
The system it runs by, which it requires.
|
|
84
84
|
|
|
@@ -88,7 +88,7 @@ The system it runs by, which it requires.
|
|
|
88
88
|
|
|
89
89
|
> `readonly` `optional` **tarballDir?**: `string`
|
|
90
90
|
|
|
91
|
-
Defined in: [packages/release-npm/src/release.ts:301](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
91
|
+
Defined in: [packages/release-npm/src/release.ts:301](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L301)
|
|
92
92
|
|
|
93
93
|
The folder the tarballs are packed into, from the root of the repo or absolute, where they stay
|
|
94
94
|
after `cleanup`: one of the system's temporary files by default, which goes. One in the repo is
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: PackedTrain
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/release.ts:313](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/release.ts:313](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L313)
|
|
10
10
|
|
|
11
11
|
The packages of a release of a train, staged and packed by [packTrain](../functions/packTrain.md).
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ The packages of a release of a train, staged and packed by [packTrain](../functi
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **cleanup**: () => `Promise`\<`void`\>
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-npm/src/release.ts:333](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-npm/src/release.ts:333](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L333)
|
|
20
20
|
|
|
21
21
|
Removes the copies, and the tarballs of the folder of the system's temporary files; the tarballs
|
|
22
22
|
of a folder the caller names stay, as for assets of the release of the host.
|
|
@@ -31,7 +31,7 @@ of a folder the caller names stay, as for assets of the release of the host.
|
|
|
31
31
|
|
|
32
32
|
> `readonly` **discard**: () => `Promise`\<`void`\>
|
|
33
33
|
|
|
34
|
-
Defined in: [packages/release-npm/src/release.ts:338](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
34
|
+
Defined in: [packages/release-npm/src/release.ts:338](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L338)
|
|
35
35
|
|
|
36
36
|
Removes the copies and every tarball, of a folder the caller names too, of a release that
|
|
37
37
|
failed, which has none of them: each, whichever removal fails.
|
|
@@ -46,7 +46,7 @@ failed, which has none of them: each, whichever removal fails.
|
|
|
46
46
|
|
|
47
47
|
> `readonly` **distTag**: `string`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/release-npm/src/release.ts:317](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
49
|
+
Defined in: [packages/release-npm/src/release.ts:317](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L317)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
@@ -54,7 +54,7 @@ Defined in: [packages/release-npm/src/release.ts:317](https://gitlab.com/wetryfu
|
|
|
54
54
|
|
|
55
55
|
> `readonly` **packages**: readonly [`PublishPackage`](../../interfaces/PublishPackage.md)[]
|
|
56
56
|
|
|
57
|
-
Defined in: [packages/release-npm/src/release.ts:320](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
57
|
+
Defined in: [packages/release-npm/src/release.ts:320](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L320)
|
|
58
58
|
|
|
59
59
|
Each package, in the order of publishing, its folder the copy it was packed of.
|
|
60
60
|
|
|
@@ -64,7 +64,7 @@ Each package, in the order of publishing, its folder the copy it was packed of.
|
|
|
64
64
|
|
|
65
65
|
> `readonly` **packOnly**: readonly [`PublishPackage`](../../interfaces/PublishPackage.md)[]
|
|
66
66
|
|
|
67
|
-
Defined in: [packages/release-npm/src/release.ts:322](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
67
|
+
Defined in: [packages/release-npm/src/release.ts:322](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L322)
|
|
68
68
|
|
|
69
69
|
Each private package of `pack`, its folder the copy it was packed of, never published.
|
|
70
70
|
|
|
@@ -74,7 +74,7 @@ Each private package of `pack`, its folder the copy it was packed of, never publ
|
|
|
74
74
|
|
|
75
75
|
> `readonly` **publisher**: [`Publisher`](../../interfaces/Publisher.md)
|
|
76
76
|
|
|
77
|
-
Defined in: [packages/release-npm/src/release.ts:318](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
77
|
+
Defined in: [packages/release-npm/src/release.ts:318](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L318)
|
|
78
78
|
|
|
79
79
|
***
|
|
80
80
|
|
|
@@ -82,7 +82,7 @@ Defined in: [packages/release-npm/src/release.ts:318](https://gitlab.com/wetryfu
|
|
|
82
82
|
|
|
83
83
|
> `readonly` **staging**: `string`
|
|
84
84
|
|
|
85
|
-
Defined in: [packages/release-npm/src/release.ts:326](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
85
|
+
Defined in: [packages/release-npm/src/release.ts:326](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L326)
|
|
86
86
|
|
|
87
87
|
The folder of the copies, of the system's temporary files.
|
|
88
88
|
|
|
@@ -92,7 +92,7 @@ The folder of the copies, of the system's temporary files.
|
|
|
92
92
|
|
|
93
93
|
> `readonly` **tarballDir**: `string`
|
|
94
94
|
|
|
95
|
-
Defined in: [packages/release-npm/src/release.ts:328](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
95
|
+
Defined in: [packages/release-npm/src/release.ts:328](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L328)
|
|
96
96
|
|
|
97
97
|
The folder the tarballs are in, absolute.
|
|
98
98
|
|
|
@@ -102,7 +102,7 @@ The folder the tarballs are in, absolute.
|
|
|
102
102
|
|
|
103
103
|
> `readonly` **tarballs**: `ReadonlyMap`\<`string`, `string`\>
|
|
104
104
|
|
|
105
|
-
Defined in: [packages/release-npm/src/release.ts:324](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
105
|
+
Defined in: [packages/release-npm/src/release.ts:324](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L324)
|
|
106
106
|
|
|
107
107
|
The tarball of each package, by its name, where the publisher packs.
|
|
108
108
|
|
|
@@ -112,7 +112,7 @@ The tarball of each package, by its name, where the publisher packs.
|
|
|
112
112
|
|
|
113
113
|
> `readonly` **train**: `string`
|
|
114
114
|
|
|
115
|
-
Defined in: [packages/release-npm/src/release.ts:315](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
115
|
+
Defined in: [packages/release-npm/src/release.ts:315](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L315)
|
|
116
116
|
|
|
117
117
|
The name of the train.
|
|
118
118
|
|
|
@@ -122,4 +122,4 @@ The name of the train.
|
|
|
122
122
|
|
|
123
123
|
> `readonly` **version**: `string`
|
|
124
124
|
|
|
125
|
-
Defined in: [packages/release-npm/src/release.ts:316](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
125
|
+
Defined in: [packages/release-npm/src/release.ts:316](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-npm/src/release.ts#L316)
|