@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` **configSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<`object`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-npm/src/schema.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-npm/src/schema.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-npm/src/schema.ts#L85)
|
|
12
12
|
|
|
13
13
|
This package's part of a whole config of semantic-release: each entry of `plugins` of the plugin,
|
|
14
14
|
and `aside` at its root.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **jsonSchema**: [`JsonSchema`](../../../release-system/validator/type-aliases/JsonSchema.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-npm/src/schema.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-npm/src/schema.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-npm/src/schema.ts#L95)
|
|
12
12
|
|
|
13
13
|
The JSON Schema of [configSchema](configSchema.md), as the package publishes it, `schema.json`.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **publishOptionsSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`PublishOptions`](../type-aliases/PublishOptions.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-npm/src/schema.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-npm/src/schema.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-npm/src/schema.ts#L39)
|
|
12
12
|
|
|
13
13
|
The validator of the options of an entry of the plugin, its own.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **publishSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`RootOptions`](../../../release-trains/schema/interfaces/RootOptions.md) & [`PublishOptions`](../type-aliases/PublishOptions.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-npm/src/schema.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-npm/src/schema.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-npm/src/schema.ts#L76)
|
|
12
12
|
|
|
13
13
|
The validator of the options the plugin is given: the root's, and its own.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **PublisherSpec** = `string` \| [`Publisher`](../../release-npm/interfaces/Publisher.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-npm/src/index.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-npm/src/index.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-npm/src/index.ts#L89)
|
|
12
12
|
|
|
13
13
|
A publisher as the option names it: `npm`, the default, or `pnpm`, built in; the path of a
|
|
14
14
|
module, from the root of the repo, or the name of a package, whose default export is a publisher;
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **default**: `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-npm/src/index.ts:408](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-npm/src/index.ts:408](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-npm/src/index.ts#L408)
|
|
12
12
|
|
|
13
13
|
## Type Declaration
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **functionOf**(`spec`, `cwd`): `Promise`\<[`ReplaceFunction`](../../release-replace/type-aliases/ReplaceFunction.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/index.ts:166](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/index.ts:166](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/index.ts#L166)
|
|
12
12
|
|
|
13
13
|
The function `spec` names, its module imported once a process. Throws `EREPLACEMODULE` of a
|
|
14
14
|
module that cannot be loaded, or an export of no function.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **prepare**(`pluginConfig`, `context`): `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/index.ts:305](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/index.ts:305](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/index.ts#L305)
|
|
12
12
|
|
|
13
13
|
Replaces each match of each replacement of each file of the plugin, and writes each file whose
|
|
14
14
|
text changes, each said; and says so of none.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **templatesOf**(`option`, `cwd`): `Promise`\<`Readonly`\<`Record`\<`string`, [`ReplacementOf`](../../release-replace/interfaces/ReplacementOf.md)\<[`PluginTo`](../schema/type-aliases/PluginTo.md)\>\>\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/index.ts:210](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/index.ts:210](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/index.ts#L210)
|
|
12
12
|
|
|
13
13
|
The templates of `option`, of the root of the config or of an entry: each set, the export of a
|
|
14
14
|
module (`exportedSetSchema` of `./schema`) or a map of each by its name, a replacement or the
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **verifyConditions**(`pluginConfig`, `context`): `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/index.ts:288](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/index.ts:288](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/index.ts#L288)
|
|
12
12
|
|
|
13
13
|
Checks the options of the plugin, by `replaceOptionsSchema` of `./schema`, and the templates of
|
|
14
14
|
the root (`EOPTIONS`); imports each template, set of templates and function of a module
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ReplacePluginOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-replace/src/index.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/semantic-release-replace/src/index.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/index.ts#L88)
|
|
10
10
|
|
|
11
11
|
The options of the plugin: its own, and the system it runs by, of the root of the config.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ The options of the plugin: its own, and the system it runs by, of the root of th
|
|
|
20
20
|
|
|
21
21
|
> `readonly` **files**: readonly `string`[]
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
23
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L96)
|
|
24
24
|
|
|
25
25
|
The files, from the root of the repo, of the files git tracks, in order: each a path, a glob,
|
|
26
26
|
or of `!` first a negation of what the entries before it hold. A folder holds each file under
|
|
@@ -36,7 +36,7 @@ it.
|
|
|
36
36
|
|
|
37
37
|
> `readonly` **replacements**: readonly [`PluginReplacementSpec`](../schema/type-aliases/PluginReplacementSpec.md)[]
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
39
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L101)
|
|
40
40
|
|
|
41
41
|
The replacements of each file, in order: each whole; or of a template, `{ template, … }`, each
|
|
42
42
|
option beside its name over the template's own; or the name of a template alone.
|
|
@@ -51,7 +51,7 @@ option beside its name over the template's own; or the name of a template alone.
|
|
|
51
51
|
|
|
52
52
|
> `readonly` `optional` **system?**: [`SystemInput`](../../release-system/system/type-aliases/SystemInput.md)
|
|
53
53
|
|
|
54
|
-
Defined in: [packages/semantic-release-replace/src/index.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
54
|
+
Defined in: [packages/semantic-release-replace/src/index.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/index.ts#L90)
|
|
55
55
|
|
|
56
56
|
The system the plugin runs by, over Node's: see `@wtf/release-system/system`.
|
|
57
57
|
|
|
@@ -61,7 +61,7 @@ The system the plugin runs by, over Node's: see `@wtf/release-system/system`.
|
|
|
61
61
|
|
|
62
62
|
> `readonly` `optional` **templates?**: [`TemplatesOption`](../schema/type-aliases/TemplatesOption.md)
|
|
63
63
|
|
|
64
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:106](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
64
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:106](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L106)
|
|
65
65
|
|
|
66
66
|
The templates a replacement names, each by its name, over those of the root of the config of
|
|
67
67
|
the same name: a set, or sets merged in order; none by default.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ModuleExport
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L58)
|
|
10
10
|
|
|
11
11
|
An export of a module, as a config of JSON names a function, a template or a set of templates of
|
|
12
12
|
one: the module, by its path from the root of the repo or the name of a package, and the name of
|
|
@@ -18,7 +18,7 @@ its export, `default` by default.
|
|
|
18
18
|
|
|
19
19
|
> `readonly` `optional` **export?**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
21
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L62)
|
|
22
22
|
|
|
23
23
|
The name of its export: `default` by default.
|
|
24
24
|
|
|
@@ -28,6 +28,6 @@ The name of its export: `default` by default.
|
|
|
28
28
|
|
|
29
29
|
> `readonly` **module**: `string`
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
31
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L60)
|
|
32
32
|
|
|
33
33
|
The module, by its path from the root of the repo (`./`, `../` or absolute), or a package.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ReplaceOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L90)
|
|
10
10
|
|
|
11
11
|
The options of an entry of the plugin.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ The options of an entry of the plugin.
|
|
|
20
20
|
|
|
21
21
|
> `readonly` **files**: readonly `string`[]
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
23
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L96)
|
|
24
24
|
|
|
25
25
|
The files, from the root of the repo, of the files git tracks, in order: each a path, a glob,
|
|
26
26
|
or of `!` first a negation of what the entries before it hold. A folder holds each file under
|
|
@@ -32,7 +32,7 @@ it.
|
|
|
32
32
|
|
|
33
33
|
> `readonly` **replacements**: readonly [`PluginReplacementSpec`](../type-aliases/PluginReplacementSpec.md)[]
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
35
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L101)
|
|
36
36
|
|
|
37
37
|
The replacements of each file, in order: each whole; or of a template, `{ template, … }`, each
|
|
38
38
|
option beside its name over the template's own; or the name of a template alone.
|
|
@@ -43,7 +43,7 @@ option beside its name over the template's own; or the name of a template alone.
|
|
|
43
43
|
|
|
44
44
|
> `readonly` `optional` **templates?**: [`TemplatesOption`](../type-aliases/TemplatesOption.md)
|
|
45
45
|
|
|
46
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:106](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
46
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:106](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L106)
|
|
47
47
|
|
|
48
48
|
The templates a replacement names, each by its name, over those of the root of the config of
|
|
49
49
|
the same name: a set, or sets merged in order; none by default.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: RootTemplates
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:278](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:278](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L278)
|
|
10
10
|
|
|
11
11
|
The root of a config, as the plugin reads it: its `templates`, which every entry may name.
|
|
12
12
|
|
|
@@ -16,6 +16,6 @@ The root of a config, as the plugin reads it: its `templates`, which every entry
|
|
|
16
16
|
|
|
17
17
|
> `readonly` `optional` **templates?**: [`TemplatesOption`](../type-aliases/TemplatesOption.md)
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:280](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:280](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L280)
|
|
20
20
|
|
|
21
21
|
The templates of every entry of the plugin: a set, or sets merged in order.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **PluginReplacement** = [`ReplacementOf`](../../../release-replace/interfaces/ReplacementOf.md)\<[`PluginTo`](PluginTo.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L72)
|
|
12
12
|
|
|
13
13
|
A replacement of the plugin: what it matches, what it replaces each match by, and its escape.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **PluginReplacementSpec** = [`ReplacementSpec`](../../../release-replace/type-aliases/ReplacementSpec.md)\<[`PluginTo`](PluginTo.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L75)
|
|
12
12
|
|
|
13
13
|
A replacement of the plugin as its options list it: whole, or of a template.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **PluginTemplates** = [`Templates`](../../../release-replace/type-aliases/Templates.md)\<[`PluginTo`](PluginTo.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L78)
|
|
12
12
|
|
|
13
13
|
The templates of the plugin, each a replacement, by its name, as the library takes them.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **PluginTo** = `string` \| [`ModuleExport`](../interfaces/ModuleExport.md) \| [`ReplaceFunction`](../../../release-replace/type-aliases/ReplaceFunction.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L69)
|
|
12
12
|
|
|
13
13
|
What a replacement of the plugin replaces each match by: a text; a function of a module, which
|
|
14
14
|
the plugin imports; or a function, of a config of JavaScript.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **TemplateSet** = [`ModuleExport`](../interfaces/ModuleExport.md) \| `Readonly`\<`Record`\<`string`, [`PluginReplacement`](PluginReplacement.md) \| [`ModuleExport`](../interfaces/ModuleExport.md)\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L84)
|
|
12
12
|
|
|
13
13
|
A set of templates as a config gives it: each by its name, a replacement or the export of a
|
|
14
14
|
module that is one; or the export of a module that is a set of replacements, each by its name.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **TemplatesOption** = [`TemplateSet`](TemplateSet.md) \| readonly [`TemplateSet`](TemplateSet.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L87)
|
|
12
12
|
|
|
13
13
|
The templates as a config gives them: a set, or sets merged in order, each over those before.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **configSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<`object`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:292](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:292](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L292)
|
|
12
12
|
|
|
13
13
|
This package's part of a whole config of semantic-release: `templates` of its root, and each
|
|
14
14
|
entry of `plugins` of the plugin.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **exportedSetSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<`Record`\<`string`, [`PluginReplacement`](../type-aliases/PluginReplacement.md)\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:209](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:209](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L209)
|
|
12
12
|
|
|
13
13
|
The validator of a set of templates a module exports: each a replacement whole, by its name.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **jsonSchema**: [`JsonSchema`](../../../release-system/validator/type-aliases/JsonSchema.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:298](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:298](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L298)
|
|
12
12
|
|
|
13
13
|
The JSON Schema of [configSchema](configSchema.md), as the package publishes it, `schema.json`.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **replaceOptionsSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`ReplaceOptions`](../interfaces/ReplaceOptions.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:253](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:253](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L253)
|
|
12
12
|
|
|
13
13
|
The validator of the options of an entry of the plugin: `files` and `replacements`, required.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **replacementSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`PluginReplacementSpec`](../type-aliases/PluginReplacementSpec.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:162](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:162](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L162)
|
|
12
12
|
|
|
13
13
|
The validator of a replacement: whole, of `from`, `flags`, `to` and `escape`; of a template,
|
|
14
14
|
`{ template, … }`; or the name of a template alone. Which template a name is of is the run's to
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **rootTemplatesSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`RootTemplates`](../interfaces/RootTemplates.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:284](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:284](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L284)
|
|
12
12
|
|
|
13
13
|
The validator of the root of a config, as the plugin reads it: `templates`, optional.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **templateSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`PluginReplacement`](../type-aliases/PluginReplacement.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:202](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:202](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L202)
|
|
12
12
|
|
|
13
13
|
The validator of a replacement whole a template is, as a module exports one: its `to` a text, a
|
|
14
14
|
function or the function of a module; a RegExp that is one, and no escape of a function.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **templatesSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`TemplatesOption`](../type-aliases/TemplatesOption.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/schema.ts:243](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/schema.ts:243](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/schema.ts#L243)
|
|
12
12
|
|
|
13
13
|
The validator of the templates of a config, of its root or of an entry of the plugin: a set, or
|
|
14
14
|
an array of sets, merged in order, each over those before it.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **default**: `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-replace/src/index.ts:327](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-replace/src/index.ts:327](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-replace/src/index.ts#L327)
|
|
12
12
|
|
|
13
13
|
## Type Declaration
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **skipPlugins**\<`T`\>(`plugins`, `pattern`, `options`): `T`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:270](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:270](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L270)
|
|
12
12
|
|
|
13
13
|
The entries of `plugins` but those whose step id ([stepId](stepId.md)) `pattern` matches, the source
|
|
14
14
|
of a RegExp, unanchored, so `exec` matches every step of `@semantic-release/exec`: pin the end of a
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **stepId**(`entry`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:204](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:204](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L204)
|
|
12
12
|
|
|
13
13
|
The id of the step of an entry of `plugins`, as [skipPlugins](skipPlugins.md) matches it: the plugin's name,
|
|
14
14
|
of a string; of an entry with options, `<name>:<the plugin it wraps>`, of an entry of `wrap`,
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **trainAssets**(`trains`, `train`, `options?`): (`string` \| `string`[])[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:142](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:142](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L142)
|
|
12
12
|
|
|
13
13
|
The `assets` of @semantic-release/git of the train `train` of `trains`: its changelog, the
|
|
14
14
|
changelog of each of its packages of `changelogs`, the file of each of `replaced`, and each folder
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **trainChangelog**(`trains`, `train`): `string` \| `undefined`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:112](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:112](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L112)
|
|
12
12
|
|
|
13
13
|
The changelog of the train `train` of `trains`, from the root of the repo, as `changelogFile` of
|
|
14
14
|
@semantic-release/changelog: its own, or `<first path>/CHANGELOG.md`;
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **trainOfTag**(`trains`, `tag`): `string` \| `undefined`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:187](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:187](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L187)
|
|
12
12
|
|
|
13
13
|
The name of the train of `trains` whose tag format names the tag `tag`, as a config of a release
|
|
14
14
|
in two steps names the train of the run of the tag, `RELEASE_TAG`, which
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **trainTagFormat**(`trains`, `train`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L92)
|
|
12
12
|
|
|
13
13
|
The tag format of the train `train` of `trains`, as `tagFormat` of a config: its own, or
|
|
14
14
|
`<train>-v${version}`. Throws `ETRAINNOTSELECTED` and `ETRAINUNKNOWN`.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: AssetsOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:118](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:118](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L118)
|
|
10
10
|
|
|
11
11
|
What [trainAssets](../functions/trainAssets.md) lists of a train.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ What [trainAssets](../functions/trainAssets.md) lists of a train.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` `optional` **changelog?**: `boolean`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:120](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:120](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L120)
|
|
20
20
|
|
|
21
21
|
The train's own changelog, of [trainChangelog](../functions/trainChangelog.md): `true`.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ The train's own changelog, of [trainChangelog](../functions/trainChangelog.md):
|
|
|
26
26
|
|
|
27
27
|
> `readonly` `optional` **changelogs?**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:122](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:122](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L122)
|
|
30
30
|
|
|
31
31
|
The changelog of each package, by its file name, as the changelog plugin writes it: none.
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ The changelog of each package, by its file name, as the changelog plugin writes
|
|
|
36
36
|
|
|
37
37
|
> `readonly` `optional` **replaced?**: `string`
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:127](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
39
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:127](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L127)
|
|
40
40
|
|
|
41
41
|
The files of each package a plugin writes in `prepare`, by their file name, as the `README.md`
|
|
42
42
|
whose badge `@wtf/semantic-release-replace` replaces: none.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: SkipOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:224](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:224](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L224)
|
|
10
10
|
|
|
11
11
|
How [skipPlugins](../functions/skipPlugins.md) skips.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ How [skipPlugins](../functions/skipPlugins.md) skips.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **log**: (`line`) => `void`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:233](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:233](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L233)
|
|
20
20
|
|
|
21
21
|
Where it says what it kept and left out, which it requires: a config, as the root of its run,
|
|
22
22
|
gives it, as of `process.stderr`.
|
|
@@ -39,6 +39,6 @@ The line it says: the pattern, the steps it left out and those it kept.
|
|
|
39
39
|
|
|
40
40
|
> `readonly` `optional` **required?**: readonly `string`[]
|
|
41
41
|
|
|
42
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:226](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
42
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:226](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L226)
|
|
43
43
|
|
|
44
44
|
The names of the plugins it may not leave out, as the one that makes the release commit.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **BRANCHES**: readonly \[`"main"`, \{ `name`: `"rc"`; `prerelease`: `true`; \}, \{ `name`: `"pre"`; `prerelease`: `true`; \}, \{ `name`: `"beta"`; `prerelease`: `true`; \}, \{ `name`: `"alpha"`; `prerelease`: `true`; \}\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L65)
|
|
12
12
|
|
|
13
13
|
The branches a train releases from, as `branches` of a config: `main`, and the prereleases `rc`,
|
|
14
14
|
`pre`, `beta` and `alpha`, each of its own channel. Keep them in step with the rules of the
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **BREAKING**: `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L80)
|
|
12
12
|
|
|
13
13
|
The parser options that read `type!:` and `type(scope)!:` as a breaking change, of a preset that
|
|
14
14
|
does not, as the default `angular`: spread at the root of the config, so semantic-release gives
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **TITLE**: `"# Changelog"` = `'# Changelog'`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-trains/src/config.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-trains/src/config.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/config.ts#L101)
|
|
12
12
|
|
|
13
13
|
The title of a changelog, `changelogTitle` of @semantic-release/changelog: the first line of the
|
|
14
14
|
file, which each release's section goes under.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **skipRuleOf**(`plugin`, `step`, `skip?`): `SkipRule`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-trains/src/defaults.ts:150](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-trains/src/defaults.ts:150](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/defaults.ts#L150)
|
|
12
12
|
|
|
13
13
|
The rule of the step `step` of the plugin `plugin`: of the entry's `skip`, else of
|
|
14
14
|
[TRAIN\_SKIP](../variables/TRAIN_SKIP.md); `false` of none.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **skips**(`rule`, `context`, `load`): `Promise`\<`boolean`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-trains/src/defaults.ts:169](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-trains/src/defaults.ts:169](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/defaults.ts#L169)
|
|
12
12
|
|
|
13
13
|
Whether the rule `rule` skips the step of `context`: `true` and `false` as they are; a rule of
|
|
14
14
|
[SKIP\_RULES](../variables/SKIP_RULES.md) by its name; else the default export of the module it names, loaded by `load`,
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **trainOptionsOf**(`plugin`, `trains`, `train`): `Readonly`\<`Record`\<`string`, `unknown`\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-trains/src/defaults.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-trains/src/defaults.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-trains/src/defaults.ts#L96)
|
|
12
12
|
|
|
13
13
|
The options the train `train` of `trains` gives the plugin `plugin`, by its name: none of a plugin
|
|
14
14
|
[TRAIN\_OPTIONS](../variables/TRAIN_OPTIONS.md) does not name.
|