@wtf/release-docs 8.1.0 → 8.2.1
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 +12 -4
- package/api/.generated +155 -29
- 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 +5 -4
- 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 +2 -2
- 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/README.md +34 -0
- package/api/@wtf/release-go/ecosystem/README.md +40 -0
- package/api/@wtf/release-go/ecosystem/functions/packagesOfModules.md +30 -0
- package/api/@wtf/release-go/ecosystem/functions/packagesOfRepo.md +32 -0
- package/api/@wtf/release-go/ecosystem/functions/resolveVersion.md +35 -0
- package/api/@wtf/release-go/ecosystem/functions/satisfiesVersion.md +35 -0
- package/api/@wtf/release-go/ecosystem/interfaces/GoPackage.md +97 -0
- package/api/@wtf/release-go/ecosystem/variables/goEcosystem.md +15 -0
- package/api/@wtf/release-go/errors/README.md +25 -0
- package/api/@wtf/release-go/errors/classes/GoError.md +268 -0
- package/api/@wtf/release-go/errors/type-aliases/GoErrorCode.md +13 -0
- package/api/@wtf/release-go/errors/variables/GO_ERRORS.md +47 -0
- package/api/@wtf/release-go/gomod/README.md +39 -0
- package/api/@wtf/release-go/gomod/functions/entriesOf.md +29 -0
- package/api/@wtf/release-go/gomod/functions/linesOf.md +27 -0
- package/api/@wtf/release-go/gomod/functions/readGoMod.md +28 -0
- package/api/@wtf/release-go/gomod/functions/tokensOf.md +29 -0
- package/api/@wtf/release-go/gomod/interfaces/Entry.md +41 -0
- package/api/@wtf/release-go/gomod/interfaces/GoMod.md +41 -0
- package/api/@wtf/release-go/gomod/interfaces/GoReplace.md +61 -0
- package/api/@wtf/release-go/gomod/interfaces/GoRequire.md +41 -0
- package/api/@wtf/release-go/gomod/interfaces/Token.md +51 -0
- package/api/@wtf/release-go/interfaces/GoModule.md +61 -0
- package/api/@wtf/release-go/modules/README.md +39 -0
- package/api/@wtf/release-go/modules/functions/isFetchable.md +28 -0
- package/api/@wtf/release-go/modules/functions/isGoMod.md +28 -0
- package/api/@wtf/release-go/modules/functions/majorErrors.md +37 -0
- package/api/@wtf/release-go/modules/functions/majorOfPath.md +28 -0
- package/api/@wtf/release-go/modules/functions/modulesAt.md +39 -0
- package/api/@wtf/release-go/modules/functions/modulesOf.md +29 -0
- package/api/@wtf/release-go/modules/functions/readModules.md +33 -0
- package/api/@wtf/release-go/modules/functions/selectModules.md +44 -0
- package/api/@wtf/release-go/modules/interfaces/Selection.md +43 -0
- package/api/@wtf/release-go/stamp/README.md +44 -0
- package/api/@wtf/release-go/stamp/functions/checkVersions.md +38 -0
- package/api/@wtf/release-go/stamp/functions/stampGoMod.md +35 -0
- package/api/@wtf/release-go/stamp/functions/stampModules.md +42 -0
- package/api/@wtf/release-go/stamp/interfaces/Stamped.md +31 -0
- package/api/@wtf/release-go/stamp/interfaces/StampedModules.md +31 -0
- package/api/@wtf/release-go/tags/README.md +48 -0
- package/api/@wtf/release-go/tags/functions/askProxy.md +44 -0
- package/api/@wtf/release-go/tags/functions/maskCredentials.md +28 -0
- package/api/@wtf/release-go/tags/functions/releaseCommit.md +48 -0
- package/api/@wtf/release-go/tags/functions/remoteTags.md +43 -0
- package/api/@wtf/release-go/tags/functions/tagModules.md +36 -0
- package/api/@wtf/release-go/tags/functions/tagOfModule.md +34 -0
- package/api/@wtf/release-go/tags/functions/tagPrefix.md +29 -0
- package/api/@wtf/release-go/tags/interfaces/TagModulesOptions.md +93 -0
- package/api/@wtf/release-go/tags/interfaces/TaggedModule.md +51 -0
- package/api/@wtf/release-go/tags/type-aliases/ModuleStatus.md +13 -0
- package/api/@wtf/release-go/tags/variables/RELEASE_AUTHOR.md +23 -0
- package/api/@wtf/release-maven/README.md +33 -0
- package/api/@wtf/release-maven/artifacts/README.md +41 -0
- package/api/@wtf/release-maven/artifacts/functions/groupIdOf.md +33 -0
- package/api/@wtf/release-maven/artifacts/functions/installsOf.md +44 -0
- package/api/@wtf/release-maven/artifacts/functions/isPomFile.md +28 -0
- package/api/@wtf/release-maven/artifacts/functions/isRange.md +27 -0
- package/api/@wtf/release-maven/artifacts/functions/modulesOf.md +44 -0
- package/api/@wtf/release-maven/artifacts/functions/nameOf.md +33 -0
- package/api/@wtf/release-maven/artifacts/functions/publishOrder.md +34 -0
- package/api/@wtf/release-maven/artifacts/functions/readModules.md +31 -0
- package/api/@wtf/release-maven/artifacts/functions/readPoms.md +32 -0
- package/api/@wtf/release-maven/artifacts/functions/selectArtifacts.md +44 -0
- package/api/@wtf/release-maven/artifacts/interfaces/Selection.md +42 -0
- package/api/@wtf/release-maven/ecosystem/README.md +41 -0
- package/api/@wtf/release-maven/ecosystem/functions/compareVersions.md +38 -0
- package/api/@wtf/release-maven/ecosystem/functions/parseRange.md +28 -0
- package/api/@wtf/release-maven/ecosystem/functions/resolveVersion.md +36 -0
- package/api/@wtf/release-maven/ecosystem/functions/satisfiesVersion.md +36 -0
- package/api/@wtf/release-maven/ecosystem/interfaces/Bound.md +31 -0
- package/api/@wtf/release-maven/ecosystem/interfaces/Restriction.md +31 -0
- package/api/@wtf/release-maven/ecosystem/variables/mavenEcosystem.md +15 -0
- package/api/@wtf/release-maven/errors/README.md +25 -0
- package/api/@wtf/release-maven/errors/classes/MavenError.md +268 -0
- package/api/@wtf/release-maven/errors/type-aliases/MavenErrorCode.md +13 -0
- package/api/@wtf/release-maven/errors/variables/MAVEN_ERRORS.md +51 -0
- package/api/@wtf/release-maven/interfaces/MavenModule.md +169 -0
- package/api/@wtf/release-maven/pom/README.md +48 -0
- package/api/@wtf/release-maven/pom/functions/childOf.md +33 -0
- package/api/@wtf/release-maven/pom/functions/childrenOf.md +33 -0
- package/api/@wtf/release-maven/pom/functions/dependencyOf.md +27 -0
- package/api/@wtf/release-maven/pom/functions/escapeXml.md +27 -0
- package/api/@wtf/release-maven/pom/functions/parseXml.md +39 -0
- package/api/@wtf/release-maven/pom/functions/readPom.md +39 -0
- package/api/@wtf/release-maven/pom/functions/textAt.md +34 -0
- package/api/@wtf/release-maven/pom/interfaces/Pom.md +151 -0
- package/api/@wtf/release-maven/pom/interfaces/PomDependency.md +51 -0
- package/api/@wtf/release-maven/pom/interfaces/PomParent.md +41 -0
- package/api/@wtf/release-maven/pom/interfaces/PomPlugin.md +51 -0
- package/api/@wtf/release-maven/pom/interfaces/PomRepository.md +31 -0
- package/api/@wtf/release-maven/pom/interfaces/Span.md +35 -0
- package/api/@wtf/release-maven/pom/interfaces/XmlElement.md +83 -0
- package/api/@wtf/release-maven/pom/variables/PLUGIN_GROUP.md +13 -0
- package/api/@wtf/release-maven/publish/README.md +45 -0
- package/api/@wtf/release-maven/publish/functions/deployModules.md +35 -0
- package/api/@wtf/release-maven/publish/interfaces/DeployModulesOptions.md +146 -0
- package/api/@wtf/release-maven/publish/interfaces/DeployedModule.md +42 -0
- package/api/@wtf/release-maven/publish/type-aliases/ModuleStatus.md +13 -0
- package/api/@wtf/release-maven/repository/README.md +38 -0
- package/api/@wtf/release-maven/repository/functions/deployTargets.md +46 -0
- package/api/@wtf/release-maven/repository/functions/expandValues.md +42 -0
- package/api/@wtf/release-maven/repository/functions/hasPom.md +38 -0
- package/api/@wtf/release-maven/repository/functions/pomPath.md +40 -0
- package/api/@wtf/release-maven/repository/functions/pomUrl.md +45 -0
- package/api/@wtf/release-maven/repository/interfaces/Repository.md +31 -0
- package/api/@wtf/release-maven/repository/interfaces/ValuesOf.md +31 -0
- package/api/@wtf/release-maven/repository/variables/MAVEN_CENTRAL.md +13 -0
- package/api/@wtf/release-maven/stamp/README.md +50 -0
- package/api/@wtf/release-maven/stamp/functions/checkVersions.md +36 -0
- package/api/@wtf/release-maven/stamp/functions/stampModules.md +55 -0
- package/api/@wtf/release-maven/stamp/functions/stampPom.md +45 -0
- package/api/@wtf/release-maven/stamp/interfaces/PomStampOptions.md +51 -0
- package/api/@wtf/release-maven/stamp/interfaces/Stamped.md +31 -0
- package/api/@wtf/release-maven/stamp/interfaces/StampedModules.md +31 -0
- 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 +7 -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 +8 -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/README.md +73 -0
- package/api/@wtf/semantic-release-go/functions/prepare.md +41 -0
- package/api/@wtf/semantic-release-go/functions/publish.md +43 -0
- package/api/@wtf/semantic-release-go/functions/verifyConditions.md +37 -0
- package/api/@wtf/semantic-release-go/functions/verifyRelease.md +38 -0
- package/api/@wtf/semantic-release-go/interfaces/GoPluginOptions.md +84 -0
- package/api/@wtf/semantic-release-go/interfaces/GoRelease.md +31 -0
- package/api/@wtf/semantic-release-go/schema/README.md +37 -0
- package/api/@wtf/semantic-release-go/schema/type-aliases/GoOptions.md +13 -0
- package/api/@wtf/{semantic-release-trains-changelog → semantic-release-go}/schema/variables/configSchema.md +2 -2
- package/api/@wtf/semantic-release-go/schema/variables/goOptionsSchema.md +13 -0
- package/api/@wtf/semantic-release-go/schema/variables/goSchema.md +14 -0
- package/api/@wtf/{semantic-release-trains-changelog → semantic-release-go}/schema/variables/jsonSchema.md +2 -2
- package/api/@wtf/semantic-release-go/variables/default.md +144 -0
- package/api/@wtf/semantic-release-maven/README.md +74 -0
- package/api/@wtf/semantic-release-maven/functions/pomLookup.md +38 -0
- package/api/@wtf/semantic-release-maven/functions/prepare.md +41 -0
- package/api/@wtf/semantic-release-maven/functions/publish.md +43 -0
- package/api/@wtf/semantic-release-maven/functions/verifyConditions.md +40 -0
- package/api/@wtf/semantic-release-maven/interfaces/LookupAuth.md +32 -0
- package/api/@wtf/semantic-release-maven/interfaces/MavenPluginOptions.md +129 -0
- package/api/@wtf/semantic-release-maven/interfaces/MavenRelease.md +21 -0
- package/api/@wtf/semantic-release-maven/schema/README.md +38 -0
- package/api/@wtf/semantic-release-maven/schema/type-aliases/MavenOptions.md +13 -0
- package/api/@wtf/semantic-release-maven/schema/variables/configSchema.md +13 -0
- package/api/@wtf/semantic-release-maven/schema/variables/jsonSchema.md +13 -0
- package/api/@wtf/semantic-release-maven/schema/variables/mavenOptionsSchema.md +13 -0
- package/api/@wtf/semantic-release-maven/schema/variables/mavenSchema.md +14 -0
- package/api/@wtf/semantic-release-maven/variables/default.md +116 -0
- 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/README.md +11 -3
- 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 +3 -4
- 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 +14 -0
- package/api/@wtf/semantic-release-trains/defaults/README.md +42 -0
- package/api/@wtf/semantic-release-trains/defaults/functions/skipRuleOf.md +40 -0
- package/api/@wtf/semantic-release-trains/defaults/functions/skips.md +42 -0
- package/api/@wtf/semantic-release-trains/defaults/functions/trainOptionsOf.md +40 -0
- package/api/@wtf/semantic-release-trains/defaults/interfaces/SkipContext.md +59 -0
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/SkipCheck.md +35 -0
- package/api/@wtf/semantic-release-trains/defaults/type-aliases/TrainOptions.md +33 -0
- package/api/@wtf/semantic-release-trains/defaults/variables/SKIP_RULES.md +13 -0
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_OPTIONS.md +20 -0
- package/api/@wtf/semantic-release-trains/defaults/variables/TRAIN_SKIP.md +17 -0
- 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 +15 -8
- package/api/@wtf/semantic-release-trains/interfaces/TrainsOptions.md +7 -7
- package/api/@wtf/semantic-release-trains/schema/README.md +1 -0
- 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 +13 -0
- 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/api/README.md +20 -5
- package/api/trains.json +9 -3
- package/guides/changelogs.md +30 -123
- package/guides/ci-recipes.md +16 -13
- package/guides/configuring-trains.md +7 -4
- package/guides/ecosystems.md +46 -23
- package/guides/getting-started.md +4 -6
- package/guides/publishing-go-modules.md +208 -0
- package/guides/publishing-maven.md +293 -0
- package/guides/publishing.md +6 -5
- package/guides/system.md +2 -2
- package/guides/validating-a-config.md +7 -9
- package/package.json +12 -10
- package/api/@wtf/release-trains-changelog/README.md +0 -58
- package/api/@wtf/release-trains-changelog/render/README.md +0 -44
- package/api/@wtf/release-trains-changelog/render/functions/changelogSection.md +0 -35
- package/api/@wtf/release-trains-changelog/render/functions/parseCommit.md +0 -28
- package/api/@wtf/release-trains-changelog/render/functions/prependSection.md +0 -40
- package/api/@wtf/release-trains-changelog/render/functions/renderSection.md +0 -37
- package/api/@wtf/release-trains-changelog/render/interfaces/ChangelogCommit.md +0 -27
- package/api/@wtf/release-trains-changelog/render/interfaces/ParsedCommit.md +0 -53
- package/api/@wtf/release-trains-changelog/render/interfaces/RenderOptions.md +0 -65
- package/api/@wtf/release-trains-changelog/render/variables/DEFAULT_TYPES.md +0 -13
- package/api/@wtf/release-trains-changelog/render/variables/TITLE.md +0 -13
- package/api/@wtf/release-trains-changelog/write/README.md +0 -48
- package/api/@wtf/release-trains-changelog/write/functions/changelogErrors.md +0 -33
- package/api/@wtf/release-trains-changelog/write/functions/commitUrlOf.md +0 -29
- package/api/@wtf/release-trains-changelog/write/functions/writeChangelogs.md +0 -35
- package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogOptions.md +0 -68
- package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogRelease.md +0 -176
- package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogTarget.md +0 -146
- package/api/@wtf/release-trains-changelog/write/interfaces/WrittenChangelog.md +0 -37
- package/api/@wtf/semantic-release-trains-changelog/README.md +0 -47
- package/api/@wtf/semantic-release-trains-changelog/functions/prepare.md +0 -33
- package/api/@wtf/semantic-release-trains-changelog/functions/verifyConditions.md +0 -36
- package/api/@wtf/semantic-release-trains-changelog/interfaces/ChangelogPluginOptions.md +0 -126
- package/api/@wtf/semantic-release-trains-changelog/schema/README.md +0 -24
- package/api/@wtf/semantic-release-trains-changelog/schema/variables/changelogOptionsSchema.md +0 -13
- package/api/@wtf/semantic-release-trains-changelog/schema/variables/changelogSchema.md +0 -13
- package/api/@wtf/semantic-release-trains-changelog/variables/default.md +0 -68
package/guides/system.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# The system
|
|
2
2
|
|
|
3
|
-
Every function of the libraries, `@wtf/release-trains`, `@wtf/release-
|
|
4
|
-
`@wtf/release-
|
|
3
|
+
Every function of the libraries, `@wtf/release-trains`, `@wtf/release-npm` and
|
|
4
|
+
`@wtf/release-replace`, does its work outside itself through a
|
|
5
5
|
`System` of `@wtf/release-system`, the base they build on, which it requires and never makes of its
|
|
6
6
|
own: files, processes, the environment, the working folder, a folder of
|
|
7
7
|
temporary files, and the clock. None of their modules names Node. A plugin of semantic-release
|
|
@@ -3,14 +3,13 @@
|
|
|
3
3
|
Each package owns one part of a config of semantic-release, and checks it two ways: as a validator,
|
|
4
4
|
for code, and as a JSON Schema, for an editor. The parts compose into the schema of a whole config.
|
|
5
5
|
|
|
6
|
-
| Package
|
|
7
|
-
|
|
|
8
|
-
| `@wtf/release-trains`
|
|
9
|
-
| `@wtf/semantic-release-trains`
|
|
10
|
-
| `@wtf/semantic-release-
|
|
11
|
-
| `@wtf/semantic-release-
|
|
12
|
-
| `@wtf/semantic-release-
|
|
13
|
-
| `@wtf/semantic-release-replace` | The root `templates`, and its entries of `plugins` |
|
|
6
|
+
| Package | Its part of a config |
|
|
7
|
+
| -------------------------------- | ----------------------------------------------------------------- |
|
|
8
|
+
| `@wtf/release-trains` | The root `trains`, `train` and `dependencies` |
|
|
9
|
+
| `@wtf/semantic-release-trains` | Its entries of `plugins`, each of `wrap`, `generated`, or neither |
|
|
10
|
+
| `@wtf/semantic-release-npm` | Its entries of `plugins` |
|
|
11
|
+
| `@wtf/semantic-release-validate` | Its entries of `plugins` |
|
|
12
|
+
| `@wtf/semantic-release-replace` | The root `templates`, and its entries of `plugins` |
|
|
14
13
|
|
|
15
14
|
A part constrains only what it owns, an entry of `plugins` by the name of the plugin, as
|
|
16
15
|
`["@wtf/semantic-release-npm", { "access": "public" }]`, and takes anything else: the
|
|
@@ -28,7 +27,6 @@ by its file (`"$id": "schema.json"`) and refers to nothing outside itself. Compo
|
|
|
28
27
|
"allOf": [
|
|
29
28
|
{ "$ref": "./node_modules/@wtf/release-trains/schema.json" },
|
|
30
29
|
{ "$ref": "./node_modules/@wtf/semantic-release-trains/schema.json" },
|
|
31
|
-
{ "$ref": "./node_modules/@wtf/semantic-release-trains-changelog/schema.json" },
|
|
32
30
|
{ "$ref": "./node_modules/@wtf/semantic-release-npm/schema.json" },
|
|
33
31
|
{ "$ref": "./node_modules/@wtf/semantic-release-validate/schema.json" },
|
|
34
32
|
{ "$ref": "./node_modules/@wtf/semantic-release-replace/schema.json" }
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wtf/release-docs",
|
|
3
|
-
"version": "8.1
|
|
4
|
-
"description": "The guides of
|
|
3
|
+
"version": "8.2.1",
|
|
4
|
+
"description": "The guides of semantic-release for monorepos of more than one ecosystem, released in trains, and the API reference of its packages, which TypeDoc writes: the release of docs commits the reference and publishes it with the guides.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"documentation",
|
|
7
7
|
"semantic-release"
|
|
@@ -38,18 +38,20 @@
|
|
|
38
38
|
"devDependencies": {
|
|
39
39
|
"@standard-schema/spec": "^1.1.0",
|
|
40
40
|
"@types/node": "^24.10.0",
|
|
41
|
-
"@wtf/release-cargo": "3.1.
|
|
42
|
-
"@wtf/release-
|
|
41
|
+
"@wtf/release-cargo": "3.1.1",
|
|
42
|
+
"@wtf/release-go": "1.0.0",
|
|
43
|
+
"@wtf/release-maven": "1.0.0",
|
|
44
|
+
"@wtf/release-npm": "1.1.1",
|
|
43
45
|
"@wtf/release-replace": "4.0.0",
|
|
44
46
|
"@wtf/release-system": "1.0.1",
|
|
45
|
-
"@wtf/release-trains": "7.
|
|
46
|
-
"@wtf/release-trains-changelog": "7.0.0",
|
|
47
|
+
"@wtf/release-trains": "7.1.1",
|
|
47
48
|
"@wtf/release-validate": "4.0.0",
|
|
48
|
-
"@wtf/semantic-release-cargo": "3.1.
|
|
49
|
-
"@wtf/semantic-release-
|
|
49
|
+
"@wtf/semantic-release-cargo": "3.1.1",
|
|
50
|
+
"@wtf/semantic-release-go": "1.0.0",
|
|
51
|
+
"@wtf/semantic-release-maven": "1.0.0",
|
|
52
|
+
"@wtf/semantic-release-npm": "1.1.1",
|
|
50
53
|
"@wtf/semantic-release-replace": "4.0.0",
|
|
51
|
-
"@wtf/semantic-release-trains": "7.
|
|
52
|
-
"@wtf/semantic-release-trains-changelog": "7.0.0",
|
|
54
|
+
"@wtf/semantic-release-trains": "7.1.1",
|
|
53
55
|
"@wtf/semantic-release-validate": "4.0.0",
|
|
54
56
|
"ajv": "^8.20.0",
|
|
55
57
|
"semantic-release": "^25.0.9",
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../README.md) / @wtf/release-trains-changelog
|
|
6
|
-
|
|
7
|
-
# @wtf/release-trains-changelog
|
|
8
|
-
|
|
9
|
-
A changelog of each package of a release train, of no release tool: the section of a release
|
|
10
|
-
of the commits that change its own folder, grouped by their type, at the top of its changelog;
|
|
11
|
-
and of the train, of all its commits, where it names one. This module declares what a changelog
|
|
12
|
-
is given; the code is at the subpaths, each by the `system` its caller gives it:
|
|
13
|
-
|
|
14
|
-
- `./render`: a commit read, the section of a release rendered and put at the top of a
|
|
15
|
-
changelog, and the section of a version found again;
|
|
16
|
-
- `./write`: the changelogs of a release of a train written, and the faults of where they go.
|
|
17
|
-
|
|
18
|
-
## References
|
|
19
|
-
|
|
20
|
-
### ChangelogCommit
|
|
21
|
-
|
|
22
|
-
Re-exports [ChangelogCommit](render/interfaces/ChangelogCommit.md)
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### ChangelogOptions
|
|
27
|
-
|
|
28
|
-
Re-exports [ChangelogOptions](write/interfaces/ChangelogOptions.md)
|
|
29
|
-
|
|
30
|
-
***
|
|
31
|
-
|
|
32
|
-
### ChangelogRelease
|
|
33
|
-
|
|
34
|
-
Re-exports [ChangelogRelease](write/interfaces/ChangelogRelease.md)
|
|
35
|
-
|
|
36
|
-
***
|
|
37
|
-
|
|
38
|
-
### ChangelogTarget
|
|
39
|
-
|
|
40
|
-
Re-exports [ChangelogTarget](write/interfaces/ChangelogTarget.md)
|
|
41
|
-
|
|
42
|
-
***
|
|
43
|
-
|
|
44
|
-
### ParsedCommit
|
|
45
|
-
|
|
46
|
-
Re-exports [ParsedCommit](render/interfaces/ParsedCommit.md)
|
|
47
|
-
|
|
48
|
-
***
|
|
49
|
-
|
|
50
|
-
### RenderOptions
|
|
51
|
-
|
|
52
|
-
Re-exports [RenderOptions](render/interfaces/RenderOptions.md)
|
|
53
|
-
|
|
54
|
-
***
|
|
55
|
-
|
|
56
|
-
### WrittenChangelog
|
|
57
|
-
|
|
58
|
-
Re-exports [WrittenChangelog](write/interfaces/WrittenChangelog.md)
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../../README.md) / @wtf/release-trains-changelog/render
|
|
6
|
-
|
|
7
|
-
# @wtf/release-trains-changelog/render
|
|
8
|
-
|
|
9
|
-
A changelog as text: a commit read by its Conventional Commits header and its footer
|
|
10
|
-
([parseCommit](functions/parseCommit.md)), the section of a release rendered of its commits, grouped by their type
|
|
11
|
-
([renderSection](functions/renderSection.md)), a section put at the top of a changelog ([prependSection](functions/prependSection.md)), and
|
|
12
|
-
the section of a version found again ([changelogSection](functions/changelogSection.md)).
|
|
13
|
-
|
|
14
|
-
```ts
|
|
15
|
-
import { renderSection } from '@wtf/release-trains-changelog/render'
|
|
16
|
-
|
|
17
|
-
const section = renderSection(
|
|
18
|
-
[{ hash: '0123456789abcdef', message: 'feat(semantic-release-trains): the option cascade' }],
|
|
19
|
-
{ version: '1.2.0', date: '2026-10-30' }
|
|
20
|
-
)
|
|
21
|
-
// ## 1.2.0 (2026-10-30)
|
|
22
|
-
//
|
|
23
|
-
// ### Features
|
|
24
|
-
//
|
|
25
|
-
// - **semantic-release-trains:** the option cascade (0123456)
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
## Interfaces
|
|
29
|
-
|
|
30
|
-
- [ChangelogCommit](interfaces/ChangelogCommit.md)
|
|
31
|
-
- [ParsedCommit](interfaces/ParsedCommit.md)
|
|
32
|
-
- [RenderOptions](interfaces/RenderOptions.md)
|
|
33
|
-
|
|
34
|
-
## Variables
|
|
35
|
-
|
|
36
|
-
- [DEFAULT\_TYPES](variables/DEFAULT_TYPES.md)
|
|
37
|
-
- [TITLE](variables/TITLE.md)
|
|
38
|
-
|
|
39
|
-
## Functions
|
|
40
|
-
|
|
41
|
-
- [changelogSection](functions/changelogSection.md)
|
|
42
|
-
- [parseCommit](functions/parseCommit.md)
|
|
43
|
-
- [prependSection](functions/prependSection.md)
|
|
44
|
-
- [renderSection](functions/renderSection.md)
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/render](../README.md) / changelogSection
|
|
6
|
-
|
|
7
|
-
# Function: changelogSection()
|
|
8
|
-
|
|
9
|
-
> **changelogSection**(`changelog`, `version`): `string`
|
|
10
|
-
|
|
11
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:179](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L179)
|
|
12
|
-
|
|
13
|
-
The section of `version` of a changelog, from its heading to the next one, as this package or
|
|
14
|
-
conventional-changelog writes it: `## 2.1.0 (date)`, `# [2.1.0](…) (date)` or `## [2.1.1](…)`;
|
|
15
|
-
empty, where it has none.
|
|
16
|
-
|
|
17
|
-
## Parameters
|
|
18
|
-
|
|
19
|
-
### changelog
|
|
20
|
-
|
|
21
|
-
`string`
|
|
22
|
-
|
|
23
|
-
The text of the changelog to look in.
|
|
24
|
-
|
|
25
|
-
### version
|
|
26
|
-
|
|
27
|
-
`string`
|
|
28
|
-
|
|
29
|
-
The version of the section, as `2.1.0`.
|
|
30
|
-
|
|
31
|
-
## Returns
|
|
32
|
-
|
|
33
|
-
`string`
|
|
34
|
-
|
|
35
|
-
The section, trimmed, its heading first, or empty of none.
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/render](../README.md) / parseCommit
|
|
6
|
-
|
|
7
|
-
# Function: parseCommit()
|
|
8
|
-
|
|
9
|
-
> **parseCommit**(`commit`): [`ParsedCommit`](../interfaces/ParsedCommit.md) \| `undefined`
|
|
10
|
-
|
|
11
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L54)
|
|
12
|
-
|
|
13
|
-
The commit of `commit`'s message, read by its Conventional Commits header and its
|
|
14
|
-
`BREAKING CHANGE:` footer; `undefined` of a message of no such header, as of a merge commit.
|
|
15
|
-
|
|
16
|
-
## Parameters
|
|
17
|
-
|
|
18
|
-
### commit
|
|
19
|
-
|
|
20
|
-
[`ChangelogCommit`](../interfaces/ChangelogCommit.md)
|
|
21
|
-
|
|
22
|
-
The commit to read: its hash and its message.
|
|
23
|
-
|
|
24
|
-
## Returns
|
|
25
|
-
|
|
26
|
-
[`ParsedCommit`](../interfaces/ParsedCommit.md) \| `undefined`
|
|
27
|
-
|
|
28
|
-
The commit read, or `undefined` of a message of no Conventional Commits header.
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/render](../README.md) / prependSection
|
|
6
|
-
|
|
7
|
-
# Function: prependSection()
|
|
8
|
-
|
|
9
|
-
> **prependSection**(`existing`, `section`, `title?`): `string`
|
|
10
|
-
|
|
11
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:159](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L159)
|
|
12
|
-
|
|
13
|
-
`section` at the top of the changelog `existing`, under its title: a changelog of `title` and
|
|
14
|
-
the section, of none.
|
|
15
|
-
|
|
16
|
-
## Parameters
|
|
17
|
-
|
|
18
|
-
### existing
|
|
19
|
-
|
|
20
|
-
`string` \| `undefined`
|
|
21
|
-
|
|
22
|
-
The text of the changelog, or `undefined` of none yet.
|
|
23
|
-
|
|
24
|
-
### section
|
|
25
|
-
|
|
26
|
-
`string`
|
|
27
|
-
|
|
28
|
-
The section of the release, to put first.
|
|
29
|
-
|
|
30
|
-
### title?
|
|
31
|
-
|
|
32
|
-
`string` = `TITLE`
|
|
33
|
-
|
|
34
|
-
The title of the changelog, kept at its top: [TITLE](../variables/TITLE.md) by default.
|
|
35
|
-
|
|
36
|
-
## Returns
|
|
37
|
-
|
|
38
|
-
`string`
|
|
39
|
-
|
|
40
|
-
The changelog, the section first under its title.
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/render](../README.md) / renderSection
|
|
6
|
-
|
|
7
|
-
# Function: renderSection()
|
|
8
|
-
|
|
9
|
-
> **renderSection**(`commits`, `options`): `string`
|
|
10
|
-
|
|
11
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:110](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L110)
|
|
12
|
-
|
|
13
|
-
The section of a release, of its commits: `## <version> (<date>)`, its breaking changes first,
|
|
14
|
-
then a heading of each type of [RenderOptions.types](../interfaces/RenderOptions.md#types) that has a commit, each commit a line
|
|
15
|
-
of its scope, its subject and its short hash, in the order given. Empty, of commits that show
|
|
16
|
-
nothing, as of `chore:` alone.
|
|
17
|
-
|
|
18
|
-
## Parameters
|
|
19
|
-
|
|
20
|
-
### commits
|
|
21
|
-
|
|
22
|
-
readonly [`ChangelogCommit`](../interfaces/ChangelogCommit.md)[]
|
|
23
|
-
|
|
24
|
-
The commits of the release, in the order their lines show.
|
|
25
|
-
|
|
26
|
-
### options
|
|
27
|
-
|
|
28
|
-
[`RenderOptions`](../interfaces/RenderOptions.md)
|
|
29
|
-
|
|
30
|
-
The version and the day of the release, the types shown and the page of a
|
|
31
|
-
commit.
|
|
32
|
-
|
|
33
|
-
## Returns
|
|
34
|
-
|
|
35
|
-
`string`
|
|
36
|
-
|
|
37
|
-
The section, as markdown, or empty of commits that show nothing.
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/render](../README.md) / ChangelogCommit
|
|
6
|
-
|
|
7
|
-
# Interface: ChangelogCommit
|
|
8
|
-
|
|
9
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L26)
|
|
10
|
-
|
|
11
|
-
A commit as a changelog reads one: its hash and its message.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### hash
|
|
16
|
-
|
|
17
|
-
> `readonly` **hash**: `string`
|
|
18
|
-
|
|
19
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:27](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L27)
|
|
20
|
-
|
|
21
|
-
***
|
|
22
|
-
|
|
23
|
-
### message
|
|
24
|
-
|
|
25
|
-
> `readonly` **message**: `string`
|
|
26
|
-
|
|
27
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L28)
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/render](../README.md) / ParsedCommit
|
|
6
|
-
|
|
7
|
-
# Interface: ParsedCommit
|
|
8
|
-
|
|
9
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:32](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L32)
|
|
10
|
-
|
|
11
|
-
A commit of a Conventional Commits header, read.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### breaking
|
|
16
|
-
|
|
17
|
-
> `readonly` **breaking**: `string` \| `undefined`
|
|
18
|
-
|
|
19
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:38](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L38)
|
|
20
|
-
|
|
21
|
-
What it breaks: its `BREAKING CHANGE:` footer, or its subject of a `type!:` header alone.
|
|
22
|
-
|
|
23
|
-
***
|
|
24
|
-
|
|
25
|
-
### hash
|
|
26
|
-
|
|
27
|
-
> `readonly` **hash**: `string`
|
|
28
|
-
|
|
29
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:33](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L33)
|
|
30
|
-
|
|
31
|
-
***
|
|
32
|
-
|
|
33
|
-
### scope
|
|
34
|
-
|
|
35
|
-
> `readonly` **scope**: `string` \| `undefined`
|
|
36
|
-
|
|
37
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:35](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L35)
|
|
38
|
-
|
|
39
|
-
***
|
|
40
|
-
|
|
41
|
-
### subject
|
|
42
|
-
|
|
43
|
-
> `readonly` **subject**: `string`
|
|
44
|
-
|
|
45
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L36)
|
|
46
|
-
|
|
47
|
-
***
|
|
48
|
-
|
|
49
|
-
### type
|
|
50
|
-
|
|
51
|
-
> `readonly` **type**: `string`
|
|
52
|
-
|
|
53
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:34](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L34)
|
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/render](../README.md) / RenderOptions
|
|
6
|
-
|
|
7
|
-
# Interface: RenderOptions
|
|
8
|
-
|
|
9
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:79](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L79)
|
|
10
|
-
|
|
11
|
-
How a section is rendered.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### commitUrl?
|
|
16
|
-
|
|
17
|
-
> `readonly` `optional` **commitUrl?**: (`hash`) => `string`
|
|
18
|
-
|
|
19
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L92)
|
|
20
|
-
|
|
21
|
-
The page of a commit, by its hash, which each line links: none by default.
|
|
22
|
-
|
|
23
|
-
#### Parameters
|
|
24
|
-
|
|
25
|
-
##### hash
|
|
26
|
-
|
|
27
|
-
`string`
|
|
28
|
-
|
|
29
|
-
The full hash of the commit.
|
|
30
|
-
|
|
31
|
-
#### Returns
|
|
32
|
-
|
|
33
|
-
`string`
|
|
34
|
-
|
|
35
|
-
The URL of the commit's page.
|
|
36
|
-
|
|
37
|
-
***
|
|
38
|
-
|
|
39
|
-
### date
|
|
40
|
-
|
|
41
|
-
> `readonly` **date**: `string` \| `Date`
|
|
42
|
-
|
|
43
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:83](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L83)
|
|
44
|
-
|
|
45
|
-
The day of the release: a date, or its `YYYY-MM-DD`.
|
|
46
|
-
|
|
47
|
-
***
|
|
48
|
-
|
|
49
|
-
### types?
|
|
50
|
-
|
|
51
|
-
> `readonly` `optional` **types?**: readonly (readonly \[`string`, `string`\])[]
|
|
52
|
-
|
|
53
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L85)
|
|
54
|
-
|
|
55
|
-
The types shown, each with its heading, in order: [DEFAULT\_TYPES](../variables/DEFAULT_TYPES.md).
|
|
56
|
-
|
|
57
|
-
***
|
|
58
|
-
|
|
59
|
-
### version
|
|
60
|
-
|
|
61
|
-
> `readonly` **version**: `string`
|
|
62
|
-
|
|
63
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:81](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L81)
|
|
64
|
-
|
|
65
|
-
The version of the release.
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/render](../README.md) / DEFAULT\_TYPES
|
|
6
|
-
|
|
7
|
-
# Variable: DEFAULT\_TYPES
|
|
8
|
-
|
|
9
|
-
> `const` **DEFAULT\_TYPES**: readonly (readonly \[`string`, `string`\])[]
|
|
10
|
-
|
|
11
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:71](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L71)
|
|
12
|
-
|
|
13
|
-
The types a changelog shows, each with its heading, in order: features, fixes, performance, reverts.
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/render](../README.md) / TITLE
|
|
6
|
-
|
|
7
|
-
# Variable: TITLE
|
|
8
|
-
|
|
9
|
-
> `const` **TITLE**: `"# Changelog"` = `'# Changelog'`
|
|
10
|
-
|
|
11
|
-
Defined in: [packages/release-trains-changelog/src/render.ts:148](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/render.ts#L148)
|
|
12
|
-
|
|
13
|
-
The title of a changelog by default.
|
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../../README.md) / @wtf/release-trains-changelog/write
|
|
6
|
-
|
|
7
|
-
# @wtf/release-trains-changelog/write
|
|
8
|
-
|
|
9
|
-
The changelogs of a release of a train, written: one of each package of the train, of the
|
|
10
|
-
commits that change its own folder, and one of the train, of its commits, where it names one
|
|
11
|
-
([writeChangelogs](functions/writeChangelogs.md)); the faults of where they go, found before the release
|
|
12
|
-
([changelogErrors](functions/changelogErrors.md)); and the page of a commit of a repository's URL ([commitUrlOf](functions/commitUrlOf.md)).
|
|
13
|
-
|
|
14
|
-
The packages of a train are those the ecosystems of the repo give, of
|
|
15
|
-
`@wtf/release-trains/ecosystem`: a folder of two ecosystems, as of an npm package and a crate,
|
|
16
|
-
has one changelog.
|
|
17
|
-
|
|
18
|
-
```ts
|
|
19
|
-
import type { System } from '@wtf/release-system/system'
|
|
20
|
-
import type { Ecosystem } from '@wtf/release-trains/ecosystem'
|
|
21
|
-
import { writeChangelogs } from '@wtf/release-trains-changelog/write'
|
|
22
|
-
|
|
23
|
-
// The system of the caller, Node's of a plugin, its own of a CLI; and an ecosystem of the repo.
|
|
24
|
-
declare const system: System
|
|
25
|
-
declare const npm: Ecosystem
|
|
26
|
-
|
|
27
|
-
await writeChangelogs({
|
|
28
|
-
trains: { trains: { paths: ['packages/release-trains', 'packages/release-trains-*'] } },
|
|
29
|
-
train: 'trains',
|
|
30
|
-
ecosystems: [npm],
|
|
31
|
-
version: '1.2.0',
|
|
32
|
-
commits: [{ hash: '0123456789abcdef0123456789abcdef01234567', message: 'feat: add a flag' }],
|
|
33
|
-
system
|
|
34
|
-
})
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
## Interfaces
|
|
38
|
-
|
|
39
|
-
- [ChangelogOptions](interfaces/ChangelogOptions.md)
|
|
40
|
-
- [ChangelogRelease](interfaces/ChangelogRelease.md)
|
|
41
|
-
- [ChangelogTarget](interfaces/ChangelogTarget.md)
|
|
42
|
-
- [WrittenChangelog](interfaces/WrittenChangelog.md)
|
|
43
|
-
|
|
44
|
-
## Functions
|
|
45
|
-
|
|
46
|
-
- [changelogErrors](functions/changelogErrors.md)
|
|
47
|
-
- [commitUrlOf](functions/commitUrlOf.md)
|
|
48
|
-
- [writeChangelogs](functions/writeChangelogs.md)
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/write](../README.md) / changelogErrors
|
|
6
|
-
|
|
7
|
-
# Function: changelogErrors()
|
|
8
|
-
|
|
9
|
-
> **changelogErrors**(`target`): `Promise`\<[`TrainsError`](../../../release-trains/errors/classes/TrainsError.md)[]\>
|
|
10
|
-
|
|
11
|
-
Defined in: [packages/release-trains-changelog/src/write.ts:240](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L240)
|
|
12
|
-
|
|
13
|
-
The faults of where the changelogs of the train go, before a release writes them: the train
|
|
14
|
-
chosen and declared (`ETRAINNOTSELECTED`, `ETRAINUNKNOWN`), and a changelog of the train,
|
|
15
|
-
`trainChangelog`, that is the changelog of one of its packages, or of another train or one of its
|
|
16
|
-
packages (`ECHANGELOG`): the sections of two of the same version would stand in one changelog,
|
|
17
|
-
the second over the first. A `file` of `false` with no `trainChangelog` writes no changelog at
|
|
18
|
-
all (`ECHANGELOG`).
|
|
19
|
-
|
|
20
|
-
## Parameters
|
|
21
|
-
|
|
22
|
-
### target
|
|
23
|
-
|
|
24
|
-
[`ChangelogTarget`](../interfaces/ChangelogTarget.md)
|
|
25
|
-
|
|
26
|
-
The trains, the train of the release, the ecosystems of the repo, and the options
|
|
27
|
-
of its changelogs.
|
|
28
|
-
|
|
29
|
-
## Returns
|
|
30
|
-
|
|
31
|
-
`Promise`\<[`TrainsError`](../../../release-trains/errors/classes/TrainsError.md)[]\>
|
|
32
|
-
|
|
33
|
-
The faults found, empty of none.
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/write](../README.md) / commitUrlOf
|
|
6
|
-
|
|
7
|
-
# Function: commitUrlOf()
|
|
8
|
-
|
|
9
|
-
> **commitUrlOf**(`url`): ((`hash`) => `string`) \| `undefined`
|
|
10
|
-
|
|
11
|
-
Defined in: [packages/release-trains-changelog/src/write.ts:132](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L132)
|
|
12
|
-
|
|
13
|
-
The page of a commit of the repository at `url`, or `undefined` of a URL of no web page, as of a
|
|
14
|
-
path: `<url>/-/commit/<hash>` of GitLab, `<url>/commit/<hash>` of others. An SSH URL is read as
|
|
15
|
-
its host's HTTPS one.
|
|
16
|
-
|
|
17
|
-
## Parameters
|
|
18
|
-
|
|
19
|
-
### url
|
|
20
|
-
|
|
21
|
-
`string` \| `undefined`
|
|
22
|
-
|
|
23
|
-
The URL of the repository, HTTPS or SSH, as a package's `repository.url`.
|
|
24
|
-
|
|
25
|
-
## Returns
|
|
26
|
-
|
|
27
|
-
((`hash`) => `string`) \| `undefined`
|
|
28
|
-
|
|
29
|
-
The page of a commit, by its hash, or `undefined` of none.
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
[**Release trains**](../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/write](../README.md) / writeChangelogs
|
|
6
|
-
|
|
7
|
-
# Function: writeChangelogs()
|
|
8
|
-
|
|
9
|
-
> **writeChangelogs**(`release`): `Promise`\<[`WrittenChangelog`](../interfaces/WrittenChangelog.md)[]\>
|
|
10
|
-
|
|
11
|
-
Defined in: [packages/release-trains-changelog/src/write.ts:159](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L159)
|
|
12
|
-
|
|
13
|
-
Writes the changelogs of a release of the train: for each package of the train, unless `file` is
|
|
14
|
-
`false`, the section of the commits of `commits` that change its folder, at the top of its
|
|
15
|
-
changelog, if any shows; and,
|
|
16
|
-
of `trainChangelog`, the section of every commit of the train. A changelog that holds the entries
|
|
17
|
-
of the run's section already, under a heading of the version, as of a release run again after a
|
|
18
|
-
publish that failed, is kept as it is, so none is written twice; a section of other entries, of
|
|
19
|
-
the same version, as of a run of more commits, is left, and the run's is written over it, so no
|
|
20
|
-
entry is lost. Gives each it wrote, and each it kept.
|
|
21
|
-
|
|
22
|
-
## Parameters
|
|
23
|
-
|
|
24
|
-
### release
|
|
25
|
-
|
|
26
|
-
[`ChangelogRelease`](../interfaces/ChangelogRelease.md)
|
|
27
|
-
|
|
28
|
-
The release: its trains, its train and the ecosystems of the repo, its version,
|
|
29
|
-
its commits, and the options of its changelogs.
|
|
30
|
-
|
|
31
|
-
## Returns
|
|
32
|
-
|
|
33
|
-
`Promise`\<[`WrittenChangelog`](../interfaces/WrittenChangelog.md)[]\>
|
|
34
|
-
|
|
35
|
-
The changelogs written and kept, each with the count of its commits.
|