@wtf/release-docs 8.2.0 → 8.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -44
- package/api/@wtf/release-cargo/auth/functions/mask.md +1 -1
- package/api/@wtf/release-cargo/auth/functions/tokenVariableOf.md +1 -1
- package/api/@wtf/release-cargo/auth/functions/trustedPublishing.md +1 -1
- package/api/@wtf/release-cargo/auth/interfaces/HttpResponse.md +5 -5
- package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishing.md +5 -5
- package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishingOptions.md +6 -6
- package/api/@wtf/release-cargo/auth/type-aliases/HttpFetch.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/CRATES_IO_API.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/ID_TOKEN_VARIABLE.md +1 -1
- package/api/@wtf/release-cargo/auth/variables/USER_AGENT.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/publishOrder.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/publishable.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/readWorkspace.md +1 -1
- package/api/@wtf/release-cargo/crates/functions/selectCrates.md +1 -1
- package/api/@wtf/release-cargo/crates/interfaces/Selection.md +5 -5
- package/api/@wtf/release-cargo/ecosystem/functions/packagesAt.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/packagesOfTree.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/packagesOfWorkspace.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/resolveRequirement.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/satisfiesRequirement.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/functions/semverRange.md +1 -1
- package/api/@wtf/release-cargo/ecosystem/interfaces/CargoPackage.md +7 -7
- package/api/@wtf/release-cargo/ecosystem/variables/cargoEcosystem.md +1 -1
- package/api/@wtf/release-cargo/errors/classes/CargoError.md +5 -5
- package/api/@wtf/release-cargo/errors/type-aliases/CargoErrorCode.md +1 -1
- package/api/@wtf/release-cargo/errors/variables/CARGO_ERRORS.md +1 -1
- package/api/@wtf/release-cargo/interfaces/Crate.md +6 -6
- package/api/@wtf/release-cargo/interfaces/CrateDependency.md +6 -6
- package/api/@wtf/release-cargo/interfaces/Workspace.md +3 -3
- package/api/@wtf/release-cargo/publish/functions/publishCrates.md +1 -1
- package/api/@wtf/release-cargo/publish/interfaces/PublishCratesOptions.md +11 -11
- package/api/@wtf/release-cargo/publish/interfaces/PublishedCrate.md +5 -5
- package/api/@wtf/release-cargo/publish/type-aliases/CrateStatus.md +1 -1
- package/api/@wtf/release-cargo/publish/variables/RECHECK_WAITS.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/crateUrl.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/indexHasVersion.md +1 -1
- package/api/@wtf/release-cargo/registry/functions/indexPath.md +1 -1
- package/api/@wtf/release-cargo/registry/variables/CRATES_IO_INDEX.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/inheritsVersion.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/stampManifest.md +1 -1
- package/api/@wtf/release-cargo/stamp/functions/stampWorkspace.md +1 -1
- package/api/@wtf/release-cargo/stamp/interfaces/StampOptions.md +4 -4
- package/api/@wtf/release-cargo/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-cargo/stamp/interfaces/StampedWorkspace.md +3 -3
- package/api/@wtf/release-cargo/type-aliases/DependencyKind.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/packagesOfModules.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/packagesOfRepo.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/resolveVersion.md +1 -1
- package/api/@wtf/release-go/ecosystem/functions/satisfiesVersion.md +1 -1
- package/api/@wtf/release-go/ecosystem/interfaces/GoPackage.md +7 -7
- package/api/@wtf/release-go/ecosystem/variables/goEcosystem.md +1 -1
- package/api/@wtf/release-go/errors/classes/GoError.md +5 -5
- package/api/@wtf/release-go/errors/type-aliases/GoErrorCode.md +1 -1
- package/api/@wtf/release-go/errors/variables/GO_ERRORS.md +1 -1
- package/api/@wtf/release-go/gomod/functions/entriesOf.md +1 -1
- package/api/@wtf/release-go/gomod/functions/linesOf.md +1 -1
- package/api/@wtf/release-go/gomod/functions/readGoMod.md +1 -1
- package/api/@wtf/release-go/gomod/functions/tokensOf.md +1 -1
- package/api/@wtf/release-go/gomod/interfaces/Entry.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/GoMod.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/GoReplace.md +6 -6
- package/api/@wtf/release-go/gomod/interfaces/GoRequire.md +4 -4
- package/api/@wtf/release-go/gomod/interfaces/Token.md +5 -5
- package/api/@wtf/release-go/interfaces/GoModule.md +6 -6
- package/api/@wtf/release-go/modules/functions/isFetchable.md +1 -1
- package/api/@wtf/release-go/modules/functions/isGoMod.md +1 -1
- package/api/@wtf/release-go/modules/functions/majorErrors.md +1 -1
- package/api/@wtf/release-go/modules/functions/majorOfPath.md +1 -1
- package/api/@wtf/release-go/modules/functions/modulesAt.md +1 -1
- package/api/@wtf/release-go/modules/functions/modulesOf.md +1 -1
- package/api/@wtf/release-go/modules/functions/readModules.md +1 -1
- package/api/@wtf/release-go/modules/functions/selectModules.md +1 -1
- package/api/@wtf/release-go/modules/interfaces/Selection.md +4 -4
- package/api/@wtf/release-go/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-go/stamp/functions/stampGoMod.md +1 -1
- package/api/@wtf/release-go/stamp/functions/stampModules.md +1 -1
- package/api/@wtf/release-go/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-go/stamp/interfaces/StampedModules.md +3 -3
- package/api/@wtf/release-go/tags/functions/askProxy.md +1 -1
- package/api/@wtf/release-go/tags/functions/maskCredentials.md +1 -1
- package/api/@wtf/release-go/tags/functions/releaseCommit.md +1 -1
- package/api/@wtf/release-go/tags/functions/remoteTags.md +1 -1
- package/api/@wtf/release-go/tags/functions/tagModules.md +1 -1
- package/api/@wtf/release-go/tags/functions/tagOfModule.md +1 -1
- package/api/@wtf/release-go/tags/functions/tagPrefix.md +1 -1
- package/api/@wtf/release-go/tags/interfaces/TagModulesOptions.md +8 -8
- package/api/@wtf/release-go/tags/interfaces/TaggedModule.md +5 -5
- package/api/@wtf/release-go/tags/type-aliases/ModuleStatus.md +1 -1
- package/api/@wtf/release-go/tags/variables/RELEASE_AUTHOR.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/groupIdOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/installsOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/isPomFile.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/isRange.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/modulesOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/nameOf.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/publishOrder.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/readModules.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/readPoms.md +1 -1
- package/api/@wtf/release-maven/artifacts/functions/selectArtifacts.md +1 -1
- package/api/@wtf/release-maven/artifacts/interfaces/Selection.md +4 -4
- package/api/@wtf/release-maven/ecosystem/functions/compareVersions.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/parseRange.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/resolveVersion.md +1 -1
- package/api/@wtf/release-maven/ecosystem/functions/satisfiesVersion.md +1 -1
- package/api/@wtf/release-maven/ecosystem/interfaces/Bound.md +3 -3
- package/api/@wtf/release-maven/ecosystem/interfaces/Restriction.md +3 -3
- package/api/@wtf/release-maven/ecosystem/variables/mavenEcosystem.md +1 -1
- package/api/@wtf/release-maven/errors/classes/MavenError.md +5 -5
- package/api/@wtf/release-maven/errors/type-aliases/MavenErrorCode.md +1 -1
- package/api/@wtf/release-maven/errors/variables/MAVEN_ERRORS.md +1 -1
- package/api/@wtf/release-maven/interfaces/MavenModule.md +14 -14
- package/api/@wtf/release-maven/pom/functions/childOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/childrenOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/dependencyOf.md +1 -1
- package/api/@wtf/release-maven/pom/functions/escapeXml.md +1 -1
- package/api/@wtf/release-maven/pom/functions/parseXml.md +1 -1
- package/api/@wtf/release-maven/pom/functions/readPom.md +1 -1
- package/api/@wtf/release-maven/pom/functions/textAt.md +1 -1
- package/api/@wtf/release-maven/pom/interfaces/Pom.md +15 -15
- package/api/@wtf/release-maven/pom/interfaces/PomDependency.md +5 -5
- package/api/@wtf/release-maven/pom/interfaces/PomParent.md +4 -4
- package/api/@wtf/release-maven/pom/interfaces/PomPlugin.md +5 -5
- package/api/@wtf/release-maven/pom/interfaces/PomRepository.md +3 -3
- package/api/@wtf/release-maven/pom/interfaces/Span.md +3 -3
- package/api/@wtf/release-maven/pom/interfaces/XmlElement.md +7 -7
- package/api/@wtf/release-maven/pom/variables/PLUGIN_GROUP.md +1 -1
- package/api/@wtf/release-maven/publish/functions/deployModules.md +1 -1
- package/api/@wtf/release-maven/publish/interfaces/DeployModulesOptions.md +11 -11
- package/api/@wtf/release-maven/publish/interfaces/DeployedModule.md +4 -4
- package/api/@wtf/release-maven/publish/type-aliases/ModuleStatus.md +1 -1
- package/api/@wtf/release-maven/repository/functions/deployTargets.md +1 -1
- package/api/@wtf/release-maven/repository/functions/expandValues.md +1 -1
- package/api/@wtf/release-maven/repository/functions/hasPom.md +1 -1
- package/api/@wtf/release-maven/repository/functions/pomPath.md +1 -1
- package/api/@wtf/release-maven/repository/functions/pomUrl.md +1 -1
- package/api/@wtf/release-maven/repository/interfaces/Repository.md +3 -3
- package/api/@wtf/release-maven/repository/interfaces/ValuesOf.md +3 -3
- package/api/@wtf/release-maven/repository/variables/MAVEN_CENTRAL.md +1 -1
- package/api/@wtf/release-maven/stamp/functions/checkVersions.md +1 -1
- package/api/@wtf/release-maven/stamp/functions/stampModules.md +1 -1
- package/api/@wtf/release-maven/stamp/functions/stampPom.md +1 -1
- package/api/@wtf/release-maven/stamp/interfaces/PomStampOptions.md +5 -5
- package/api/@wtf/release-maven/stamp/interfaces/Stamped.md +3 -3
- package/api/@wtf/release-maven/stamp/interfaces/StampedModules.md +3 -3
- package/api/@wtf/release-npm/check/functions/checkPackages.md +1 -1
- package/api/@wtf/release-npm/check/functions/formatIssue.md +1 -1
- package/api/@wtf/release-npm/check/interfaces/CheckOptions.md +6 -6
- package/api/@wtf/release-npm/check/interfaces/Issue.md +5 -5
- package/api/@wtf/release-npm/check/type-aliases/CheckedPackage.md +1 -1
- package/api/@wtf/release-npm/check/type-aliases/IssueCode.md +1 -1
- package/api/@wtf/release-npm/ecosystem/variables/npmEcosystem.md +1 -1
- package/api/@wtf/release-npm/errors/type-aliases/NpmErrorCode.md +1 -1
- package/api/@wtf/release-npm/errors/variables/NPM_ERRORS.md +1 -1
- package/api/@wtf/release-npm/interfaces/Lookup.md +3 -3
- package/api/@wtf/release-npm/interfaces/PublishOptions.md +6 -6
- package/api/@wtf/release-npm/interfaces/PublishPackage.md +5 -5
- package/api/@wtf/release-npm/interfaces/PublishTrainOptions.md +13 -13
- package/api/@wtf/release-npm/interfaces/Publisher.md +7 -7
- package/api/@wtf/release-npm/interfaces/PublisherContext.md +7 -7
- package/api/@wtf/release-npm/manifests/functions/concreteRange.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/manifestsAt.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/packageOf.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/packagesOfManifests.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/readManifests.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/resolveSpecifier.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/runtimeDependenciesOf.md +1 -1
- package/api/@wtf/release-npm/manifests/functions/satisfiesRange.md +1 -1
- package/api/@wtf/release-npm/manifests/interfaces/Manifest.md +5 -5
- package/api/@wtf/release-npm/manifests/interfaces/NpmPackage.md +7 -7
- package/api/@wtf/release-npm/manifests/type-aliases/DependencyField.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/DEPENDENCY_FIELDS.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/FIELD_KINDS.md +1 -1
- package/api/@wtf/release-npm/manifests/variables/RUNTIME_FIELDS.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/isTypeScriptSource.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/prepareManifest.md +1 -1
- package/api/@wtf/release-npm/prepare/functions/stripSourceConditions.md +1 -1
- package/api/@wtf/release-npm/prepare/interfaces/PrepareOptions.md +5 -5
- package/api/@wtf/release-npm/prepare/interfaces/PreparedManifest.md +6 -6
- package/api/@wtf/release-npm/prepare/variables/SOURCE_CONDITIONS.md +1 -1
- package/api/@wtf/release-npm/publishers/functions/builtInPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/functions/isPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/NPM_REGISTRY.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/PUBLISHERS.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/npmPublisher.md +1 -1
- package/api/@wtf/release-npm/publishers/variables/pnpmPublisher.md +1 -1
- package/api/@wtf/release-npm/release/functions/checkTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/distTagOf.md +1 -1
- package/api/@wtf/release-npm/release/functions/packTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishPacked.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishedOf.md +1 -1
- package/api/@wtf/release-npm/release/functions/publishedOfResolved.md +1 -1
- package/api/@wtf/release-npm/release/functions/releaseTrain.md +1 -1
- package/api/@wtf/release-npm/release/functions/resolveManifests.md +1 -1
- package/api/@wtf/release-npm/release/functions/tagTrain.md +1 -1
- package/api/@wtf/release-npm/release/interfaces/CheckRelease.md +16 -16
- package/api/@wtf/release-npm/release/interfaces/PackOptions.md +8 -8
- package/api/@wtf/release-npm/release/interfaces/PackedTrain.md +12 -12
- package/api/@wtf/release-npm/release/interfaces/PublishRun.md +11 -11
- package/api/@wtf/release-npm/release/interfaces/PublishedOf.md +4 -4
- package/api/@wtf/release-npm/release/interfaces/PublishedPackage.md +7 -7
- package/api/@wtf/release-npm/release/interfaces/PublishedTrain.md +5 -5
- package/api/@wtf/release-npm/release/interfaces/ResolveRelease.md +17 -17
- package/api/@wtf/release-npm/release/interfaces/ResolvedPackage.md +4 -4
- package/api/@wtf/release-npm/release/interfaces/ResolvedTrain.md +6 -6
- package/api/@wtf/release-npm/release/interfaces/TagRelease.md +14 -14
- package/api/@wtf/release-npm/release/type-aliases/LookedUpTrain.md +1 -1
- package/api/@wtf/release-npm/release/type-aliases/ReleaseRun.md +1 -1
- package/api/@wtf/release-npm/release/variables/ID_TOKENS.md +1 -1
- package/api/@wtf/release-npm/release/variables/RUNNER_ENVIRONMENTS.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/pnpmWorkspaceGlobs.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/publishableOf.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/readWorkspace.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/workspaceFolders.md +1 -1
- package/api/@wtf/release-npm/workspace/functions/workspaceGlobs.md +1 -1
- package/api/@wtf/release-npm/workspace/interfaces/WorkspaceGlobs.md +3 -3
- package/api/@wtf/release-npm/workspace/interfaces/WorkspaceOptions.md +2 -2
- package/api/@wtf/release-replace/errors/classes/ReplaceError.md +5 -5
- package/api/@wtf/release-replace/errors/type-aliases/ReplaceErrorCode.md +1 -1
- package/api/@wtf/release-replace/errors/variables/REPLACE_ERRORS.md +1 -1
- package/api/@wtf/release-replace/files/functions/filesMatcher.md +1 -1
- package/api/@wtf/release-replace/interfaces/ReplaceMatch.md +5 -5
- package/api/@wtf/release-replace/interfaces/ReplacementOf.md +5 -5
- package/api/@wtf/release-replace/replace/functions/regExpOf.md +1 -1
- package/api/@wtf/release-replace/replace/functions/replaceFiles.md +1 -1
- package/api/@wtf/release-replace/replace/functions/replaceText.md +1 -1
- package/api/@wtf/release-replace/replace/interfaces/ReplaceOptions.md +10 -10
- package/api/@wtf/release-replace/replace/interfaces/TextOptions.md +5 -5
- package/api/@wtf/release-replace/replace/type-aliases/To.md +1 -1
- package/api/@wtf/release-replace/templates/functions/mergeTemplates.md +1 -1
- package/api/@wtf/release-replace/templates/functions/resolveReplacement.md +1 -1
- package/api/@wtf/release-replace/templates/functions/resolveReplacements.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Escape.md +1 -1
- package/api/@wtf/release-replace/type-aliases/ReplaceFunction.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Replacement.md +1 -1
- package/api/@wtf/release-replace/type-aliases/ReplacementSpec.md +1 -1
- package/api/@wtf/release-replace/type-aliases/TemplateUse.md +1 -1
- package/api/@wtf/release-replace/type-aliases/Templates.md +1 -1
- package/api/@wtf/release-replace/values/functions/escapeValue.md +1 -1
- package/api/@wtf/release-replace/values/functions/textOf.md +1 -1
- package/api/@wtf/release-replace/values/functions/valueAt.md +1 -1
- package/api/@wtf/release-replace/values/variables/ESCAPES.md +1 -1
- package/api/@wtf/release-replace/values/variables/VALUE.md +1 -1
- package/api/@wtf/release-system/errors/classes/ReleaseError.md +5 -5
- package/api/@wtf/release-system/errors/functions/throwAll.md +1 -1
- package/api/@wtf/release-system/errors/type-aliases/ErrorClass.md +1 -1
- package/api/@wtf/release-system/errors/type-aliases/SystemErrorCode.md +1 -1
- package/api/@wtf/release-system/errors/variables/SYSTEM_ERRORS.md +1 -1
- package/api/@wtf/release-system/git/functions/commitsSince.md +1 -1
- package/api/@wtf/release-system/git/functions/filesOfCommits.md +1 -1
- package/api/@wtf/release-system/git/functions/git.md +1 -1
- package/api/@wtf/release-system/git/functions/gitOf.md +1 -1
- package/api/@wtf/release-system/git/functions/trackedFiles.md +1 -1
- package/api/@wtf/release-system/git/interfaces/GitContext.md +4 -4
- package/api/@wtf/release-system/git/interfaces/LogCommit.md +5 -5
- package/api/@wtf/release-system/node/functions/nodeSystem.md +1 -1
- package/api/@wtf/release-system/node/functions/realPathOf.md +1 -1
- package/api/@wtf/release-system/node/functions/systemOf.md +1 -1
- package/api/@wtf/release-system/paths/functions/normalizePath.md +1 -1
- package/api/@wtf/release-system/paths/functions/pathMatcher.md +1 -1
- package/api/@wtf/release-system/paths/type-aliases/PathMatcher.md +1 -1
- package/api/@wtf/release-system/posix/functions/basenameOf.md +1 -1
- package/api/@wtf/release-system/posix/functions/dirnameOf.md +1 -1
- package/api/@wtf/release-system/posix/functions/joinPath.md +1 -1
- package/api/@wtf/release-system/posix/functions/relativePath.md +1 -1
- package/api/@wtf/release-system/posix/functions/resolvePath.md +1 -1
- package/api/@wtf/release-system/system/interfaces/DirEntry.md +3 -3
- package/api/@wtf/release-system/system/interfaces/ExecOptions.md +4 -4
- package/api/@wtf/release-system/system/interfaces/ExecResult.md +4 -4
- package/api/@wtf/release-system/system/interfaces/System.md +7 -7
- package/api/@wtf/release-system/system/interfaces/SystemFs.md +8 -8
- package/api/@wtf/release-system/system/type-aliases/Exec.md +1 -1
- package/api/@wtf/release-system/system/type-aliases/SystemInput.md +1 -1
- package/api/@wtf/release-system/validator/functions/allOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/anyObject.md +1 -1
- package/api/@wtf/release-system/validator/functions/anyOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/arrayOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/booleanOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/errorOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/errorsOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/exclusive.md +1 -1
- package/api/@wtf/release-system/validator/functions/issuesOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/objectOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/oneOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/orFunction.md +1 -1
- package/api/@wtf/release-system/validator/functions/pathText.md +1 -1
- package/api/@wtf/release-system/validator/functions/pluginEntriesOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/recordOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/refined.md +1 -1
- package/api/@wtf/release-system/validator/functions/stringOf.md +1 -1
- package/api/@wtf/release-system/validator/functions/tupleOf.md +1 -1
- package/api/@wtf/release-system/validator/interfaces/ArrayOptions.md +5 -5
- package/api/@wtf/release-system/validator/interfaces/IssueOptions.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/ObjectOptions.md +5 -5
- package/api/@wtf/release-system/validator/interfaces/OptionIssue.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/Property.md +4 -4
- package/api/@wtf/release-system/validator/interfaces/RecordOptions.md +6 -6
- package/api/@wtf/release-system/validator/interfaces/StringOptions.md +6 -6
- package/api/@wtf/release-system/validator/interfaces/Validator.md +4 -4
- package/api/@wtf/release-system/validator/type-aliases/JsonSchema.md +1 -1
- package/api/@wtf/release-system/validator/type-aliases/Path.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadeNotes.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadeText.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadeType.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/cascadesOf.md +1 -1
- package/api/@wtf/release-trains/cascade/functions/higherType.md +1 -1
- package/api/@wtf/release-trains/cascade/interfaces/Cascade.md +11 -11
- package/api/@wtf/release-trains/cascade/interfaces/CascadeCheck.md +8 -8
- package/api/@wtf/release-trains/cascade/type-aliases/CascadeKind.md +1 -1
- package/api/@wtf/release-trains/cascade/type-aliases/ReleaseType.md +1 -1
- package/api/@wtf/release-trains/cascade/variables/RELEASE_TYPES.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/isEcosystem.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/loadEcosystems.md +1 -1
- package/api/@wtf/release-trains/ecosystem/functions/readPackages.md +1 -1
- package/api/@wtf/release-trains/ecosystem/interfaces/Dependency.md +4 -4
- package/api/@wtf/release-trains/ecosystem/interfaces/Ecosystem.md +5 -5
- package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemContext.md +5 -5
- package/api/@wtf/release-trains/ecosystem/interfaces/EcosystemPackages.md +3 -3
- package/api/@wtf/release-trains/ecosystem/interfaces/Package.md +6 -6
- package/api/@wtf/release-trains/ecosystem/type-aliases/DependencyKind.md +1 -1
- package/api/@wtf/release-trains/ecosystem/type-aliases/ModuleLoader.md +1 -1
- package/api/@wtf/release-trains/ecosystem/variables/DEPENDENCY_KINDS.md +1 -1
- package/api/@wtf/release-trains/errors/classes/TrainsError.md +5 -5
- package/api/@wtf/release-trains/errors/type-aliases/TrainsErrorCode.md +1 -1
- package/api/@wtf/release-trains/errors/variables/TRAINS_ERRORS.md +1 -1
- package/api/@wtf/release-trains/generated/functions/filesIn.md +1 -1
- package/api/@wtf/release-trains/generated/functions/formatGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/listGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/parseGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/readGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/stageGenerated.md +1 -1
- package/api/@wtf/release-trains/generated/functions/stageGeneratedFolders.md +1 -1
- package/api/@wtf/release-trains/generated/functions/unlistedIn.md +1 -1
- package/api/@wtf/release-trains/generated/interfaces/GeneratedOptions.md +2 -2
- package/api/@wtf/release-trains/generated/interfaces/StageOptions.md +6 -6
- package/api/@wtf/release-trains/generated/variables/GENERATED.md +1 -1
- package/api/@wtf/release-trains/git/functions/tagOf.md +1 -1
- package/api/@wtf/release-trains/git/functions/tagsOf.md +1 -1
- package/api/@wtf/release-trains/git/functions/versionOfTag.md +1 -1
- package/api/@wtf/release-trains/git/interfaces/TrainTag.md +3 -3
- package/api/@wtf/release-trains/interfaces/Train.md +7 -7
- package/api/@wtf/release-trains/packages/functions/dependencyEdges.md +1 -1
- package/api/@wtf/release-trains/packages/functions/dependencyText.md +1 -1
- package/api/@wtf/release-trains/packages/functions/dependsOnErrors.md +1 -1
- package/api/@wtf/release-trains/packages/functions/normalizeDir.md +1 -1
- package/api/@wtf/release-trains/packages/functions/ownersOf.md +1 -1
- package/api/@wtf/release-trains/packages/functions/packagesOf.md +1 -1
- package/api/@wtf/release-trains/packages/functions/publishOrder.md +1 -1
- package/api/@wtf/release-trains/packages/functions/releasedVersions.md +1 -1
- package/api/@wtf/release-trains/packages/functions/trainDependencies.md +1 -1
- package/api/@wtf/release-trains/packages/functions/trainOrder.md +1 -1
- package/api/@wtf/release-trains/packages/functions/unsatisfiedErrors.md +1 -1
- package/api/@wtf/release-trains/packages/interfaces/DependencyEdge.md +6 -6
- package/api/@wtf/release-trains/packages/interfaces/OrderFault.md +4 -4
- package/api/@wtf/release-trains/packages/interfaces/OrderPins.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/PublishOrder.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/TrainDependency.md +3 -3
- package/api/@wtf/release-trains/packages/interfaces/VersionsRelease.md +7 -7
- package/api/@wtf/release-trains/paths/functions/filterCommits.md +1 -1
- package/api/@wtf/release-trains/paths/functions/gitFilesOf.md +1 -1
- package/api/@wtf/release-trains/paths/functions/overlapError.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainOfPath.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainsOfCommit.md +1 -1
- package/api/@wtf/release-trains/paths/functions/trainsOfPath.md +1 -1
- package/api/@wtf/release-trains/paths/type-aliases/FilesOf.md +1 -1
- package/api/@wtf/release-trains/schema/interfaces/ConfigPart.md +6 -6
- package/api/@wtf/release-trains/schema/interfaces/RootOptions.md +7 -7
- package/api/@wtf/release-trains/schema/type-aliases/DependencyRule.md +1 -1
- package/api/@wtf/release-trains/schema/variables/DEPENDENCY_RULES.md +1 -1
- package/api/@wtf/release-trains/schema/variables/TAG_FORMAT_PATTERN.md +1 -1
- package/api/@wtf/release-trains/schema/variables/TRAIN_NAME_PATTERN.md +1 -1
- package/api/@wtf/release-trains/schema/variables/configSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/rootOptionsSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/trainSchema.md +1 -1
- package/api/@wtf/release-trains/schema/variables/trainsSchema.md +1 -1
- package/api/@wtf/release-trains/trains/functions/changelogOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/matchersOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/overlapErrors.md +1 -1
- package/api/@wtf/release-trains/trains/functions/selectTrain.md +1 -1
- package/api/@wtf/release-trains/trains/functions/tagFormatOf.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainHeadedNotes.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainOfRun.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainOfTag.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainsErrors.md +1 -1
- package/api/@wtf/release-trains/trains/functions/trainsOfOptions.md +1 -1
- package/api/@wtf/release-trains/trains/variables/TRAIN_VARIABLE.md +1 -1
- package/api/@wtf/release-trains/trains/variables/VERSION.md +1 -1
- package/api/@wtf/release-trains/type-aliases/BranchSpec.md +1 -1
- package/api/@wtf/release-trains/type-aliases/Trains.md +1 -1
- package/api/@wtf/release-trains/verify/functions/unreleasedDependencies.md +1 -1
- package/api/@wtf/release-trains/verify/functions/verifyTrain.md +1 -1
- package/api/@wtf/release-trains/verify/interfaces/UnreleasedDependencies.md +10 -10
- package/api/@wtf/release-trains/verify/interfaces/VerifiedTrain.md +5 -5
- package/api/@wtf/release-trains/verify/interfaces/VerifyRelease.md +8 -8
- package/api/@wtf/release-validate/errors/classes/ValidateError.md +5 -5
- package/api/@wtf/release-validate/errors/type-aliases/ValidateErrorCode.md +1 -1
- package/api/@wtf/release-validate/errors/variables/VALIDATE_ERRORS.md +1 -1
- package/api/@wtf/release-validate/interfaces/ConfigIssue.md +4 -4
- package/api/@wtf/release-validate/json-schema/functions/fromJsonSchema.md +1 -1
- package/api/@wtf/release-validate/json-schema/functions/pathOfPointer.md +1 -1
- package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaError.md +3 -3
- package/api/@wtf/release-validate/json-schema/interfaces/JsonSchemaValidator.md +3 -3
- package/api/@wtf/release-validate/validate/functions/configErrors.md +1 -1
- package/api/@wtf/release-validate/validate/functions/isStandardSchema.md +1 -1
- package/api/@wtf/release-validate/validate/functions/pathText.md +1 -1
- package/api/@wtf/release-validate/validate/functions/validateConfig.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/indexLookup.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-cargo/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-cargo/interfaces/CargoPluginOptions.md +12 -12
- package/api/@wtf/semantic-release-cargo/interfaces/CargoRelease.md +3 -3
- package/api/@wtf/semantic-release-cargo/schema/type-aliases/CargoOptions.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/cargoOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/cargoSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-cargo/variables/default.md +1 -1
- package/api/@wtf/semantic-release-go/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-go/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-go/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-go/functions/verifyRelease.md +1 -1
- package/api/@wtf/semantic-release-go/interfaces/GoPluginOptions.md +8 -8
- package/api/@wtf/semantic-release-go/interfaces/GoRelease.md +3 -3
- package/api/@wtf/semantic-release-go/schema/type-aliases/GoOptions.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/goOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/goSchema.md +1 -1
- package/api/@wtf/semantic-release-go/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-go/variables/default.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/pomLookup.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-maven/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-maven/interfaces/LookupAuth.md +3 -3
- package/api/@wtf/semantic-release-maven/interfaces/MavenPluginOptions.md +12 -12
- package/api/@wtf/semantic-release-maven/interfaces/MavenRelease.md +2 -2
- package/api/@wtf/semantic-release-maven/schema/type-aliases/MavenOptions.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/mavenOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/schema/variables/mavenSchema.md +1 -1
- package/api/@wtf/semantic-release-maven/variables/default.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/addChannel.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/fail.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/loadPublisher.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/publish.md +1 -1
- package/api/@wtf/semantic-release-npm/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-npm/interfaces/PublishPluginOptions.md +18 -18
- package/api/@wtf/semantic-release-npm/interfaces/PublishedRelease.md +4 -4
- package/api/@wtf/semantic-release-npm/interfaces/SmokeOption.md +2 -2
- package/api/@wtf/semantic-release-npm/schema/type-aliases/PublishOptions.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/publishOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/schema/variables/publishSchema.md +1 -1
- package/api/@wtf/semantic-release-npm/type-aliases/PublisherSpec.md +1 -1
- package/api/@wtf/semantic-release-npm/variables/default.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/functionOf.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/prepare.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/templatesOf.md +1 -1
- package/api/@wtf/semantic-release-replace/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-replace/interfaces/ReplacePluginOptions.md +5 -5
- package/api/@wtf/semantic-release-replace/schema/interfaces/ModuleExport.md +3 -3
- package/api/@wtf/semantic-release-replace/schema/interfaces/ReplaceOptions.md +4 -4
- package/api/@wtf/semantic-release-replace/schema/interfaces/RootTemplates.md +2 -2
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacement.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginReplacementSpec.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTemplates.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/PluginTo.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplateSet.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/type-aliases/TemplatesOption.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/exportedSetSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/replaceOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/replacementSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/rootTemplatesSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/templateSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/schema/variables/templatesSchema.md +1 -1
- package/api/@wtf/semantic-release-replace/variables/default.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/skipPlugins.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/stepId.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainAssets.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainChangelog.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainOfTag.md +1 -1
- package/api/@wtf/semantic-release-trains/config/functions/trainTagFormat.md +1 -1
- package/api/@wtf/semantic-release-trains/config/interfaces/AssetsOptions.md +4 -4
- package/api/@wtf/semantic-release-trains/config/interfaces/SkipOptions.md +3 -3
- package/api/@wtf/semantic-release-trains/config/variables/BRANCHES.md +1 -1
- package/api/@wtf/semantic-release-trains/config/variables/BREAKING.md +1 -1
- package/api/@wtf/semantic-release-trains/config/variables/TITLE.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/skipRuleOf.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/skips.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/functions/trainOptionsOf.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/interfaces/SkipContext.md +5 -5
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/SkipCheck.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/TrainOptions.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/SKIP_RULES.md +1 -1
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_OPTIONS.md +4 -3
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_SKIP.md +1 -1
- package/api/@wtf/semantic-release-trains/errors/type-aliases/PluginErrorCode.md +1 -1
- package/api/@wtf/semantic-release-trains/errors/variables/PLUGIN_ERRORS.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/decideTrain.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/dotenvOf.md +1 -1
- package/api/@wtf/semantic-release-trains/info/functions/infoOf.md +1 -1
- package/api/@wtf/semantic-release-trains/info/interfaces/DecideRun.md +4 -4
- package/api/@wtf/semantic-release-trains/info/interfaces/InfoRun.md +8 -8
- package/api/@wtf/semantic-release-trains/info/interfaces/TrainDecision.md +5 -5
- package/api/@wtf/semantic-release-trains/info/interfaces/TrainInfo.md +5 -5
- package/api/@wtf/semantic-release-trains/interfaces/TrainsEntryOptions.md +5 -5
- package/api/@wtf/semantic-release-trains/interfaces/TrainsOptions.md +7 -7
- package/api/@wtf/semantic-release-trains/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/pluginSpecSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/skipRuleSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/trainsEntrySchema.md +1 -1
- package/api/@wtf/semantic-release-trains/schema/variables/trainsPluginSchema.md +1 -1
- package/api/@wtf/semantic-release-trains/type-aliases/PluginSpec.md +1 -1
- package/api/@wtf/semantic-release-trains/type-aliases/TrainsPluginOptions.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/addChannel.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/analyzeCommits.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/default.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/fail.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/generateNotes.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/prepare.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/publish.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/success.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-trains/variables/verifyRelease.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/configOf.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/loadSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/functions/verifyConditions.md +1 -1
- package/api/@wtf/semantic-release-validate/interfaces/ValidatePluginOptions.md +2 -2
- package/api/@wtf/semantic-release-validate/schema/interfaces/Validator.md +2 -2
- package/api/@wtf/semantic-release-validate/schema/variables/configSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/schema/variables/jsonSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/schema/variables/validateOptionsSchema.md +1 -1
- package/api/@wtf/semantic-release-validate/variables/default.md +1 -1
- package/guides/changelogs.md +39 -28
- package/guides/ci-recipes.md +393 -271
- package/guides/configuring-trains.md +291 -203
- package/guides/dependency-rules.md +171 -113
- package/guides/ecosystems.md +222 -156
- package/guides/getting-started.md +135 -69
- package/guides/publishing-crates.md +208 -143
- package/guides/publishing-go-modules.md +170 -110
- package/guides/publishing-maven.md +197 -123
- package/guides/publishing.md +278 -191
- package/guides/system.md +50 -34
- package/guides/troubleshooting.md +358 -92
- package/guides/validating-a-config.md +68 -49
- package/package.json +3 -3
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ValidateError
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-validate/src/errors.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-validate/src/errors.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/errors.ts#L24)
|
|
10
10
|
|
|
11
11
|
An error of the validation of a config: a stable `code`, its `message` what is wrong, and its
|
|
12
12
|
`details` how to fix it. semantic-release prints it as a `SemanticReleaseError`.
|
|
@@ -21,7 +21,7 @@ An error of the validation of a config: a stable `code`, its `message` what is w
|
|
|
21
21
|
|
|
22
22
|
> **new ValidateError**(`code`, `message`, `details`): `ValidateError`
|
|
23
23
|
|
|
24
|
-
Defined in: [packages/release-validate/src/errors.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
24
|
+
Defined in: [packages/release-validate/src/errors.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/errors.ts#L40)
|
|
25
25
|
|
|
26
26
|
An error of the validation of a config, of its code, what is wrong and how to fix it, named
|
|
27
27
|
`SemanticReleaseError` as semantic-release's own.
|
|
@@ -72,7 +72,7 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
|
|
|
72
72
|
|
|
73
73
|
> `readonly` **code**: `"ECONFIG"` \| `"ESCHEMA"`
|
|
74
74
|
|
|
75
|
-
Defined in: [packages/release-validate/src/errors.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
75
|
+
Defined in: [packages/release-validate/src/errors.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/errors.ts#L26)
|
|
76
76
|
|
|
77
77
|
The stable code of the error, as `ECONFIG`.
|
|
78
78
|
|
|
@@ -82,7 +82,7 @@ The stable code of the error, as `ECONFIG`.
|
|
|
82
82
|
|
|
83
83
|
> `readonly` **details**: `string`
|
|
84
84
|
|
|
85
|
-
Defined in: [packages/release-validate/src/errors.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
85
|
+
Defined in: [packages/release-validate/src/errors.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/errors.ts#L28)
|
|
86
86
|
|
|
87
87
|
How to fix it.
|
|
88
88
|
|
|
@@ -116,7 +116,7 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
|
|
|
116
116
|
|
|
117
117
|
> `readonly` **semanticRelease**: `true`
|
|
118
118
|
|
|
119
|
-
Defined in: [packages/release-validate/src/errors.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
119
|
+
Defined in: [packages/release-validate/src/errors.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/errors.ts#L30)
|
|
120
120
|
|
|
121
121
|
The mark semantic-release prints an error of a plugin by.
|
|
122
122
|
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **ValidateErrorCode** = keyof *typeof* [`VALIDATE_ERRORS`](../variables/VALIDATE_ERRORS.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/errors.ts:18](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/errors.ts:18](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/errors.ts#L18)
|
|
12
12
|
|
|
13
13
|
A code of [VALIDATE\_ERRORS](../variables/VALIDATE_ERRORS.md).
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **VALIDATE\_ERRORS**: `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/errors.ts:12](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/errors.ts:12](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/errors.ts#L12)
|
|
12
12
|
|
|
13
13
|
The codes of the errors of a validation, each with what it means.
|
|
14
14
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ConfigIssue
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-validate/src/index.ts:25](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-validate/src/index.ts:25](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/index.ts#L25)
|
|
10
10
|
|
|
11
11
|
What is wrong with a config, and where.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ What is wrong with a config, and where.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **at**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-validate/src/index.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-validate/src/index.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/index.ts#L31)
|
|
20
20
|
|
|
21
21
|
Where, as a reader writes it: `plugins[2][1].access`, or `the config` of none.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ Where, as a reader writes it: `plugins[2][1].access`, or `the config` of none.
|
|
|
26
26
|
|
|
27
27
|
> `readonly` **message**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-validate/src/index.ts:27](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-validate/src/index.ts:27](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/index.ts#L27)
|
|
30
30
|
|
|
31
31
|
What is wrong, as the schema says it.
|
|
32
32
|
|
|
@@ -36,6 +36,6 @@ What is wrong, as the schema says it.
|
|
|
36
36
|
|
|
37
37
|
> `readonly` **path**: readonly `PropertyKey`[]
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/release-validate/src/index.ts:29](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
39
|
+
Defined in: [packages/release-validate/src/index.ts:29](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/index.ts#L29)
|
|
40
40
|
|
|
41
41
|
Where, in the config: each key, and each index of an array.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **fromJsonSchema**(`schema`, `compile`): `StandardSchemaV1`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/json-schema.ts:82](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/json-schema.ts:82](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/json-schema.ts#L82)
|
|
12
12
|
|
|
13
13
|
A Standard Schema of the JSON Schema `schema`, by `compile`, the engine's, which compiles it
|
|
14
14
|
once: each error of the engine an issue, its `instancePath` its path. A value the engine finds
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **pathOfPointer**(`pointer`): (`string` \| `number`)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/json-schema.ts:56](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/json-schema.ts:56](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/json-schema.ts#L56)
|
|
12
12
|
|
|
13
13
|
The path of an issue of the JSON Pointer `pointer`: each key, and each index a number.
|
|
14
14
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: JsonSchemaError
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-validate/src/json-schema.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-validate/src/json-schema.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/json-schema.ts#L24)
|
|
10
10
|
|
|
11
11
|
An error of a validator of a JSON Schema, as Ajv gives it: where, and what.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ An error of a validator of a JSON Schema, as Ajv gives it: where, and what.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **instancePath**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/release-validate/src/json-schema.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/release-validate/src/json-schema.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/json-schema.ts#L26)
|
|
20
20
|
|
|
21
21
|
Where, in the value: a JSON Pointer, as `/plugins/2/1/access`, or `''` of the value.
|
|
22
22
|
|
|
@@ -26,6 +26,6 @@ Where, in the value: a JSON Pointer, as `/plugins/2/1/access`, or `''` of the va
|
|
|
26
26
|
|
|
27
27
|
> `readonly` `optional` **message?**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/release-validate/src/json-schema.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/release-validate/src/json-schema.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/json-schema.ts#L28)
|
|
30
30
|
|
|
31
31
|
What is wrong.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: JsonSchemaValidator()
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/release-validate/src/json-schema.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/release-validate/src/json-schema.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/json-schema.ts#L36)
|
|
10
10
|
|
|
11
11
|
A validator of a JSON Schema, as Ajv's `compile` gives it: whether a value is valid, and the
|
|
12
12
|
errors of the last value it found not valid. An async validator, of a schema of `$async`, gives a
|
|
@@ -14,7 +14,7 @@ promise that rejects with an error of `errors`.
|
|
|
14
14
|
|
|
15
15
|
> **JsonSchemaValidator**(`value`): `boolean` \| `Promise`\<`unknown`\>
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/release-validate/src/json-schema.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
17
|
+
Defined in: [packages/release-validate/src/json-schema.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/json-schema.ts#L45)
|
|
18
18
|
|
|
19
19
|
Whether `value` is valid: of a sync validator, a boolean; of an async one, a promise that
|
|
20
20
|
rejects of a value not valid.
|
|
@@ -40,6 +40,6 @@ with an error of `errors` of one not valid.
|
|
|
40
40
|
|
|
41
41
|
> `readonly` `optional` **errors?**: readonly [`JsonSchemaError`](JsonSchemaError.md)[] \| `null`
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/release-validate/src/json-schema.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
43
|
+
Defined in: [packages/release-validate/src/json-schema.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/json-schema.ts#L47)
|
|
44
44
|
|
|
45
45
|
The errors of the last value found not valid.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **configErrors**(`schema`, `config`, `name?`): `Promise`\<[`ValidateError`](../../errors/classes/ValidateError.md)[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/validate.ts:109](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/validate.ts:109](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/validate.ts#L109)
|
|
12
12
|
|
|
13
13
|
The errors of the issues of `config` by `schema`, each `ECONFIG` of where it is, as `name` says
|
|
14
14
|
the schema: none of a config it finds valid.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **isStandardSchema**(`value`): `value is StandardSchemaV1<unknown, unknown>`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/validate.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/validate.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/validate.ts#L43)
|
|
12
12
|
|
|
13
13
|
Whether `value` is a Standard Schema, of version 1.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **pathText**(`path`): `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/validate.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/validate.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/validate.ts#L63)
|
|
12
12
|
|
|
13
13
|
`path`, as a reader writes it: `plugins[2][1].access`, or `the config` of none.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **validateConfig**(`schema`, `config`): `Promise`\<[`ConfigIssue`](../../interfaces/ConfigIssue.md)[]\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/release-validate/src/validate.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/release-validate/src/validate.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-validate/src/validate.ts#L80)
|
|
12
12
|
|
|
13
13
|
The issues of `config` by `schema`, a Standard Schema, whose validation is sync or async: none
|
|
14
14
|
of a config it finds valid. Throws `ESCHEMA` of a schema that is none.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **indexLookup**(`index`, `name`, `version`): `Promise`\<`boolean`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:176](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:176](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L176)
|
|
12
12
|
|
|
13
13
|
Asks the sparse index `index` whether it has `name` at `version`, by `fetch`: of no file, a crate
|
|
14
14
|
that was never published.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **prepare**(`pluginConfig`, `context`): `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:431](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:431](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L431)
|
|
12
12
|
|
|
13
13
|
Writes the version of the release into the crates of the train, and the last release of each other
|
|
14
14
|
train into its crates, and each into the dependencies on them; and reads the workspace again: a
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **publish**(`pluginConfig`, `context`): `Promise`\<`false` \| [`CargoRelease`](../interfaces/CargoRelease.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:461](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:461](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L461)
|
|
12
12
|
|
|
13
13
|
Publishes each crate of the release the registry lacks, in the order of their dependencies, at the
|
|
14
14
|
version of the release; each the registry has already is skipped.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **verifyConditions**(`pluginConfig`, `context`): `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:382](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:382](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L382)
|
|
12
12
|
|
|
13
13
|
Checks the options of the plugin, by `cargoSchema` of `./schema` (`EOPTIONS`), that `ecosystems`
|
|
14
14
|
lists `@wtf/semantic-release-cargo/ecosystem` or `@wtf/release-cargo` (`ECARGOECOSYSTEM`), and the train of the run (`ETRAINNOTSELECTED`,
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: CargoPluginOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L95)
|
|
10
10
|
|
|
11
11
|
The options of the plugin, in the config of semantic-release or at its root.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ The options of the plugin, in the config of semantic-release or at its root.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **ecosystems**: readonly `string`[]
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L103)
|
|
20
20
|
|
|
21
21
|
The ecosystems of the repo, of the root of the config, which the trains read the packages of:
|
|
22
22
|
`'@wtf/semantic-release-cargo/ecosystem'` or `'@wtf/release-cargo'` among them, or `verifyConditions` fails (`ECARGOECOSYSTEM`), as the
|
|
@@ -28,7 +28,7 @@ trains would read no crate this plugin publishes.
|
|
|
28
28
|
|
|
29
29
|
> `readonly` `optional` **exclude?**: readonly `string`[]
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:109](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
31
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:109](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L109)
|
|
32
32
|
|
|
33
33
|
The crates of the train not to publish, by name, as an example.
|
|
34
34
|
|
|
@@ -38,7 +38,7 @@ The crates of the train not to publish, by name, as an example.
|
|
|
38
38
|
|
|
39
39
|
> `readonly` `optional` **idToken?**: `string`
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:126](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
41
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:126](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L126)
|
|
42
42
|
|
|
43
43
|
The variable of the environment that holds the ID token of the job, for trusted publishing:
|
|
44
44
|
`CRATES_IO_ID_TOKEN`.
|
|
@@ -49,7 +49,7 @@ The variable of the environment that holds the ID token of the job, for trusted
|
|
|
49
49
|
|
|
50
50
|
> `readonly` `optional` **include?**: readonly `string`[]
|
|
51
51
|
|
|
52
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:107](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
52
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:107](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L107)
|
|
53
53
|
|
|
54
54
|
The crates of the train to publish, by name: every crate of it that may be published by default.
|
|
55
55
|
|
|
@@ -59,7 +59,7 @@ The crates of the train to publish, by name: every crate of it that may be publi
|
|
|
59
59
|
|
|
60
60
|
> `readonly` `optional` **index?**: `string`
|
|
61
61
|
|
|
62
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:119](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
62
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:119](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L119)
|
|
63
63
|
|
|
64
64
|
The base URL of the sparse index of the registry, which the plugin asks which versions exist:
|
|
65
65
|
`https://index.crates.io` by default, and required of a `registry` that is not crates.io.
|
|
@@ -70,7 +70,7 @@ The base URL of the sparse index of the registry, which the plugin asks which ve
|
|
|
70
70
|
|
|
71
71
|
> `readonly` `optional` **registry?**: `string`
|
|
72
72
|
|
|
73
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:114](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
73
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:114](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L114)
|
|
74
74
|
|
|
75
75
|
The registry, by the name of `.cargo/config.toml`: crates.io by default, which `crates-io`
|
|
76
76
|
names too.
|
|
@@ -81,7 +81,7 @@ names too.
|
|
|
81
81
|
|
|
82
82
|
> `readonly` `optional` **registryApi?**: `string`
|
|
83
83
|
|
|
84
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:131](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
84
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:131](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L131)
|
|
85
85
|
|
|
86
86
|
The base URL of the API of the registry, where the ID token is exchanged: `https://crates.io`.
|
|
87
87
|
Required of an ID token and a `registry` that is not crates.io.
|
|
@@ -92,7 +92,7 @@ Required of an ID token and a `registry` that is not crates.io.
|
|
|
92
92
|
|
|
93
93
|
> `readonly` `optional` **system?**: [`SystemInput`](../../release-system/system/type-aliases/SystemInput.md)
|
|
94
94
|
|
|
95
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:133](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
95
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:133](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L133)
|
|
96
96
|
|
|
97
97
|
The system the plugin runs by, over Node's.
|
|
98
98
|
|
|
@@ -102,7 +102,7 @@ The system the plugin runs by, over Node's.
|
|
|
102
102
|
|
|
103
103
|
> `readonly` `optional` **train?**: `string`
|
|
104
104
|
|
|
105
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:105](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
105
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:105](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L105)
|
|
106
106
|
|
|
107
107
|
The train of the run: `RELEASE_TRAIN` of the environment of the run by default.
|
|
108
108
|
|
|
@@ -112,7 +112,7 @@ The train of the run: `RELEASE_TRAIN` of the environment of the run by default.
|
|
|
112
112
|
|
|
113
113
|
> `readonly` **trains**: [`Trains`](../../release-trains/type-aliases/Trains.md)
|
|
114
114
|
|
|
115
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
115
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L97)
|
|
116
116
|
|
|
117
117
|
Every train of the repo: the crates of each are those whose folder its paths hold.
|
|
118
118
|
|
|
@@ -122,6 +122,6 @@ Every train of the repo: the crates of each are those whose folder its paths hol
|
|
|
122
122
|
|
|
123
123
|
> `readonly` `optional` **verify?**: `boolean`
|
|
124
124
|
|
|
125
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
125
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L121)
|
|
126
126
|
|
|
127
127
|
Whether cargo builds each crate before it publishes it: `true`.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: CargoRelease
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:137](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:137](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L137)
|
|
10
10
|
|
|
11
11
|
The release the plugin gives semantic-release of the crates published.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ The release the plugin gives semantic-release of the crates published.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **name**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:139](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:139](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L139)
|
|
20
20
|
|
|
21
21
|
The crates named, as `crates.io (a, b)`.
|
|
22
22
|
|
|
@@ -26,6 +26,6 @@ The crates named, as `crates.io (a, b)`.
|
|
|
26
26
|
|
|
27
27
|
> `readonly` `optional` **url?**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:141](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:141](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L141)
|
|
30
30
|
|
|
31
31
|
The page of the first crate that has one.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> **CargoOptions** = `Omit`\<[`CargoPluginOptions`](../../interfaces/CargoPluginOptions.md), `"train"` \| `"trains"` \| `"ecosystems"` \| `"system"`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-cargo/src/schema.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-cargo/src/schema.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/schema.ts#L40)
|
|
12
12
|
|
|
13
13
|
The options of an entry of the plugin, its own: every one of the options but those of the root.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **cargoOptionsSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`CargoOptions`](../type-aliases/CargoOptions.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-cargo/src/schema.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-cargo/src/schema.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/schema.ts#L43)
|
|
12
12
|
|
|
13
13
|
The validator of the options of an entry of the plugin, its own.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **cargoSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`RootOptions`](../../../release-trains/schema/interfaces/RootOptions.md) & [`CargoOptions`](../type-aliases/CargoOptions.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-cargo/src/schema.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-cargo/src/schema.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/schema.ts#L57)
|
|
12
12
|
|
|
13
13
|
The validator of the options the plugin is given: the root's, `trains` and `ecosystems` required,
|
|
14
14
|
and its own.
|
|
@@ -8,6 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **configSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<`object`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-cargo/src/schema.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-cargo/src/schema.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/schema.ts#L63)
|
|
12
12
|
|
|
13
13
|
This package's part of a whole config of semantic-release: each entry of `plugins` of the plugin.
|
|
@@ -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-cargo/src/schema.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-cargo/src/schema.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/schema.ts#L69)
|
|
12
12
|
|
|
13
13
|
The JSON Schema of [configSchema](configSchema.md), as the package publishes it, `schema.json`.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **default**: `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-cargo/src/index.ts:503](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-cargo/src/index.ts:503](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-cargo/src/index.ts#L503)
|
|
12
12
|
|
|
13
13
|
## Type Declaration
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **prepare**(`pluginConfig`, `context`): `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-go/src/index.ts:282](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-go/src/index.ts:282](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L282)
|
|
12
12
|
|
|
13
13
|
Checks the majors again, writes the version of the release into each require of a module of the
|
|
14
14
|
train, and the last release of each other train into each require of its modules, in every go.mod
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **publish**(`pluginConfig`, `context`): `Promise`\<`false` \| [`GoRelease`](../interfaces/GoRelease.md)\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-go/src/index.ts:313](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-go/src/index.ts:313](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L313)
|
|
12
12
|
|
|
13
13
|
Tags the modules of the release: a commit of the stamped go.mod files on top of `HEAD`, on no
|
|
14
14
|
branch, tagged with the tag of each module the remote lacks, and the tags pushed to
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **verifyConditions**(`pluginConfig`, `context`): `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-go/src/index.ts:237](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-go/src/index.ts:237](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L237)
|
|
12
12
|
|
|
13
13
|
Checks the options of the plugin, by `goSchema` of `./schema` (`EOPTIONS`), that `ecosystems`
|
|
14
14
|
lists `@wtf/semantic-release-go/ecosystem` or `@wtf/release-go` (`EGOECOSYSTEM`), and the train of
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **verifyRelease**(`pluginConfig`, `context`): `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/semantic-release-go/src/index.ts:260](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
11
|
+
Defined in: [packages/semantic-release-go/src/index.ts:260](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L260)
|
|
12
12
|
|
|
13
13
|
Checks the path of each module of the release against the major of its version, which semantic-
|
|
14
14
|
release knows by this step: from v2 on, Go needs the path to end in `/v<major>`, and a path that
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: GoPluginOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-go/src/index.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/semantic-release-go/src/index.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L78)
|
|
10
10
|
|
|
11
11
|
The options of the plugin, in the config of semantic-release or at its root.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ The options of the plugin, in the config of semantic-release or at its root.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **ecosystems**: readonly `string`[]
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/semantic-release-go/src/index.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/semantic-release-go/src/index.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L86)
|
|
20
20
|
|
|
21
21
|
The ecosystems of the repo, of the root of the config, which the trains read the packages of:
|
|
22
22
|
`'@wtf/semantic-release-go/ecosystem'` or `'@wtf/release-go'` among them, or
|
|
@@ -28,7 +28,7 @@ The ecosystems of the repo, of the root of the config, which the trains read the
|
|
|
28
28
|
|
|
29
29
|
> `readonly` `optional` **exclude?**: readonly `string`[]
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/semantic-release-go/src/index.ts:94](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
31
|
+
Defined in: [packages/semantic-release-go/src/index.ts:94](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L94)
|
|
32
32
|
|
|
33
33
|
The modules of the train not to tag, by path, as an example.
|
|
34
34
|
|
|
@@ -38,7 +38,7 @@ The modules of the train not to tag, by path, as an example.
|
|
|
38
38
|
|
|
39
39
|
> `readonly` `optional` **include?**: readonly `string`[]
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/semantic-release-go/src/index.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
41
|
+
Defined in: [packages/semantic-release-go/src/index.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L92)
|
|
42
42
|
|
|
43
43
|
The modules of the train to tag, by path: every module of it that Go can fetch by default.
|
|
44
44
|
|
|
@@ -48,7 +48,7 @@ The modules of the train to tag, by path: every module of it that Go can fetch b
|
|
|
48
48
|
|
|
49
49
|
> `readonly` `optional` **proxy?**: `boolean`
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/semantic-release-go/src/index.ts:99](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
51
|
+
Defined in: [packages/semantic-release-go/src/index.ts:99](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L99)
|
|
52
52
|
|
|
53
53
|
Whether `publish` asks the Go proxy for each module at its version once its tag is pushed:
|
|
54
54
|
`false`, as the public proxy cannot fetch a private repo.
|
|
@@ -59,7 +59,7 @@ Whether `publish` asks the Go proxy for each module at its version once its tag
|
|
|
59
59
|
|
|
60
60
|
> `readonly` `optional` **system?**: [`SystemInput`](../../release-system/system/type-aliases/SystemInput.md)
|
|
61
61
|
|
|
62
|
-
Defined in: [packages/semantic-release-go/src/index.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
62
|
+
Defined in: [packages/semantic-release-go/src/index.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L101)
|
|
63
63
|
|
|
64
64
|
The system the plugin runs by, over Node's.
|
|
65
65
|
|
|
@@ -69,7 +69,7 @@ The system the plugin runs by, over Node's.
|
|
|
69
69
|
|
|
70
70
|
> `readonly` `optional` **train?**: `string`
|
|
71
71
|
|
|
72
|
-
Defined in: [packages/semantic-release-go/src/index.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
72
|
+
Defined in: [packages/semantic-release-go/src/index.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L88)
|
|
73
73
|
|
|
74
74
|
The train of the run: `RELEASE_TRAIN` of the environment of the run by default.
|
|
75
75
|
|
|
@@ -79,6 +79,6 @@ The train of the run: `RELEASE_TRAIN` of the environment of the run by default.
|
|
|
79
79
|
|
|
80
80
|
> `readonly` **trains**: [`Trains`](../../release-trains/type-aliases/Trains.md)
|
|
81
81
|
|
|
82
|
-
Defined in: [packages/semantic-release-go/src/index.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
82
|
+
Defined in: [packages/semantic-release-go/src/index.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L80)
|
|
83
83
|
|
|
84
84
|
Every train of the repo: the modules of each are those whose folder its paths hold.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: GoRelease
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/semantic-release-go/src/index.ts:105](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
9
|
+
Defined in: [packages/semantic-release-go/src/index.ts:105](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L105)
|
|
10
10
|
|
|
11
11
|
The release the plugin gives semantic-release of the modules tagged.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ The release the plugin gives semantic-release of the modules tagged.
|
|
|
16
16
|
|
|
17
17
|
> `readonly` **name**: `string`
|
|
18
18
|
|
|
19
|
-
Defined in: [packages/semantic-release-go/src/index.ts:107](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
19
|
+
Defined in: [packages/semantic-release-go/src/index.ts:107](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L107)
|
|
20
20
|
|
|
21
21
|
The modules named, as `Go modules (example.com/a, example.com/b)`.
|
|
22
22
|
|
|
@@ -26,6 +26,6 @@ The modules named, as `Go modules (example.com/a, example.com/b)`.
|
|
|
26
26
|
|
|
27
27
|
> `readonly` `optional` **url?**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/semantic-release-go/src/index.ts:109](https://gitlab.com/wetryfun/release/release/-/blob/
|
|
29
|
+
Defined in: [packages/semantic-release-go/src/index.ts:109](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/semantic-release-go/src/index.ts#L109)
|
|
30
30
|
|
|
31
31
|
The page of the first module on pkg.go.dev, of a release that asked the proxy.
|