@wtf/release-docs 8.2.1 → 8.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -44
- package/api/@wtf/release-cargo/auth/functions/mask.md +1 -1
- package/api/@wtf/release-cargo/auth/functions/tokenVariableOf.md +1 -1
- package/api/@wtf/release-cargo/auth/functions/trustedPublishing.md +1 -1
- package/api/@wtf/release-cargo/auth/interfaces/HttpResponse.md +5 -5
- package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishing.md +5 -5
- package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishingOptions.md +6 -6
- package/api/@wtf/release-cargo/auth/type-aliases/HttpFetch.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/CRATES_IO_API.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/ID_TOKEN_VARIABLE.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/USER_AGENT.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/publishOrder.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/publishable.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/readWorkspace.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/selectCrates.md +1 -1
- package/api/@wtf/release-cargo/crates/interfaces/Selection.md +5 -5
- package/api/@wtf/release-cargo/ecosystem/functions/packagesAt.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/packagesOfTree.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/packagesOfWorkspace.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/resolveRequirement.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/satisfiesRequirement.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/semverRange.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/interfaces/CargoPackage.md +7 -7
- package/api/@wtf/release-cargo/ecosystem/variables/cargoEcosystem.md +1 -1
- package/api/@wtf/release-cargo/errors/classes/CargoError.md +5 -5
- package/api/@wtf/release-cargo/errors/type-aliases/CargoErrorCode.md +1 -1
- package/api/@wtf/release-cargo/errors/variables/CARGO_ERRORS.md +1 -1
- package/api/@wtf/release-cargo/interfaces/Crate.md +6 -6
- package/api/@wtf/release-cargo/interfaces/CrateDependency.md +6 -6
- package/api/@wtf/release-cargo/interfaces/Workspace.md +3 -3
- package/api/@wtf/release-cargo/publish/functions/publishCrates.md +1 -1
- package/api/@wtf/release-cargo/publish/interfaces/PublishCratesOptions.md +11 -11
- package/api/@wtf/release-cargo/publish/interfaces/PublishedCrate.md +5 -5
- package/api/@wtf/release-cargo/publish/type-aliases/CrateStatus.md +1 -1
- package/api/@wtf/release-cargo/publish/variables/RECHECK_WAITS.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/crateUrl.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/indexHasVersion.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/indexPath.md +1 -1
- package/api/@wtf/release-cargo/registry/variables/CRATES_IO_INDEX.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/inheritsVersion.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/stampManifest.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/stampWorkspace.md +1 -1
- package/api/@wtf/release-cargo/stamp/interfaces/StampOptions.md +4 -4
- package/api/@wtf/release-cargo/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-cargo/stamp/interfaces/StampedWorkspace.md +3 -3
- package/api/@wtf/release-cargo/type-aliases/DependencyKind.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/packagesOfModules.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/packagesOfRepo.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/resolveVersion.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/satisfiesVersion.md +1 -1
- package/api/@wtf/release-go/ecosystem/interfaces/GoPackage.md +7 -7
- package/api/@wtf/release-go/ecosystem/variables/goEcosystem.md +1 -1
- package/api/@wtf/release-go/errors/classes/GoError.md +5 -5
- package/api/@wtf/release-go/errors/type-aliases/GoErrorCode.md +1 -1
- package/api/@wtf/release-go/errors/variables/GO_ERRORS.md +1 -1
- package/api/@wtf/release-go/gomod/functions/entriesOf.md +1 -1
- package/api/@wtf/release-go/gomod/functions/linesOf.md +1 -1
- package/api/@wtf/release-go/gomod/functions/readGoMod.md +1 -1
- package/api/@wtf/release-go/gomod/functions/tokensOf.md +1 -1
- package/api/@wtf/release-go/gomod/interfaces/Entry.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/GoMod.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/GoReplace.md +6 -6
- package/api/@wtf/release-go/gomod/interfaces/GoRequire.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/Token.md +5 -5
- package/api/@wtf/release-go/interfaces/GoModule.md +6 -6
- package/api/@wtf/release-go/modules/functions/isFetchable.md +1 -1
- package/api/@wtf/release-go/modules/functions/isGoMod.md +1 -1
- package/api/@wtf/release-go/modules/functions/majorErrors.md +1 -1
- package/api/@wtf/release-go/modules/functions/majorOfPath.md +1 -1
- package/api/@wtf/release-go/modules/functions/modulesAt.md +1 -1
- package/api/@wtf/release-go/modules/functions/modulesOf.md +1 -1
- package/api/@wtf/release-go/modules/functions/readModules.md +1 -1
- package/api/@wtf/release-go/modules/functions/selectModules.md +1 -1
- package/api/@wtf/release-go/modules/interfaces/Selection.md +4 -4
- package/api/@wtf/release-go/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-go/stamp/functions/stampGoMod.md +1 -1
- package/api/@wtf/release-go/stamp/functions/stampModules.md +1 -1
- package/api/@wtf/release-go/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-go/stamp/interfaces/StampedModules.md +3 -3
- package/api/@wtf/release-go/tags/functions/askProxy.md +1 -1
- package/api/@wtf/release-go/tags/functions/maskCredentials.md +1 -1
- package/api/@wtf/release-go/tags/functions/releaseCommit.md +1 -1
- package/api/@wtf/release-go/tags/functions/remoteTags.md +1 -1
- package/api/@wtf/release-go/tags/functions/tagModules.md +1 -1
- package/api/@wtf/release-go/tags/functions/tagOfModule.md +1 -1
- package/api/@wtf/release-go/tags/functions/tagPrefix.md +1 -1
- package/api/@wtf/release-go/tags/interfaces/TagModulesOptions.md +8 -8
- package/api/@wtf/release-go/tags/interfaces/TaggedModule.md +5 -5
- package/api/@wtf/release-go/tags/type-aliases/ModuleStatus.md +1 -1
- package/api/@wtf/release-go/tags/variables/RELEASE_AUTHOR.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/groupIdOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/installsOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/isPomFile.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/isRange.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/modulesOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/nameOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/publishOrder.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/readModules.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/readPoms.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/selectArtifacts.md +1 -1
- package/api/@wtf/release-maven/artifacts/interfaces/Selection.md +4 -4
- package/api/@wtf/release-maven/ecosystem/functions/compareVersions.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/parseRange.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/resolveVersion.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/satisfiesVersion.md +1 -1
- package/api/@wtf/release-maven/ecosystem/interfaces/Bound.md +3 -3
- package/api/@wtf/release-maven/ecosystem/interfaces/Restriction.md +3 -3
- package/api/@wtf/release-maven/ecosystem/variables/mavenEcosystem.md +1 -1
- package/api/@wtf/release-maven/errors/classes/MavenError.md +5 -5
- package/api/@wtf/release-maven/errors/type-aliases/MavenErrorCode.md +1 -1
- package/api/@wtf/release-maven/errors/variables/MAVEN_ERRORS.md +1 -1
- package/api/@wtf/release-maven/interfaces/MavenModule.md +14 -14
- package/api/@wtf/release-maven/pom/functions/childOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/childrenOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/dependencyOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/escapeXml.md +1 -1
- package/api/@wtf/release-maven/pom/functions/parseXml.md +1 -1
- package/api/@wtf/release-maven/pom/functions/readPom.md +1 -1
- package/api/@wtf/release-maven/pom/functions/textAt.md +1 -1
- package/api/@wtf/release-maven/pom/interfaces/Pom.md +15 -15
- package/api/@wtf/release-maven/pom/interfaces/PomDependency.md +5 -5
- package/api/@wtf/release-maven/pom/interfaces/PomParent.md +4 -4
- package/api/@wtf/release-maven/pom/interfaces/PomPlugin.md +5 -5
- package/api/@wtf/release-maven/pom/interfaces/PomRepository.md +3 -3
- package/api/@wtf/release-maven/pom/interfaces/Span.md +3 -3
- package/api/@wtf/release-maven/pom/interfaces/XmlElement.md +7 -7
- package/api/@wtf/release-maven/pom/variables/PLUGIN_GROUP.md +1 -1
- package/api/@wtf/release-maven/publish/functions/deployModules.md +1 -1
- package/api/@wtf/release-maven/publish/interfaces/DeployModulesOptions.md +11 -11
- package/api/@wtf/release-maven/publish/interfaces/DeployedModule.md +4 -4
- package/api/@wtf/release-maven/publish/type-aliases/ModuleStatus.md +1 -1
- package/api/@wtf/release-maven/repository/functions/deployTargets.md +1 -1
- package/api/@wtf/release-maven/repository/functions/expandValues.md +1 -1
- package/api/@wtf/release-maven/repository/functions/hasPom.md +1 -1
- package/api/@wtf/release-maven/repository/functions/pomPath.md +1 -1
- package/api/@wtf/release-maven/repository/functions/pomUrl.md +1 -1
- package/api/@wtf/release-maven/repository/interfaces/Repository.md +3 -3
- package/api/@wtf/release-maven/repository/interfaces/ValuesOf.md +3 -3
- package/api/@wtf/release-maven/repository/variables/MAVEN_CENTRAL.md +1 -1
- package/api/@wtf/release-maven/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-maven/stamp/functions/stampModules.md +1 -1
- package/api/@wtf/release-maven/stamp/functions/stampPom.md +1 -1
- package/api/@wtf/release-maven/stamp/interfaces/PomStampOptions.md +5 -5
- package/api/@wtf/release-maven/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-maven/stamp/interfaces/StampedModules.md +3 -3
- package/api/@wtf/release-npm/check/functions/checkPackages.md +1 -1
- package/api/@wtf/release-npm/check/functions/formatIssue.md +1 -1
- package/api/@wtf/release-npm/check/interfaces/CheckOptions.md +6 -6
- package/api/@wtf/release-npm/check/interfaces/Issue.md +5 -5
- package/api/@wtf/release-npm/check/type-aliases/CheckedPackage.md +1 -1
- package/api/@wtf/release-npm/check/type-aliases/IssueCode.md +1 -1
- package/api/@wtf/release-npm/ecosystem/variables/npmEcosystem.md +1 -1
- package/api/@wtf/release-npm/errors/type-aliases/NpmErrorCode.md +1 -1
- package/api/@wtf/release-npm/errors/variables/NPM_ERRORS.md +1 -1
- package/api/@wtf/release-npm/interfaces/Lookup.md +3 -3
- package/api/@wtf/release-npm/interfaces/PublishOptions.md +6 -6
- package/api/@wtf/release-npm/interfaces/PublishPackage.md +5 -5
- package/api/@wtf/release-npm/interfaces/PublishTrainOptions.md +13 -13
- package/api/@wtf/release-npm/interfaces/Publisher.md +7 -7
- package/api/@wtf/release-npm/interfaces/PublisherContext.md +7 -7
- package/api/@wtf/release-npm/manifests/functions/concreteRange.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/manifestsAt.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/packageOf.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/packagesOfManifests.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/readManifests.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/resolveSpecifier.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/runtimeDependenciesOf.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/satisfiesRange.md +1 -1
- package/api/@wtf/release-npm/manifests/interfaces/Manifest.md +5 -5
- package/api/@wtf/release-npm/manifests/interfaces/NpmPackage.md +7 -7
- package/api/@wtf/release-npm/manifests/type-aliases/DependencyField.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/DEPENDENCY_FIELDS.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/FIELD_KINDS.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/RUNTIME_FIELDS.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/isTypeScriptSource.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/prepareManifest.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/stripSourceConditions.md +1 -1
- package/api/@wtf/release-npm/prepare/interfaces/PrepareOptions.md +5 -5
- package/api/@wtf/release-npm/prepare/interfaces/PreparedManifest.md +6 -6
- package/api/@wtf/release-npm/prepare/variables/SOURCE_CONDITIONS.md +1 -1
- package/api/@wtf/release-npm/publishers/functions/builtInPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/functions/isPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/NPM_REGISTRY.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/PUBLISHERS.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/npmPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/pnpmPublisher.md +1 -1
- package/api/@wtf/release-npm/release/functions/checkTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/distTagOf.md +1 -1
- package/api/@wtf/release-npm/release/functions/packTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishPacked.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishedOf.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishedOfResolved.md +1 -1
- package/api/@wtf/release-npm/release/functions/releaseTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/resolveManifests.md +1 -1
- package/api/@wtf/release-npm/release/functions/tagTrain.md +1 -1
- package/api/@wtf/release-npm/release/interfaces/CheckRelease.md +16 -16
- package/api/@wtf/release-npm/release/interfaces/PackOptions.md +8 -8
- package/api/@wtf/release-npm/release/interfaces/PackedTrain.md +12 -12
- package/api/@wtf/release-npm/release/interfaces/PublishRun.md +11 -11
- package/api/@wtf/release-npm/release/interfaces/PublishedOf.md +4 -4
- package/api/@wtf/release-npm/release/interfaces/PublishedPackage.md +7 -7
- package/api/@wtf/release-npm/release/interfaces/PublishedTrain.md +5 -5
- package/api/@wtf/release-npm/release/interfaces/ResolveRelease.md +17 -17
- package/api/@wtf/release-npm/release/interfaces/ResolvedPackage.md +4 -4
- package/api/@wtf/release-npm/release/interfaces/ResolvedTrain.md +6 -6
- package/api/@wtf/release-npm/release/interfaces/TagRelease.md +14 -14
- package/api/@wtf/release-npm/release/type-aliases/LookedUpTrain.md +1 -1
- package/api/@wtf/release-npm/release/type-aliases/ReleaseRun.md +1 -1
- package/api/@wtf/release-npm/release/variables/ID_TOKENS.md +1 -1
- package/api/@wtf/release-npm/release/variables/RUNNER_ENVIRONMENTS.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/pnpmWorkspaceGlobs.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/publishableOf.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/readWorkspace.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/workspaceFolders.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/workspaceGlobs.md +1 -1
- package/api/@wtf/release-npm/workspace/interfaces/WorkspaceGlobs.md +3 -3
- package/api/@wtf/release-npm/workspace/interfaces/WorkspaceOptions.md +2 -2
- package/api/@wtf/release-replace/errors/classes/ReplaceError.md +5 -5
- package/api/@wtf/release-replace/errors/type-aliases/ReplaceErrorCode.md +1 -1
- package/api/@wtf/release-replace/errors/variables/REPLACE_ERRORS.md +1 -1
- package/api/@wtf/release-replace/files/functions/filesMatcher.md +1 -1
- package/api/@wtf/release-replace/interfaces/ReplaceMatch.md +5 -5
- package/api/@wtf/release-replace/interfaces/ReplacementOf.md +5 -5
- package/api/@wtf/release-replace/replace/functions/regExpOf.md +1 -1
- package/api/@wtf/release-replace/replace/functions/replaceFiles.md +1 -1
- package/api/@wtf/release-replace/replace/functions/replaceText.md +1 -1
- package/api/@wtf/release-replace/replace/interfaces/ReplaceOptions.md +10 -10
- package/api/@wtf/release-replace/replace/interfaces/TextOptions.md +5 -5
- package/api/@wtf/release-replace/replace/type-aliases/To.md +1 -1
- package/api/@wtf/release-replace/templates/functions/mergeTemplates.md +1 -1
- package/api/@wtf/release-replace/templates/functions/resolveReplacement.md +1 -1
- package/api/@wtf/release-replace/templates/functions/resolveReplacements.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Escape.md +1 -1
- package/api/@wtf/release-replace/type-aliases/ReplaceFunction.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Replacement.md +1 -1
- package/api/@wtf/release-replace/type-aliases/ReplacementSpec.md +1 -1
- package/api/@wtf/release-replace/type-aliases/TemplateUse.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Templates.md +1 -1
- package/api/@wtf/release-replace/values/functions/escapeValue.md +1 -1
- package/api/@wtf/release-replace/values/functions/textOf.md +1 -1
- package/api/@wtf/release-replace/values/functions/valueAt.md +1 -1
- package/api/@wtf/release-replace/values/variables/ESCAPES.md +1 -1
- package/api/@wtf/release-replace/values/variables/VALUE.md +1 -1
- package/api/@wtf/release-system/errors/classes/ReleaseError.md +5 -5
- package/api/@wtf/release-system/errors/functions/throwAll.md +1 -1
- package/api/@wtf/release-system/errors/type-aliases/ErrorClass.md +1 -1
- package/api/@wtf/release-system/errors/type-aliases/SystemErrorCode.md +1 -1
- package/api/@wtf/release-system/errors/variables/SYSTEM_ERRORS.md +1 -1
- package/api/@wtf/release-system/git/functions/commitsSince.md +1 -1
- package/api/@wtf/release-system/git/functions/filesOfCommits.md +1 -1
- package/api/@wtf/release-system/git/functions/git.md +1 -1
- package/api/@wtf/release-system/git/functions/gitOf.md +1 -1
- package/api/@wtf/release-system/git/functions/trackedFiles.md +1 -1
- package/api/@wtf/release-system/git/interfaces/GitContext.md +4 -4
- package/api/@wtf/release-system/git/interfaces/LogCommit.md +5 -5
- package/api/@wtf/release-system/node/functions/nodeSystem.md +1 -1
- package/api/@wtf/release-system/node/functions/realPathOf.md +1 -1
- package/api/@wtf/release-system/node/functions/systemOf.md +1 -1
- package/api/@wtf/release-system/paths/functions/normalizePath.md +1 -1
- package/api/@wtf/release-system/paths/functions/pathMatcher.md +1 -1
- package/api/@wtf/release-system/paths/type-aliases/PathMatcher.md +1 -1
- package/api/@wtf/release-system/posix/functions/basenameOf.md +1 -1
- package/api/@wtf/release-system/posix/functions/dirnameOf.md +1 -1
- package/api/@wtf/release-system/posix/functions/joinPath.md +1 -1
- package/api/@wtf/release-system/posix/functions/relativePath.md +1 -1
- package/api/@wtf/release-system/posix/functions/resolvePath.md +1 -1
- package/api/@wtf/release-system/system/interfaces/DirEntry.md +3 -3
- package/api/@wtf/release-system/system/interfaces/ExecOptions.md +4 -4
- package/api/@wtf/release-system/system/interfaces/ExecResult.md +4 -4
- package/api/@wtf/release-system/system/interfaces/System.md +7 -7
- package/api/@wtf/release-system/system/interfaces/SystemFs.md +8 -8
- package/api/@wtf/release-system/system/type-aliases/Exec.md +1 -1
- package/api/@wtf/release-system/system/type-aliases/SystemInput.md +1 -1
- package/api/@wtf/release-system/validator/functions/allOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/anyObject.md +1 -1
- package/api/@wtf/release-system/validator/functions/anyOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/arrayOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/booleanOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/errorOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/errorsOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/exclusive.md +1 -1
- package/api/@wtf/release-system/validator/functions/issuesOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/objectOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/oneOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/orFunction.md +1 -1
- package/api/@wtf/release-system/validator/functions/pathText.md +1 -1
- package/api/@wtf/release-system/validator/functions/pluginEntriesOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/recordOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/refined.md +1 -1
- package/api/@wtf/release-system/validator/functions/stringOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/tupleOf.md +1 -1
- package/api/@wtf/release-system/validator/interfaces/ArrayOptions.md +5 -5
- package/api/@wtf/release-system/validator/interfaces/IssueOptions.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/ObjectOptions.md +5 -5
- package/api/@wtf/release-system/validator/interfaces/OptionIssue.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/Property.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/RecordOptions.md +6 -6
- package/api/@wtf/release-system/validator/interfaces/StringOptions.md +6 -6
- package/api/@wtf/release-system/validator/interfaces/Validator.md +4 -4
- package/api/@wtf/release-system/validator/type-aliases/JsonSchema.md +1 -1
- package/api/@wtf/release-system/validator/type-aliases/Path.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadeNotes.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadeText.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadeType.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadesOf.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/higherType.md +1 -1
- package/api/@wtf/release-trains/cascade/interfaces/Cascade.md +11 -11
- package/api/@wtf/release-trains/cascade/interfaces/CascadeCheck.md +8 -8
- package/api/@wtf/release-trains/cascade/type-aliases/CascadeKind.md +1 -1
- package/api/@wtf/release-trains/cascade/type-aliases/ReleaseType.md +1 -1
- package/api/@wtf/release-trains/cascade/variables/RELEASE_TYPES.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/isEcosystem.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/loadEcosystems.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/readPackages.md +1 -1
- package/api/@wtf/release-trains/ecosystem/interfaces/Dependency.md +4 -4
- package/api/@wtf/release-trains/ecosystem/interfaces/Ecosystem.md +5 -5
- package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemContext.md +5 -5
- package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemPackages.md +3 -3
- package/api/@wtf/release-trains/ecosystem/interfaces/Package.md +6 -6
- package/api/@wtf/release-trains/ecosystem/type-aliases/DependencyKind.md +1 -1
- package/api/@wtf/release-trains/ecosystem/type-aliases/ModuleLoader.md +1 -1
- package/api/@wtf/release-trains/ecosystem/variables/DEPENDENCY_KINDS.md +1 -1
- package/api/@wtf/release-trains/errors/classes/TrainsError.md +5 -5
- package/api/@wtf/release-trains/errors/type-aliases/TrainsErrorCode.md +1 -1
- package/api/@wtf/release-trains/errors/variables/TRAINS_ERRORS.md +1 -1
- package/api/@wtf/release-trains/generated/functions/filesIn.md +1 -1
- package/api/@wtf/release-trains/generated/functions/formatGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/listGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/parseGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/readGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/stageGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/stageGeneratedFolders.md +1 -1
- package/api/@wtf/release-trains/generated/functions/unlistedIn.md +1 -1
- package/api/@wtf/release-trains/generated/interfaces/GeneratedOptions.md +2 -2
- package/api/@wtf/release-trains/generated/interfaces/StageOptions.md +6 -6
- package/api/@wtf/release-trains/generated/variables/GENERATED.md +1 -1
- package/api/@wtf/release-trains/git/functions/tagOf.md +1 -1
- package/api/@wtf/release-trains/git/functions/tagsOf.md +1 -1
- package/api/@wtf/release-trains/git/functions/versionOfTag.md +1 -1
- package/api/@wtf/release-trains/git/interfaces/TrainTag.md +3 -3
- package/api/@wtf/release-trains/interfaces/Train.md +7 -7
- package/api/@wtf/release-trains/packages/functions/dependencyEdges.md +1 -1
- package/api/@wtf/release-trains/packages/functions/dependencyText.md +1 -1
- package/api/@wtf/release-trains/packages/functions/dependsOnErrors.md +1 -1
- package/api/@wtf/release-trains/packages/functions/normalizeDir.md +1 -1
- package/api/@wtf/release-trains/packages/functions/ownersOf.md +1 -1
- package/api/@wtf/release-trains/packages/functions/packagesOf.md +1 -1
- package/api/@wtf/release-trains/packages/functions/publishOrder.md +1 -1
- package/api/@wtf/release-trains/packages/functions/releasedVersions.md +1 -1
- package/api/@wtf/release-trains/packages/functions/trainDependencies.md +1 -1
- package/api/@wtf/release-trains/packages/functions/trainOrder.md +1 -1
- package/api/@wtf/release-trains/packages/functions/unsatisfiedErrors.md +1 -1
- package/api/@wtf/release-trains/packages/interfaces/DependencyEdge.md +6 -6
- package/api/@wtf/release-trains/packages/interfaces/OrderFault.md +4 -4
- package/api/@wtf/release-trains/packages/interfaces/OrderPins.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/PublishOrder.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/TrainDependency.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/VersionsRelease.md +7 -7
- package/api/@wtf/release-trains/paths/functions/filterCommits.md +1 -1
- package/api/@wtf/release-trains/paths/functions/gitFilesOf.md +1 -1
- package/api/@wtf/release-trains/paths/functions/overlapError.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainOfPath.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainsOfCommit.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainsOfPath.md +1 -1
- package/api/@wtf/release-trains/paths/type-aliases/FilesOf.md +1 -1
- package/api/@wtf/release-trains/schema/interfaces/ConfigPart.md +6 -6
- package/api/@wtf/release-trains/schema/interfaces/RootOptions.md +7 -7
- package/api/@wtf/release-trains/schema/type-aliases/DependencyRule.md +1 -1
- package/api/@wtf/release-trains/schema/variables/DEPENDENCY_RULES.md +1 -1
- package/api/@wtf/release-trains/schema/variables/TAG_FORMAT_PATTERN.md +1 -1
- package/api/@wtf/release-trains/schema/variables/TRAIN_NAME_PATTERN.md +1 -1
- package/api/@wtf/release-trains/schema/variables/configSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/rootOptionsSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/trainSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/trainsSchema.md +1 -1
- package/api/@wtf/release-trains/trains/functions/changelogOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/matchersOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/overlapErrors.md +1 -1
- package/api/@wtf/release-trains/trains/functions/selectTrain.md +1 -1
- package/api/@wtf/release-trains/trains/functions/tagFormatOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainHeadedNotes.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainOfRun.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainOfTag.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainsErrors.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainsOfOptions.md +1 -1
- package/api/@wtf/release-trains/trains/variables/TRAIN_VARIABLE.md +1 -1
- package/api/@wtf/release-trains/trains/variables/VERSION.md +1 -1
- package/api/@wtf/release-trains/type-aliases/BranchSpec.md +1 -1
- package/api/@wtf/release-trains/type-aliases/Trains.md +1 -1
- package/api/@wtf/release-trains/verify/functions/unreleasedDependencies.md +1 -1
- package/api/@wtf/release-trains/verify/functions/verifyTrain.md +1 -1
- package/api/@wtf/release-trains/verify/interfaces/UnreleasedDependencies.md +10 -10
- package/api/@wtf/release-trains/verify/interfaces/VerifiedTrain.md +5 -5
- package/api/@wtf/release-trains/verify/interfaces/VerifyRelease.md +8 -8
- package/api/@wtf/release-validate/errors/classes/ValidateError.md +5 -5
- package/api/@wtf/release-validate/errors/type-aliases/ValidateErrorCode.md +1 -1
- package/api/@wtf/release-validate/errors/variables/VALIDATE_ERRORS.md +1 -1
- package/api/@wtf/release-validate/interfaces/ConfigIssue.md +4 -4
- package/api/@wtf/release-validate/json-schema/functions/fromJsonSchema.md +1 -1
- package/api/@wtf/release-validate/json-schema/functions/pathOfPointer.md +1 -1
- package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaError.md +3 -3
- package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaValidator.md +3 -3
- package/api/@wtf/release-validate/validate/functions/configErrors.md +1 -1
- package/api/@wtf/release-validate/validate/functions/isStandardSchema.md +1 -1
- package/api/@wtf/release-validate/validate/functions/pathText.md +1 -1
- package/api/@wtf/release-validate/validate/functions/validateConfig.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/indexLookup.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-cargo/interfaces/CargoPluginOptions.md +12 -12
- package/api/@wtf/semantic-release-cargo/interfaces/CargoRelease.md +3 -3
- package/api/@wtf/semantic-release-cargo/schema/type-aliases/CargoOptions.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/cargoOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/cargoSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/variables/default.md +1 -1
- package/api/@wtf/semantic-release-go/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-go/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-go/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-go/functions/verifyRelease.md +1 -1
- package/api/@wtf/semantic-release-go/interfaces/GoPluginOptions.md +8 -8
- package/api/@wtf/semantic-release-go/interfaces/GoRelease.md +3 -3
- package/api/@wtf/semantic-release-go/schema/type-aliases/GoOptions.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/goOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/goSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-go/variables/default.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/pomLookup.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-maven/interfaces/LookupAuth.md +3 -3
- package/api/@wtf/semantic-release-maven/interfaces/MavenPluginOptions.md +12 -12
- package/api/@wtf/semantic-release-maven/interfaces/MavenRelease.md +2 -2
- package/api/@wtf/semantic-release-maven/schema/type-aliases/MavenOptions.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/mavenOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/mavenSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/variables/default.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/addChannel.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/fail.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/loadPublisher.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-npm/interfaces/PublishPluginOptions.md +18 -18
- package/api/@wtf/semantic-release-npm/interfaces/PublishedRelease.md +4 -4
- package/api/@wtf/semantic-release-npm/interfaces/SmokeOption.md +2 -2
- package/api/@wtf/semantic-release-npm/schema/type-aliases/PublishOptions.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/publishOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/publishSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/type-aliases/PublisherSpec.md +1 -1
- package/api/@wtf/semantic-release-npm/variables/default.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/functionOf.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/templatesOf.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-replace/interfaces/ReplacePluginOptions.md +5 -5
- package/api/@wtf/semantic-release-replace/schema/interfaces/ModuleExport.md +3 -3
- package/api/@wtf/semantic-release-replace/schema/interfaces/ReplaceOptions.md +4 -4
- package/api/@wtf/semantic-release-replace/schema/interfaces/RootTemplates.md +2 -2
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacement.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacementSpec.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTemplates.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTo.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplateSet.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplatesOption.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/exportedSetSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/replaceOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/replacementSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/rootTemplatesSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/templateSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/templatesSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/variables/default.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/skipPlugins.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/stepId.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainAssets.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainChangelog.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainOfTag.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainTagFormat.md +1 -1
- package/api/@wtf/semantic-release-trains/config/interfaces/AssetsOptions.md +4 -4
- package/api/@wtf/semantic-release-trains/config/interfaces/SkipOptions.md +3 -3
- package/api/@wtf/semantic-release-trains/config/variables/BRANCHES.md +1 -1
- package/api/@wtf/semantic-release-trains/config/variables/BREAKING.md +1 -1
- package/api/@wtf/semantic-release-trains/config/variables/TITLE.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/skipRuleOf.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/skips.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/trainOptionsOf.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/interfaces/SkipContext.md +5 -5
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/SkipCheck.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/TrainOptions.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/SKIP_RULES.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_OPTIONS.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_SKIP.md +1 -1
- package/api/@wtf/semantic-release-trains/errors/type-aliases/PluginErrorCode.md +1 -1
- package/api/@wtf/semantic-release-trains/errors/variables/PLUGIN_ERRORS.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/decideTrain.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/dotenvOf.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/infoOf.md +1 -1
- package/api/@wtf/semantic-release-trains/info/interfaces/DecideRun.md +4 -4
- package/api/@wtf/semantic-release-trains/info/interfaces/InfoRun.md +8 -8
- package/api/@wtf/semantic-release-trains/info/interfaces/TrainDecision.md +5 -5
- package/api/@wtf/semantic-release-trains/info/interfaces/TrainInfo.md +5 -5
- package/api/@wtf/semantic-release-trains/interfaces/TrainsEntryOptions.md +5 -5
- package/api/@wtf/semantic-release-trains/interfaces/TrainsOptions.md +7 -7
- package/api/@wtf/semantic-release-trains/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/pluginSpecSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/skipRuleSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/trainsEntrySchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/trainsPluginSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/type-aliases/PluginSpec.md +1 -1
- package/api/@wtf/semantic-release-trains/type-aliases/TrainsPluginOptions.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/addChannel.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/analyzeCommits.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/default.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/fail.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/generateNotes.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/prepare.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/publish.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/success.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/verifyRelease.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/configOf.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/loadSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-validate/interfaces/ValidatePluginOptions.md +2 -2
- package/api/@wtf/semantic-release-validate/schema/interfaces/Validator.md +2 -2
- package/api/@wtf/semantic-release-validate/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/schema/variables/validateOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/variables/default.md +1 -1
- package/guides/changelogs.md +39 -28
- package/guides/ci-recipes.md +393 -271
- package/guides/configuring-trains.md +291 -203
- package/guides/dependency-rules.md +171 -113
- package/guides/ecosystems.md +222 -156
- package/guides/getting-started.md +135 -69
- package/guides/publishing-crates.md +208 -143
- package/guides/publishing-go-modules.md +170 -110
- package/guides/publishing-maven.md +197 -123
- package/guides/publishing.md +278 -191
- package/guides/system.md +50 -34
- package/guides/troubleshooting.md +358 -92
- package/guides/validating-a-config.md +68 -49
- package/package.json +1 -1
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **ID\_TOKENS**: readonly `string`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/release.ts:117](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/release.ts:117](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/release.ts#L117)
|
|
12
12
|
|
|
13
13
|
The variables of the environment of an ID token the CI gives, of which npm signs provenance:
|
|
14
14
|
Sigstore's on GitLab, GitHub's OIDC on GitHub Actions. Not `NPM_ID_TOKEN`, of npm's trusted
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **RUNNER\_ENVIRONMENTS**: readonly `string`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/release.ts:124](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/release.ts:124](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/release.ts#L124)
|
|
12
12
|
|
|
13
13
|
The variables of the environment that name the runner of a job, `self-hosted` of one the CI does
|
|
14
14
|
not host: GitLab's, then GitHub's. npm takes provenance of the runners of GitLab.com and GitHub
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **pnpmWorkspaceGlobs**(`yaml`): `string`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/workspace.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/workspace.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/workspace.ts#L48)
|
|
12
12
|
|
|
13
13
|
The `packages` globs of the text of a pnpm-workspace.yaml, as a list or inline.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **publishableOf**(`packages`): [`Manifest`](../../manifests/interfaces/Manifest.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/workspace.ts:190](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/workspace.ts:190](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/workspace.ts#L190)
|
|
12
12
|
|
|
13
13
|
The packages that publish: every one that is not private.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **readWorkspace**(`root`, `options`): `Promise`\<[`Manifest`](../../manifests/interfaces/Manifest.md)[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/workspace.ts:163](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/workspace.ts:163](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/workspace.ts#L163)
|
|
12
12
|
|
|
13
13
|
Each package of the workspace at `root`, read, by the folders of [workspaceFolders](workspaceFolders.md).
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **workspaceFolders**(`root`, `options`): `Promise`\<`string`[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/workspace.ts:123](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/workspace.ts:123](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/workspace.ts#L123)
|
|
12
12
|
|
|
13
13
|
The folder of each package of the workspace at `root`, relative to it, with `/`, in order: each
|
|
14
14
|
its globs name and none of its `!` globs, that holds a package.json. With no workspace, each
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **workspaceGlobs**(`root`, `options`): `Promise`\<[`WorkspaceGlobs`](../interfaces/WorkspaceGlobs.md) \| `undefined`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-npm/src/workspace.ts:77](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-npm/src/workspace.ts:77](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/workspace.ts#L77)
|
|
12
12
|
|
|
13
13
|
The globs of the workspace at `root`: of its pnpm-workspace.yaml, else of the `workspaces` of its
|
|
14
14
|
package.json, a list or `{ packages }`; `undefined` of a repo that declares no workspace.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: WorkspaceGlobs
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/workspace.ts:35](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/workspace.ts:35](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/workspace.ts#L35)
|
|
10
10
|
|
|
11
11
|
The globs of a workspace: those that name its packages, and those that leave some out.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ The globs of a workspace: those that name its packages, and those that leave som
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **exclude**: readonly `string`[]
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-npm/src/workspace.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-npm/src/workspace.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/workspace.ts#L37)
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
@@ -24,4 +24,4 @@ Defined in: [packages/release-npm/src/workspace.ts:37](https://gitlab.com/wetryf
|
|
|
24
24
|
|
|
25
25
|
> `readonly` **include**: readonly `string`[]
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/release-npm/src/workspace.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
27
|
+
Defined in: [packages/release-npm/src/workspace.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/workspace.ts#L36)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: WorkspaceOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-npm/src/workspace.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-npm/src/workspace.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/workspace.ts#L30)
|
|
10
10
|
|
|
11
11
|
How a workspace is read: by the system it is given, which it requires.
|
|
12
12
|
|
|
@@ -16,4 +16,4 @@ How a workspace is read: by the system it is given, which it requires.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-npm/src/workspace.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-npm/src/workspace.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-npm/src/workspace.ts#L31)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ReplaceError
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-replace/src/errors.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-replace/src/errors.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/errors.ts#L31)
|
|
10
10
|
|
|
11
11
|
An error of a replacement, or of the options of the plugin over them: a stable `code`, of
|
|
12
12
|
[REPLACE\_ERRORS](../variables/REPLACE_ERRORS.md) or of `SYSTEM_ERRORS` of `@wtf/release-system/errors`, its `message` what is
|
|
@@ -22,7 +22,7 @@ wrong, and its `details` how to fix it.
|
|
|
22
22
|
|
|
23
23
|
> **new ReplaceError**(`code`, `message`, `details`): `ReplaceError`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/release-system/src/errors.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
25
|
+
Defined in: [packages/release-system/src/errors.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L54)
|
|
26
26
|
|
|
27
27
|
An error of `code`, of its `message` and its `details`, named `SemanticReleaseError`, as
|
|
28
28
|
semantic-release prints one.
|
|
@@ -73,7 +73,7 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
|
|
|
73
73
|
|
|
74
74
|
> `readonly` **code**: `string`
|
|
75
75
|
|
|
76
|
-
Defined in: [packages/release-system/src/errors.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
76
|
+
Defined in: [packages/release-system/src/errors.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L40)
|
|
77
77
|
|
|
78
78
|
The stable code of the error, as `EGIT`.
|
|
79
79
|
|
|
@@ -87,7 +87,7 @@ The stable code of the error, as `EGIT`.
|
|
|
87
87
|
|
|
88
88
|
> `readonly` **details**: `string`
|
|
89
89
|
|
|
90
|
-
Defined in: [packages/release-system/src/errors.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
90
|
+
Defined in: [packages/release-system/src/errors.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L42)
|
|
91
91
|
|
|
92
92
|
How to fix it.
|
|
93
93
|
|
|
@@ -125,7 +125,7 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
|
|
|
125
125
|
|
|
126
126
|
> `readonly` **semanticRelease**: `true`
|
|
127
127
|
|
|
128
|
-
Defined in: [packages/release-system/src/errors.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
128
|
+
Defined in: [packages/release-system/src/errors.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L44)
|
|
129
129
|
|
|
130
130
|
The mark semantic-release prints an error of a plugin by.
|
|
131
131
|
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **ReplaceErrorCode** = keyof *typeof* [`REPLACE_ERRORS`](../variables/REPLACE_ERRORS.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/errors.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/errors.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/errors.ts#L24)
|
|
12
12
|
|
|
13
13
|
A code of [REPLACE\_ERRORS](../variables/REPLACE_ERRORS.md).
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **REPLACE\_ERRORS**: `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/errors.ts:14](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/errors.ts:14](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/errors.ts#L14)
|
|
12
12
|
|
|
13
13
|
The codes of the errors of the replacements, each with what it means.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **filesMatcher**(`patterns`): [`PathMatcher`](../../../release-system/paths/type-aliases/PathMatcher.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/files.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/files.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/files.ts#L40)
|
|
12
12
|
|
|
13
13
|
Whether a file, from the root of the repo, is held by `patterns`, in order: a path or a glob holds
|
|
14
14
|
each file it matches, and every file under each folder it matches, `.` every file; a negation,
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ReplaceMatch
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-replace/src/index.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-replace/src/index.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L37)
|
|
10
10
|
|
|
11
11
|
A match of a replacement, as a function of one is given it.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ A match of a replacement, as a function of one is given it.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **groups**: readonly (`string` \| `undefined`)[]
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-replace/src/index.ts:41](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-replace/src/index.ts:41](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L41)
|
|
20
20
|
|
|
21
21
|
Each group of the match, from `$1`, of `undefined` where a group took no part.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ Each group of the match, from `$1`, of `undefined` where a group took no part.
|
|
|
26
26
|
|
|
27
27
|
> `readonly` **index**: `number`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-replace/src/index.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-replace/src/index.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L45)
|
|
30
30
|
|
|
31
31
|
Where in the text it starts.
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ Where in the text it starts.
|
|
|
36
36
|
|
|
37
37
|
> `readonly` **named**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/release-replace/src/index.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
39
|
+
Defined in: [packages/release-replace/src/index.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L43)
|
|
40
40
|
|
|
41
41
|
Each named group of the match, as `$<name>` reads it: none of a match of no names.
|
|
42
42
|
|
|
@@ -46,6 +46,6 @@ Each named group of the match, as `$<name>` reads it: none of a match of no name
|
|
|
46
46
|
|
|
47
47
|
> `readonly` **text**: `string`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/release-replace/src/index.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
49
|
+
Defined in: [packages/release-replace/src/index.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L39)
|
|
50
50
|
|
|
51
51
|
The text it matched.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ReplacementOf\<T\>
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-replace/src/index.ts:77](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-replace/src/index.ts:77](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L77)
|
|
10
10
|
|
|
11
11
|
A replacement of what `to` is: each match of `from`, a RegExp, replaced by `to`. A
|
|
12
12
|
[Replacement](../type-aliases/Replacement.md) is one of a text or a function; a caller that names functions by other means,
|
|
@@ -28,7 +28,7 @@ name of a module's function of a config of JSON.
|
|
|
28
28
|
|
|
29
29
|
> `readonly` `optional` **escape?**: [`Escape`](../type-aliases/Escape.md)
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/release-replace/src/index.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
31
|
+
Defined in: [packages/release-replace/src/index.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L89)
|
|
32
32
|
|
|
33
33
|
How a text writes each value of the context: as it is, `none`, the default; `shields`, as the
|
|
34
34
|
text of a static badge of shields.io, each `-` and `_` doubled; or `url`, as a component of a
|
|
@@ -40,7 +40,7 @@ URL.
|
|
|
40
40
|
|
|
41
41
|
> `readonly` `optional` **flags?**: `string`
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/release-replace/src/index.ts:81](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
43
|
+
Defined in: [packages/release-replace/src/index.ts:81](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L81)
|
|
44
44
|
|
|
45
45
|
The flags of the RegExp but `g`, which it always has, as `i` or `m`: none by default.
|
|
46
46
|
|
|
@@ -50,7 +50,7 @@ The flags of the RegExp but `g`, which it always has, as `i` or `m`: none by def
|
|
|
50
50
|
|
|
51
51
|
> `readonly` **from**: `string`
|
|
52
52
|
|
|
53
|
-
Defined in: [packages/release-replace/src/index.ts:79](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
53
|
+
Defined in: [packages/release-replace/src/index.ts:79](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L79)
|
|
54
54
|
|
|
55
55
|
The source of the RegExp it matches, everywhere in the text (`g`), as a string.
|
|
56
56
|
|
|
@@ -60,6 +60,6 @@ The source of the RegExp it matches, everywhere in the text (`g`), as a string.
|
|
|
60
60
|
|
|
61
61
|
> `readonly` **to**: `T`
|
|
62
62
|
|
|
63
|
-
Defined in: [packages/release-replace/src/index.ts:83](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
63
|
+
Defined in: [packages/release-replace/src/index.ts:83](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L83)
|
|
64
64
|
|
|
65
65
|
What each match is replaced by.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **regExpOf**(`replacement`): `RegExp`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/replace.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/replace.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L62)
|
|
12
12
|
|
|
13
13
|
The RegExp of a replacement: of its source, `from`, and its flags, the flag `g` always. Throws
|
|
14
14
|
`EREPLACE` of a source or flags of no RegExp, and of an empty source, which would match between
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **replaceFiles**\<`C`\>(`options`): `Promise`\<`string`[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/replace.ts:216](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/replace.ts:216](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L216)
|
|
12
12
|
|
|
13
13
|
Replaces each file git tracks of `files` by each of `replacements` ([replaceText](replaceText.md)), and
|
|
14
14
|
writes each whose text changes. Gives each it wrote, from the root of the repo, in order. A file
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **replaceText**\<`C`\>(`text`, `replacements`, `options`): `Promise`\<`string`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/replace.ts:160](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/replace.ts:160](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L160)
|
|
12
12
|
|
|
13
13
|
The text `text` of each replacement of `replacements`, in order, each over what the one before
|
|
14
14
|
it gave, each of a template its replacement of `options.templates`: each match of a text, of its
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ReplaceOptions\<C\>
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-replace/src/replace.ts:175](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-replace/src/replace.ts:175](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L175)
|
|
10
10
|
|
|
11
11
|
The files of a repo replaced, and how.
|
|
12
12
|
|
|
@@ -25,7 +25,7 @@ values by default.
|
|
|
25
25
|
|
|
26
26
|
> `readonly` **context**: `C`
|
|
27
27
|
|
|
28
|
-
Defined in: [packages/release-replace/src/replace.ts:187](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
28
|
+
Defined in: [packages/release-replace/src/replace.ts:187](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L187)
|
|
29
29
|
|
|
30
30
|
The context a function is given, and of which a text reads its values by default.
|
|
31
31
|
|
|
@@ -35,7 +35,7 @@ The context a function is given, and of which a text reads its values by default
|
|
|
35
35
|
|
|
36
36
|
> `readonly` `optional` **cwd?**: `string`
|
|
37
37
|
|
|
38
|
-
Defined in: [packages/release-replace/src/replace.ts:191](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
38
|
+
Defined in: [packages/release-replace/src/replace.ts:191](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L191)
|
|
39
39
|
|
|
40
40
|
The folder of the repo: the system's working folder by default.
|
|
41
41
|
|
|
@@ -45,7 +45,7 @@ The folder of the repo: the system's working folder by default.
|
|
|
45
45
|
|
|
46
46
|
> `readonly` `optional` **env?**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
|
|
47
47
|
|
|
48
|
-
Defined in: [packages/release-replace/src/replace.ts:193](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
48
|
+
Defined in: [packages/release-replace/src/replace.ts:193](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L193)
|
|
49
49
|
|
|
50
50
|
The environment git runs in: the system's by default.
|
|
51
51
|
|
|
@@ -55,7 +55,7 @@ The environment git runs in: the system's by default.
|
|
|
55
55
|
|
|
56
56
|
> `readonly` **files**: readonly `string`[]
|
|
57
57
|
|
|
58
|
-
Defined in: [packages/release-replace/src/replace.ts:181](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
58
|
+
Defined in: [packages/release-replace/src/replace.ts:181](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L181)
|
|
59
59
|
|
|
60
60
|
The files, from the root of the repo, each a path or a glob, and each of `!` first a negation
|
|
61
61
|
of what the entries before it hold, as `filesMatcher` of `./files` reads them: a folder holds
|
|
@@ -67,7 +67,7 @@ each file under it. Of the files git tracks.
|
|
|
67
67
|
|
|
68
68
|
> `readonly` `optional` **log?**: (`line`) => `void`
|
|
69
69
|
|
|
70
|
-
Defined in: [packages/release-replace/src/replace.ts:201](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
70
|
+
Defined in: [packages/release-replace/src/replace.ts:201](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L201)
|
|
71
71
|
|
|
72
72
|
Where each file written is said: nowhere by default.
|
|
73
73
|
|
|
@@ -89,7 +89,7 @@ The line said of a file written: the count of its matches, and its path.
|
|
|
89
89
|
|
|
90
90
|
> `readonly` **replacements**: readonly [`ReplacementSpec`](../../type-aliases/ReplacementSpec.md)\<[`To`](../type-aliases/To.md)\<`C`\>\>[]
|
|
91
91
|
|
|
92
|
-
Defined in: [packages/release-replace/src/replace.ts:183](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
92
|
+
Defined in: [packages/release-replace/src/replace.ts:183](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L183)
|
|
93
93
|
|
|
94
94
|
The replacements of each file, in order: each whole, or of a template, by its name.
|
|
95
95
|
|
|
@@ -99,7 +99,7 @@ The replacements of each file, in order: each whole, or of a template, by its na
|
|
|
99
99
|
|
|
100
100
|
> `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
|
|
101
101
|
|
|
102
|
-
Defined in: [packages/release-replace/src/replace.ts:195](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
102
|
+
Defined in: [packages/release-replace/src/replace.ts:195](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L195)
|
|
103
103
|
|
|
104
104
|
The system the files and git run by, which it requires.
|
|
105
105
|
|
|
@@ -109,7 +109,7 @@ The system the files and git run by, which it requires.
|
|
|
109
109
|
|
|
110
110
|
> `readonly` `optional` **templates?**: `Readonly`\<`Record`\<`string`, [`ReplacementOf`](../../interfaces/ReplacementOf.md)\<[`To`](../type-aliases/To.md)\<`C`\>\>\>\>
|
|
111
111
|
|
|
112
|
-
Defined in: [packages/release-replace/src/replace.ts:185](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
112
|
+
Defined in: [packages/release-replace/src/replace.ts:185](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L185)
|
|
113
113
|
|
|
114
114
|
The templates a replacement names, by their names: none by default.
|
|
115
115
|
|
|
@@ -119,6 +119,6 @@ The templates a replacement names, by their names: none by default.
|
|
|
119
119
|
|
|
120
120
|
> `readonly` `optional` **values?**: `object`
|
|
121
121
|
|
|
122
|
-
Defined in: [packages/release-replace/src/replace.ts:189](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
122
|
+
Defined in: [packages/release-replace/src/replace.ts:189](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L189)
|
|
123
123
|
|
|
124
124
|
The values a text reads, by their dotted paths: the context by default.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: TextOptions\<C\>
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-replace/src/replace.ts:82](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-replace/src/replace.ts:82](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L82)
|
|
10
10
|
|
|
11
11
|
What a text is replaced of: the file it is of, the context, and the templates.
|
|
12
12
|
|
|
@@ -25,7 +25,7 @@ values by default.
|
|
|
25
25
|
|
|
26
26
|
> `readonly` **context**: `C`
|
|
27
27
|
|
|
28
|
-
Defined in: [packages/release-replace/src/replace.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
28
|
+
Defined in: [packages/release-replace/src/replace.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L86)
|
|
29
29
|
|
|
30
30
|
The context a function is given, and of which a text reads its values by default.
|
|
31
31
|
|
|
@@ -35,7 +35,7 @@ The context a function is given, and of which a text reads its values by default
|
|
|
35
35
|
|
|
36
36
|
> `readonly` **file**: `string`
|
|
37
37
|
|
|
38
|
-
Defined in: [packages/release-replace/src/replace.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
38
|
+
Defined in: [packages/release-replace/src/replace.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L84)
|
|
39
39
|
|
|
40
40
|
The file of the text, from the root of the repo, which a function is given.
|
|
41
41
|
|
|
@@ -45,7 +45,7 @@ The file of the text, from the root of the repo, which a function is given.
|
|
|
45
45
|
|
|
46
46
|
> `readonly` `optional` **templates?**: `Readonly`\<`Record`\<`string`, [`ReplacementOf`](../../interfaces/ReplacementOf.md)\<[`To`](../type-aliases/To.md)\<`C`\>\>\>\>
|
|
47
47
|
|
|
48
|
-
Defined in: [packages/release-replace/src/replace.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
48
|
+
Defined in: [packages/release-replace/src/replace.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L90)
|
|
49
49
|
|
|
50
50
|
The templates a replacement names, by their names: none by default.
|
|
51
51
|
|
|
@@ -55,6 +55,6 @@ The templates a replacement names, by their names: none by default.
|
|
|
55
55
|
|
|
56
56
|
> `readonly` `optional` **values?**: `object`
|
|
57
57
|
|
|
58
|
-
Defined in: [packages/release-replace/src/replace.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
58
|
+
Defined in: [packages/release-replace/src/replace.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L88)
|
|
59
59
|
|
|
60
60
|
The values a text reads, by their dotted paths: the context by default.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **To**\<`C`\> = `string` \| [`ReplaceFunction`](../../type-aliases/ReplaceFunction.md)\<`C`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/replace.ts:52](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/replace.ts:52](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/replace.ts#L52)
|
|
12
12
|
|
|
13
13
|
What `to` of a replacement is: a text, or a function of the context `C`.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **mergeTemplates**\<`T`\>(`sets`): [`Templates`](../../type-aliases/Templates.md)\<`T`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/templates.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/templates.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/templates.ts#L92)
|
|
12
12
|
|
|
13
13
|
The templates of `sets`, merged in order: each template by its name, of the last set that has
|
|
14
14
|
it, so a set after another adds its own and overrides the other's of the same name, as a repo's
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **resolveReplacement**\<`T`\>(`spec`, `templates?`): [`ReplacementOf`](../../interfaces/ReplacementOf.md)\<`T`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/templates.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/templates.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/templates.ts#L45)
|
|
12
12
|
|
|
13
13
|
The replacement `spec` is: itself, of one whole; or of a template, the template of its name of
|
|
14
14
|
`templates`, each option given beside the name over the template's own. Throws `ETEMPLATE` of a
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **resolveReplacements**\<`T`\>(`specs`, `templates?`): [`ReplacementOf`](../../interfaces/ReplacementOf.md)\<`T`\>[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/templates.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/templates.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/templates.ts#L75)
|
|
12
12
|
|
|
13
13
|
The replacements `specs` are, in order, each of [resolveReplacement](resolveReplacement.md): the replacement of
|
|
14
14
|
each template it names, of `templates`. Throws `ETEMPLATE` of a name of no template.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **Escape** = `"none"` \| `"shields"` \| `"url"`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/index.ts:66](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/index.ts:66](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L66)
|
|
12
12
|
|
|
13
13
|
How the text of a replacement writes each value of the context.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **ReplaceFunction**\<`C`\> = (`match`, `file`, `context`) => `string` \| `Promise`\<`string`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/index.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/index.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L59)
|
|
12
12
|
|
|
13
13
|
What a function replaces a match by, of the match, the file, from the root of the repo, and the
|
|
14
14
|
context its caller gives it: a text, or a promise of one.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **Replacement**\<`C`\> = [`ReplacementOf`](../interfaces/ReplacementOf.md)\<`string` \| [`ReplaceFunction`](ReplaceFunction.md)\<`C`\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/index.ts:102](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/index.ts:102](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L102)
|
|
12
12
|
|
|
13
13
|
A replacement: each match of `from`, a RegExp, replaced by `to`, a text or a function.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **ReplacementSpec**\<`T`\> = [`ReplacementOf`](../interfaces/ReplacementOf.md)\<`T`\> \| [`TemplateUse`](TemplateUse.md)\<`T`\> \| `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/index.ts:120](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/index.ts:120](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L120)
|
|
12
12
|
|
|
13
13
|
A replacement as a caller lists it: one whole; one of a template, and the options it overrides;
|
|
14
14
|
or the name of a template alone, the shorthand of `{ template: '<name>' }`.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **TemplateUse**\<`T`\> = `object` & `Partial`\<[`ReplacementOf`](../interfaces/ReplacementOf.md)\<`T`\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/index.ts:111](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/index.ts:111](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L111)
|
|
12
12
|
|
|
13
13
|
A replacement of a template: the replacement of the name `template`, of the templates its caller
|
|
14
14
|
gives, each option given beside it over the template's own.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **Templates**\<`T`\> = `Readonly`\<`Record`\<`string`, [`ReplacementOf`](../interfaces/ReplacementOf.md)\<`T`\>\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/index.ts:128](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/index.ts:128](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/index.ts#L128)
|
|
12
12
|
|
|
13
13
|
The templates of a caller: each a replacement, by its name.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **escapeValue**(`value`, `escape?`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/values.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/values.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/values.ts#L40)
|
|
12
12
|
|
|
13
13
|
`value` as the escape `escape` writes it.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **textOf**(`text`, `values`, `escape?`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/values.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/values.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/values.ts#L89)
|
|
12
12
|
|
|
13
13
|
The text `text` of a replacement as `String.prototype.replace` takes it: each `${path}` the
|
|
14
14
|
value of `values` at its path ([valueAt](valueAt.md)), as `escape` writes it, its `$` doubled, so no
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **valueAt**(`values`, `path`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/values.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/values.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/values.ts#L54)
|
|
12
12
|
|
|
13
13
|
The value of `values` at the dotted path `path`, as text: of a string, a number, a boolean or a
|
|
14
14
|
bigint. Throws `EVALUE` of a path `values` has not, and of a value of no text, as an object.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **ESCAPES**: readonly [`Escape`](../../type-aliases/Escape.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/values.ts:27](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/values.ts:27](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/values.ts#L27)
|
|
12
12
|
|
|
13
13
|
The escapes of [Escape](../../type-aliases/Escape.md), in order.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **VALUE**: `RegExp`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-replace/src/values.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-replace/src/values.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-replace/src/values.ts#L30)
|
|
12
12
|
|
|
13
13
|
A value of the text of a replacement, `${a.b.c}`: its dotted path, its group.
|