@wtf/release-docs 8.2.0 → 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 +4 -3
- 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 +3 -3
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: PublishOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/types.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/types.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L40)
|
|
10
10
|
|
|
11
11
|
How a package is published.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ How a package is published.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **access**: `"public"` \| `"restricted"` \| `undefined`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-npm/src/types.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-npm/src/types.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L44)
|
|
20
20
|
|
|
21
21
|
Its access, as `publishConfig.access` or the option gives it; the registry's otherwise.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ Its access, as `publishConfig.access` or the option gives it; the registry's oth
|
|
|
26
26
|
|
|
27
27
|
> `readonly` **provenance**: `boolean`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-npm/src/types.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-npm/src/types.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L46)
|
|
30
30
|
|
|
31
31
|
Whether it is published with the provenance of the build, by an ID token of the CI.
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ Whether it is published with the provenance of the build, by an ID token of the
|
|
|
36
36
|
|
|
37
37
|
> `readonly` `optional` **registry?**: `string`
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/release-npm/src/types.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
39
|
+
Defined in: [packages/release-npm/src/types.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L48)
|
|
40
40
|
|
|
41
41
|
The registry, where the option names one; the package's or the publisher's otherwise.
|
|
42
42
|
|
|
@@ -46,7 +46,7 @@ The registry, where the option names one; the package's or the publisher's other
|
|
|
46
46
|
|
|
47
47
|
> `readonly` **tag**: `string`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/release-npm/src/types.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
49
|
+
Defined in: [packages/release-npm/src/types.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L42)
|
|
50
50
|
|
|
51
51
|
The dist-tag it is published under, as `latest` or `beta`.
|
|
52
52
|
|
|
@@ -56,6 +56,6 @@ The dist-tag it is published under, as `latest` or `beta`.
|
|
|
56
56
|
|
|
57
57
|
> `readonly` `optional` **tarball?**: `string`
|
|
58
58
|
|
|
59
|
-
Defined in: [packages/release-npm/src/types.ts:50](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
59
|
+
Defined in: [packages/release-npm/src/types.ts:50](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L50)
|
|
60
60
|
|
|
61
61
|
The tarball it was packed into, by [Publisher.pack](Publisher.md#pack), where the publisher packs.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: PublishPackage
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/types.ts:8](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/types.ts:8](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L8)
|
|
10
10
|
|
|
11
11
|
A package as a publisher is given it: prepared at its version, its folder absolute.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ A package as a publisher is given it: prepared at its version, its folder absolu
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **dir**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-npm/src/types.ts:12](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-npm/src/types.ts:12](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L12)
|
|
20
20
|
|
|
21
21
|
The folder of the package, absolute.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ The folder of the package, absolute.
|
|
|
26
26
|
|
|
27
27
|
> `readonly` **manifest**: `Readonly`\<`Record`\<`string`, `unknown`\>\>
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-npm/src/types.ts:14](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-npm/src/types.ts:14](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L14)
|
|
30
30
|
|
|
31
31
|
Its manifest, as it publishes: of its version, its `workspace:` ranges resolved.
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ Its manifest, as it publishes: of its version, its `workspace:` ranges resolved.
|
|
|
36
36
|
|
|
37
37
|
> `readonly` **name**: `string`
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/release-npm/src/types.ts:9](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
39
|
+
Defined in: [packages/release-npm/src/types.ts:9](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L9)
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
@@ -44,4 +44,4 @@ Defined in: [packages/release-npm/src/types.ts:9](https://gitlab.com/wetryfun/re
|
|
|
44
44
|
|
|
45
45
|
> `readonly` **version**: `string`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/release-npm/src/types.ts:10](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
47
|
+
Defined in: [packages/release-npm/src/types.ts:10](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L10)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: PublishTrainOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/types.ts:144](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/types.ts:144](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L144)
|
|
10
10
|
|
|
11
11
|
The options of the publishing of a train, the same for each of its releases.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ The options of the publishing of a train, the same for each of its releases.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` `optional` **access?**: `"public"` \| `"restricted"`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-npm/src/types.ts:148](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-npm/src/types.ts:148](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L148)
|
|
20
20
|
|
|
21
21
|
The access of each package: its `publishConfig.access` by default.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ The access of each package: its `publishConfig.access` by default.
|
|
|
26
26
|
|
|
27
27
|
> `readonly` `optional` **aside?**: readonly `string`[]
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-npm/src/types.ts:172](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-npm/src/types.ts:172](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L172)
|
|
30
30
|
|
|
31
31
|
The packages, by name, each published under the dist-tag of its major's line where its dist-tag
|
|
32
32
|
points above the release, as one that joined the train at a higher version of its own:
|
|
@@ -40,7 +40,7 @@ other package whose dist-tag points above the release fails it, and nothing is p
|
|
|
40
40
|
|
|
41
41
|
> `readonly` `optional` **check?**: `boolean`
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/release-npm/src/types.ts:164](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
43
|
+
Defined in: [packages/release-npm/src/types.ts:164](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L164)
|
|
44
44
|
|
|
45
45
|
Whether the packages are checked before the first publish: `true`.
|
|
46
46
|
|
|
@@ -50,7 +50,7 @@ Whether the packages are checked before the first publish: `true`.
|
|
|
50
50
|
|
|
51
51
|
> `readonly` `optional` **conditions?**: readonly `string`[]
|
|
52
52
|
|
|
53
|
-
Defined in: [packages/release-npm/src/types.ts:162](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
53
|
+
Defined in: [packages/release-npm/src/types.ts:162](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L162)
|
|
54
54
|
|
|
55
55
|
The export conditions of the source, which no tarball ships: `['source']`.
|
|
56
56
|
|
|
@@ -60,7 +60,7 @@ The export conditions of the source, which no tarball ships: `['source']`.
|
|
|
60
60
|
|
|
61
61
|
> `readonly` `optional` **distTag?**: `string`
|
|
62
62
|
|
|
63
|
-
Defined in: [packages/release-npm/src/types.ts:191](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
63
|
+
Defined in: [packages/release-npm/src/types.ts:191](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L191)
|
|
64
64
|
|
|
65
65
|
The dist-tag every package is published under, over the one of the channel of the release, as a
|
|
66
66
|
one-off: an empty one is none. The channel's by default.
|
|
@@ -71,7 +71,7 @@ one-off: an empty one is none. The channel's by default.
|
|
|
71
71
|
|
|
72
72
|
> `readonly` `optional` **first?**: `string`
|
|
73
73
|
|
|
74
|
-
Defined in: [packages/release-npm/src/types.ts:158](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
74
|
+
Defined in: [packages/release-npm/src/types.ts:158](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L158)
|
|
75
75
|
|
|
76
76
|
The folder of the package published first, as a base: none by default.
|
|
77
77
|
|
|
@@ -81,7 +81,7 @@ The folder of the package published first, as a base: none by default.
|
|
|
81
81
|
|
|
82
82
|
> `readonly` `optional` **last?**: `string`
|
|
83
83
|
|
|
84
|
-
Defined in: [packages/release-npm/src/types.ts:160](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
84
|
+
Defined in: [packages/release-npm/src/types.ts:160](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L160)
|
|
85
85
|
|
|
86
86
|
The folder of the package published last, as a docs package: none by default.
|
|
87
87
|
|
|
@@ -91,7 +91,7 @@ The folder of the package published last, as a docs package: none by default.
|
|
|
91
91
|
|
|
92
92
|
> `readonly` `optional` **pack?**: readonly `string`[]
|
|
93
93
|
|
|
94
|
-
Defined in: [packages/release-npm/src/types.ts:186](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
94
|
+
Defined in: [packages/release-npm/src/types.ts:186](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L186)
|
|
95
95
|
|
|
96
96
|
The private packages of the train, each by its folder, from the root of the repo, or a glob of
|
|
97
97
|
folders, packed beside those that publish, into the folder of the tarballs, and never published:
|
|
@@ -105,7 +105,7 @@ resolved to it too. None by default.
|
|
|
105
105
|
|
|
106
106
|
> `readonly` `optional` **provenance?**: `boolean` \| `"auto"`
|
|
107
107
|
|
|
108
|
-
Defined in: [packages/release-npm/src/types.ts:154](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
108
|
+
Defined in: [packages/release-npm/src/types.ts:154](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L154)
|
|
109
109
|
|
|
110
110
|
Whether each package is published with the provenance of the build: `auto`, the default, where
|
|
111
111
|
the CI gives an ID token that npm signs it by (`SIGSTORE_ID_TOKEN` on GitLab, GitHub's OIDC),
|
|
@@ -117,7 +117,7 @@ on a runner it hosts: npm refuses provenance of a self-hosted runner.
|
|
|
117
117
|
|
|
118
118
|
> `readonly` `optional` **publisher?**: [`Publisher`](Publisher.md)
|
|
119
119
|
|
|
120
|
-
Defined in: [packages/release-npm/src/types.ts:146](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
120
|
+
Defined in: [packages/release-npm/src/types.ts:146](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L146)
|
|
121
121
|
|
|
122
122
|
The publisher: `npmPublisher` of `./publishers` by default.
|
|
123
123
|
|
|
@@ -127,7 +127,7 @@ The publisher: `npmPublisher` of `./publishers` by default.
|
|
|
127
127
|
|
|
128
128
|
> `readonly` `optional` **registry?**: `string`
|
|
129
129
|
|
|
130
|
-
Defined in: [packages/release-npm/src/types.ts:156](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
130
|
+
Defined in: [packages/release-npm/src/types.ts:156](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L156)
|
|
131
131
|
|
|
132
132
|
The registry: each package's `publishConfig.registry`, or the publisher's, by default.
|
|
133
133
|
|
|
@@ -137,7 +137,7 @@ The registry: each package's `publishConfig.registry`, or the publisher's, by de
|
|
|
137
137
|
|
|
138
138
|
> `readonly` `optional` **tarballDir?**: `string`
|
|
139
139
|
|
|
140
|
-
Defined in: [packages/release-npm/src/types.ts:178](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
140
|
+
Defined in: [packages/release-npm/src/types.ts:178](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L178)
|
|
141
141
|
|
|
142
142
|
The folder the tarballs are packed into, from the root of the repo or absolute, where they stay
|
|
143
143
|
after the release, as assets of the release of the host: one of the system's temporary files by
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Publisher
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/types.ts:70](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/types.ts:70](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L70)
|
|
10
10
|
|
|
11
11
|
What publishes a package: the release asks it whether a version is published, and publishes each
|
|
12
12
|
that is not, in order. A publisher that packs ([Publisher.pack](#pack)) has every package packed
|
|
@@ -19,7 +19,7 @@ the registry.
|
|
|
19
19
|
|
|
20
20
|
> `readonly` **name**: `string`
|
|
21
21
|
|
|
22
|
-
Defined in: [packages/release-npm/src/types.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
22
|
+
Defined in: [packages/release-npm/src/types.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L72)
|
|
23
23
|
|
|
24
24
|
Its name, as the log says it: `npm`.
|
|
25
25
|
|
|
@@ -29,7 +29,7 @@ Its name, as the log says it: `npm`.
|
|
|
29
29
|
|
|
30
30
|
> **lookup**(`pkg`, `version`, `tag`, `context`, `registry?`): `Promise`\<[`Lookup`](Lookup.md)\>
|
|
31
31
|
|
|
32
|
-
Defined in: [packages/release-npm/src/types.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
32
|
+
Defined in: [packages/release-npm/src/types.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L88)
|
|
33
33
|
|
|
34
34
|
What the registry has of `pkg`, in one question: whether it has it at `version`, and the
|
|
35
35
|
version its dist-tag `tag` points at, where the publisher reads dist-tags; of the registry the
|
|
@@ -82,7 +82,7 @@ Whether the registry has the version, and the version the dist-tag points at.
|
|
|
82
82
|
|
|
83
83
|
> `optional` **pack**(`pkg`, `destination`, `context`): `Promise`\<`string`\>
|
|
84
84
|
|
|
85
|
-
Defined in: [packages/release-npm/src/types.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
85
|
+
Defined in: [packages/release-npm/src/types.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L113)
|
|
86
86
|
|
|
87
87
|
Packs `pkg` into the folder `destination`, and gives the tarball's path.
|
|
88
88
|
|
|
@@ -118,7 +118,7 @@ The path of the tarball.
|
|
|
118
118
|
|
|
119
119
|
> `optional` **page**(`pkg`, `version`, `registry?`): `string` \| `undefined`
|
|
120
120
|
|
|
121
|
-
Defined in: [packages/release-npm/src/types.ts:140](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
121
|
+
Defined in: [packages/release-npm/src/types.ts:140](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L140)
|
|
122
122
|
|
|
123
123
|
The page of `pkg` at `version` on the registry, which the plugin gives as the release's URL.
|
|
124
124
|
|
|
@@ -154,7 +154,7 @@ The URL of the page, or `undefined` of a registry of no page.
|
|
|
154
154
|
|
|
155
155
|
> **publish**(`pkg`, `options`, `context`): `Promise`\<`void`\>
|
|
156
156
|
|
|
157
|
-
Defined in: [packages/release-npm/src/types.ts:104](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
157
|
+
Defined in: [packages/release-npm/src/types.ts:104](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L104)
|
|
158
158
|
|
|
159
159
|
Publishes `pkg`, or, of a dry run, says what it would publish. A version the registry has
|
|
160
160
|
already, as of another run that published it after this one's [Publisher.lookup](#lookup), is
|
|
@@ -190,7 +190,7 @@ The system, the folder, the environment and the log the publisher runs in.
|
|
|
190
190
|
|
|
191
191
|
> `optional` **tag**(`pkg`, `version`, `tag`, `context`, `registry?`): `Promise`\<`void`\>
|
|
192
192
|
|
|
193
|
-
Defined in: [packages/release-npm/src/types.ts:125](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
193
|
+
Defined in: [packages/release-npm/src/types.ts:125](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L125)
|
|
194
194
|
|
|
195
195
|
Points the dist-tag `tag` of `pkg` at `version`, which the registry has already, as a release
|
|
196
196
|
moves to another channel; or, of a dry run, says what it would. A publisher without it moves no
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: PublisherContext
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/types.ts:18](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/types.ts:18](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L18)
|
|
10
10
|
|
|
11
11
|
What a publisher runs in: the system, the folder of the repo, its environment, and a log.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ What a publisher runs in: the system, the folder of the repo, its environment, a
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **cwd**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-npm/src/types.ts:20](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-npm/src/types.ts:20](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L20)
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
@@ -24,7 +24,7 @@ Defined in: [packages/release-npm/src/types.ts:20](https://gitlab.com/wetryfun/r
|
|
|
24
24
|
|
|
25
25
|
> `readonly` **dryRun**: `boolean`
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/release-npm/src/types.ts:23](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
27
|
+
Defined in: [packages/release-npm/src/types.ts:23](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L23)
|
|
28
28
|
|
|
29
29
|
Whether the run publishes nothing for real, and only says what it would.
|
|
30
30
|
|
|
@@ -34,7 +34,7 @@ Whether the run publishes nothing for real, and only says what it would.
|
|
|
34
34
|
|
|
35
35
|
> `readonly` **env**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/release-npm/src/types.ts:21](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
37
|
+
Defined in: [packages/release-npm/src/types.ts:21](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L21)
|
|
38
38
|
|
|
39
39
|
***
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ Defined in: [packages/release-npm/src/types.ts:21](https://gitlab.com/wetryfun/r
|
|
|
42
42
|
|
|
43
43
|
> `readonly` **log**: (`line`) => `void`
|
|
44
44
|
|
|
45
|
-
Defined in: [packages/release-npm/src/types.ts:29](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
45
|
+
Defined in: [packages/release-npm/src/types.ts:29](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L29)
|
|
46
46
|
|
|
47
47
|
The log of the run, a line at a time.
|
|
48
48
|
|
|
@@ -64,7 +64,7 @@ The line to log, of no newline.
|
|
|
64
64
|
|
|
65
65
|
> `readonly` `optional` **memo?**: `Map`\<`string`, `unknown`\>
|
|
66
66
|
|
|
67
|
-
Defined in: [packages/release-npm/src/types.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
67
|
+
Defined in: [packages/release-npm/src/types.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L36)
|
|
68
68
|
|
|
69
69
|
A store of what a publisher has asked the registry, for one step of a release, as the npm
|
|
70
70
|
publisher keeps each package's versions and dist-tags of one question: a step that asks of a
|
|
@@ -77,4 +77,4 @@ none by default, as of a publisher that keeps nothing.
|
|
|
77
77
|
|
|
78
78
|
> `readonly` **system**: [`System`](../../release-system/system/interfaces/System.md)
|
|
79
79
|
|
|
80
|
-
Defined in: [packages/release-npm/src/types.ts:19](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
80
|
+
Defined in: [packages/release-npm/src/types.ts:19](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/types.ts#L19)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **concreteRange**(`spec`): `string` \| `undefined`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:155](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:155](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L155)
|
|
12
12
|
|
|
13
13
|
The semver range a package requires of another, or `undefined` when it names no version, as
|
|
14
14
|
`workspace:*`, `*`, a tag or a path: `workspace:^1.2.0` requires `^1.2.0`.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **manifestsAt**(`ref`, `context`): `Promise`\<[`Manifest`](../interfaces/Manifest.md)[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:105](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:105](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L105)
|
|
12
12
|
|
|
13
13
|
Each package.json of the repo at `ref`, read by git: each but those in a `node_modules`.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **packageOf**(`manifest`, `workspace`): [`NpmPackage`](../interfaces/NpmPackage.md) \| `undefined`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:192](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:192](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L192)
|
|
12
12
|
|
|
13
13
|
The package of the trains of `manifest`, `undefined` of one of no name: published unless it is
|
|
14
14
|
private, its manifest its package.json, and each dependency on a package of `workspace` of the
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **packagesOfManifests**(`manifests`): [`NpmPackage`](../interfaces/NpmPackage.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:219](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:219](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L219)
|
|
12
12
|
|
|
13
13
|
The packages of the trains of `manifests`, each of a name, of its dependencies on the others
|
|
14
14
|
([packageOf](packageOf.md)).
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **readManifests**(`files`, `context`): `Promise`\<[`Manifest`](../interfaces/Manifest.md)[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L85)
|
|
12
12
|
|
|
13
13
|
Each package.json of `files`, the files of a repo, read from its folder by its system: each but
|
|
14
14
|
those in a `node_modules`.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **resolveSpecifier**(`specifier`, `version`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:140](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:140](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L140)
|
|
12
12
|
|
|
13
13
|
The range a release publishes of `specifier`, a range of a package.json, of `version`, the
|
|
14
14
|
release of the package it names, by pnpm's rules for the workspace protocol: `workspace:*` and
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **runtimeDependenciesOf**(`json`): `string`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:124](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:124](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L124)
|
|
12
12
|
|
|
13
13
|
The names of the packages `json` needs published before it: what it runs with.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **satisfiesRange**(`range`, `version`): `boolean`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:170](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:170](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L170)
|
|
12
12
|
|
|
13
13
|
Whether `version` is within `range`, by semver, a prerelease within its bounds too, as
|
|
14
14
|
`7.1.0-beta.1` of `^7.0.0`: of a range that names no version, as `*`, a tag or a path, any.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: Manifest
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/manifests.ts:55](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/manifests.ts:55](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L55)
|
|
10
10
|
|
|
11
11
|
A package.json of the repo: where it is, and what it holds.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ A package.json of the repo: where it is, and what it holds.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **dir**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-npm/src/manifests.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-npm/src/manifests.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L59)
|
|
20
20
|
|
|
21
21
|
Its folder, from the root of the repo, as `packages/core`; `.` for the root.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ Its folder, from the root of the repo, as `packages/core`; `.` for the root.
|
|
|
26
26
|
|
|
27
27
|
> `readonly` **file**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-npm/src/manifests.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-npm/src/manifests.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L57)
|
|
30
30
|
|
|
31
31
|
The file, from the root of the repo, as `packages/core/package.json`.
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ The file, from the root of the repo, as `packages/core/package.json`.
|
|
|
36
36
|
|
|
37
37
|
> `readonly` **json**: `Readonly`\<`Record`\<`string`, `unknown`\>\>
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/release-npm/src/manifests.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
39
|
+
Defined in: [packages/release-npm/src/manifests.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L63)
|
|
40
40
|
|
|
41
41
|
What it holds.
|
|
42
42
|
|
|
@@ -46,6 +46,6 @@ What it holds.
|
|
|
46
46
|
|
|
47
47
|
> `readonly` **name**: `string` \| `undefined`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/release-npm/src/manifests.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
49
|
+
Defined in: [packages/release-npm/src/manifests.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L61)
|
|
50
50
|
|
|
51
51
|
Its name, when it has one.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: NpmPackage
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/manifests.ts:176](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/manifests.ts:176](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L176)
|
|
10
10
|
|
|
11
11
|
A package of the trains of a package.json, of what the package.json holds.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ A package of the trains of a package.json, of what the package.json holds.
|
|
|
20
20
|
|
|
21
21
|
> `readonly` **dependencies**: readonly [`Dependency`](../../../release-trains/ecosystem/interfaces/Dependency.md)[]
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
23
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L76)
|
|
24
24
|
|
|
25
25
|
Its dependencies on the other packages of its ecosystem in the repo.
|
|
26
26
|
|
|
@@ -34,7 +34,7 @@ Its dependencies on the other packages of its ecosystem in the repo.
|
|
|
34
34
|
|
|
35
35
|
> `readonly` **dir**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
37
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L67)
|
|
38
38
|
|
|
39
39
|
Its folder, from the root of the repo, as `packages/core`; `.` of the root. A train holds it
|
|
40
40
|
when the train's `paths` hold this folder.
|
|
@@ -49,7 +49,7 @@ when the train's `paths` hold this folder.
|
|
|
49
49
|
|
|
50
50
|
> `readonly` **json**: `Readonly`\<`Record`\<`string`, `unknown`\>\>
|
|
51
51
|
|
|
52
|
-
Defined in: [packages/release-npm/src/manifests.ts:178](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
52
|
+
Defined in: [packages/release-npm/src/manifests.ts:178](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L178)
|
|
53
53
|
|
|
54
54
|
What its package.json holds.
|
|
55
55
|
|
|
@@ -59,7 +59,7 @@ What its package.json holds.
|
|
|
59
59
|
|
|
60
60
|
> `readonly` **manifest**: `string`
|
|
61
61
|
|
|
62
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
62
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L69)
|
|
63
63
|
|
|
64
64
|
Its manifest, from the root of the repo, as `packages/core/package.json`.
|
|
65
65
|
|
|
@@ -73,7 +73,7 @@ Its manifest, from the root of the repo, as `packages/core/package.json`.
|
|
|
73
73
|
|
|
74
74
|
> `readonly` **name**: `string`
|
|
75
75
|
|
|
76
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
76
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L62)
|
|
77
77
|
|
|
78
78
|
Its name, the one its ecosystem's registry knows it by: unique of the ecosystem in the repo.
|
|
79
79
|
|
|
@@ -87,7 +87,7 @@ Its name, the one its ecosystem's registry knows it by: unique of the ecosystem
|
|
|
87
87
|
|
|
88
88
|
> `readonly` **published**: `boolean`
|
|
89
89
|
|
|
90
|
-
Defined in: [packages/release-trains/src/ecosystem.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
90
|
+
Defined in: [packages/release-trains/src/ecosystem.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L74)
|
|
91
91
|
|
|
92
92
|
Whether a release publishes it: not of an npm package that is private, nor of a crate of
|
|
93
93
|
`publish = false`.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **DependencyField** = *typeof* [`DEPENDENCY_FIELDS`](../variables/DEPENDENCY_FIELDS.md)\[`number`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L40)
|
|
12
12
|
|
|
13
13
|
A field of [DEPENDENCY\_FIELDS](../variables/DEPENDENCY_FIELDS.md).
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **DEPENDENCY\_FIELDS**: readonly \[`"dependencies"`, `"devDependencies"`, `"peerDependencies"`, `"optionalDependencies"`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:32](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:32](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L32)
|
|
12
12
|
|
|
13
13
|
The fields of a package.json that list the packages it depends on.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **FIELD\_KINDS**: `Readonly`\<`Record`\<[`DependencyField`](../type-aliases/DependencyField.md), [`DependencyKind`](../../../release-trains/ecosystem/type-aliases/DependencyKind.md)\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L47)
|
|
12
12
|
|
|
13
13
|
The kind of a dependency of each field, as the trains read it: what a package runs with of
|
|
14
14
|
`dependencies` and `optionalDependencies`, its users' of `peerDependencies`, and its own tests'
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **RUNTIME\_FIELDS**: readonly \[`"dependencies"`, `"peerDependencies"`, `"optionalDependencies"`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/manifests.ts:115](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/manifests.ts:115](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/manifests.ts#L115)
|
|
12
12
|
|
|
13
13
|
The fields of a package.json whose packages must be published before it: what it runs with.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **isTypeScriptSource**(`target`): `boolean`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/prepare.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/prepare.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/prepare.ts#L24)
|
|
12
12
|
|
|
13
13
|
Whether an export target is TypeScript source, `.ts`, `.tsx`, `.mts` or `.cts`, and no
|
|
14
14
|
declaration file: what the workspace's own tooling runs, and no tarball ships.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **prepareManifest**(`manifest`, `options`): [`PreparedManifest`](../interfaces/PreparedManifest.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/prepare.ts:119](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/prepare.ts:119](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/prepare.ts#L119)
|
|
12
12
|
|
|
13
13
|
A manifest as it publishes: of the version of the release, each `workspace:` range of its
|
|
14
14
|
dependencies resolved to the version of the package it names, and its exports with no export of
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **stripSourceConditions**(`value`, `conditions?`): `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/prepare.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/prepare.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/prepare.ts#L46)
|
|
12
12
|
|
|
13
13
|
An `exports` value with no condition of `conditions` and no target of TypeScript source, and how
|
|
14
14
|
many it had: Node and every bundler resolve `exports` by the first condition that matches, with
|