@wtf/release-docs 9.1.0 → 10.0.0

package/api/@wtf/release/driver/variables/STEPS.md

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/driver](../README.md) / STEPS
+
+# Variable: STEPS
+
+> `const` **STEPS**: readonly [`Step`](../type-aliases/Step.md)[]
+
+Defined in: [packages/release/src/driver.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/driver.ts#L31)
+
+Each [Step](../type-aliases/Step.md), in the order a release runs them.

package/api/@wtf/{release-trains → release}/ecosystem/README.md

@@ -2,22 +2,22 @@
 
 ***
 
-[Release trains](../../../README.md) / @wtf/release-trains/ecosystem
+[Release trains](../../../README.md) / @wtf/release/ecosystem
 
-# @wtf/release-trains/ecosystem
+# @wtf/release/ecosystem
 
-What an ecosystem is to the trains: the packages of one kind of manifest of a repo, as npm's
+What an ecosystem is to a release: the packages of one kind of manifest of a repo, as npm's
 package.json or cargo's Cargo.toml, read by a package of its own, which stamps the versions of a
-release and publishes it. The trains read no manifest themselves: each [Ecosystem](interfaces/Ecosystem.md) gives
-its [Package](interfaces/Package.md)s, each of its folder, whether it publishes, and its [Dependency](interfaces/Dependency.md)s on
-the other packages of the ecosystem in the repo; and the trains make of them, the same for every
-ecosystem, which train holds each package, the order of the trains, the checks of a release, and
-the releases a train owes the trains it depends on. [loadEcosystems](functions/loadEcosystems.md) loads the ecosystems a
-config names, by the loader of modules its caller gives it, and [readPackages](functions/readPackages.md) reads the
-packages of each ecosystem of a repo.
+release and publishes it. A release reads no manifest itself: each [Ecosystem](interfaces/Ecosystem.md) gives its
+[Package](interfaces/Package.md)s, each of its folder, whether it publishes, and its [Dependency](interfaces/Dependency.md)s on the
+other packages of the ecosystem in the repo; and what releases the repo makes of them, the same
+for every ecosystem, the order of its packages and of its parts, as the trains of
+`@wtf/release-trains` do, the checks of a release, and the releases one part owes another.
+[loadEcosystems](functions/loadEcosystems.md) loads the ecosystems a config names, by the loader of modules its caller
+gives it, and [readPackages](functions/readPackages.md) reads the packages of each ecosystem of a repo.
 
 ```ts
-import type { Ecosystem } from '@wtf/release-trains/ecosystem'
+import type { Ecosystem } from '@wtf/release/ecosystem'
 
 // An ecosystem of one package of no dependency, of exact versions.
 export const single: Ecosystem = {

package/api/@wtf/release/ecosystem/functions/isEcosystem.md

@@ -0,0 +1,27 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/ecosystem](../README.md) / isEcosystem
+
+# Function: isEcosystem()
+
+> **isEcosystem**(`value`): `value is Ecosystem<Package>`
+
+Defined in: [packages/release/src/ecosystem.ts:137](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L137)
+
+Whether `value` is an [Ecosystem](../interfaces/Ecosystem.md): of a name, and the three methods.
+
+## Parameters
+
+### value
+
+`unknown`
+
+What a module gives, as its default export.
+
+## Returns
+
+`value is Ecosystem<Package>`
+
+Whether it is an ecosystem.

package/api/@wtf/{release-trains → release}/ecosystem/functions/loadEcosystems.md

@@ -2,18 +2,18 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-trains/ecosystem](../README.md) / loadEcosystems
+[Release trains](../../../../README.md) / [@wtf/release/ecosystem](../README.md) / loadEcosystems
 
 # Function: loadEcosystems()
 
-> **loadEcosystems**(`names`, `load`): `Promise`\<[`Ecosystem`](../interfaces/Ecosystem.md)[]\>
+> **loadEcosystems**(`names`, `load`): `Promise`\<[`Ecosystem`](../interfaces/Ecosystem.md)\<[`Package`](../interfaces/Package.md)\>[]\>
 
-Defined in: [packages/release-trains/src/ecosystem.ts:163](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L163)
+Defined in: [packages/release/src/ecosystem.ts:168](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L168)
 
 The ecosystems of `names`, as a config names them in `ecosystems`, each the default export of
 the module of its name, which `load` loads, as a plugin loads it of the repo. Throws `EECOSYSTEM`
 of each that cannot be loaded, of a default export that is no ecosystem, and of two of one name,
-which the trains would read as one, together.
+which a release would read as one, together.
 
 ## Parameters
 
@@ -31,6 +31,6 @@ What loads a module of its name: the caller's, as a plugin's `import()`.
 
 ## Returns
 
-`Promise`\<[`Ecosystem`](../interfaces/Ecosystem.md)[]\>
+`Promise`\<[`Ecosystem`](../interfaces/Ecosystem.md)\<[`Package`](../interfaces/Package.md)\>[]\>
 
 The ecosystems, in the order of `names`.

package/api/@wtf/release/ecosystem/functions/readPackages.md

@@ -0,0 +1,33 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/ecosystem](../README.md) / readPackages
+
+# Function: readPackages()
+
+> **readPackages**(`ecosystems`, `context`): `Promise`\<[`EcosystemPackages`](../interfaces/EcosystemPackages.md)\<[`Package`](../interfaces/Package.md)\>[]\>
+
+Defined in: [packages/release/src/ecosystem.ts:236](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L236)
+
+The packages of each ecosystem of `ecosystems` in the repo of `context`, at its `ref`.
+
+## Parameters
+
+### ecosystems
+
+readonly [`Ecosystem`](../interfaces/Ecosystem.md)\<[`Package`](../interfaces/Package.md)\>[]
+
+The ecosystems of the repo, as a config names them.
+
+### context
+
+[`EcosystemContext`](../interfaces/EcosystemContext.md)
+
+The folder of the repo, the platform, and the commit.
+
+## Returns
+
+`Promise`\<[`EcosystemPackages`](../interfaces/EcosystemPackages.md)\<[`Package`](../interfaces/Package.md)\>[]\>
+
+The packages of each ecosystem, in the order of `ecosystems`.

package/api/@wtf/release/ecosystem/interfaces/Dependency.md

@@ -0,0 +1,43 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/ecosystem](../README.md) / Dependency
+
+# Interface: Dependency
+
+Defined in: [packages/release/src/ecosystem.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L44)
+
+A dependency of a package on another package of its ecosystem in the repo.
+
+## Properties
+
+### kind
+
+> `readonly` **kind**: [`DependencyKind`](../type-aliases/DependencyKind.md)
+
+Defined in: [packages/release/src/ecosystem.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L48)
+
+How it depends on it.
+
+***
+
+### name
+
+> `readonly` **name**: `string`
+
+Defined in: [packages/release/src/ecosystem.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L46)
+
+The name of the package it depends on, of the same ecosystem, in this repo.
+
+***
+
+### range
+
+> `readonly` **range**: `string` \| `undefined`
+
+Defined in: [packages/release/src/ecosystem.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L54)
+
+The range as the manifest writes it, which a release publishes of the version of the package
+it names, by [Ecosystem.resolve](Ecosystem.md#resolve), as `workspace:^` of npm; `undefined` where nothing of it
+reaches the registry, as of a dependency a package drops as it publishes.

package/api/@wtf/{release-trains → release}/ecosystem/interfaces/Ecosystem.md

@@ -2,15 +2,23 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-trains/ecosystem](../README.md) / Ecosystem
+[Release trains](../../../../README.md) / [@wtf/release/ecosystem](../README.md) / Ecosystem
 
-# Interface: Ecosystem
+# Interface: Ecosystem\<P\>
 
-Defined in: [packages/release-trains/src/ecosystem.ts:93](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L93)
+Defined in: [packages/release/src/ecosystem.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L97)
 
 An ecosystem: the packages of one kind of manifest of a repo, and its rules of ranges. A package
-of an ecosystem's own, as `@wtf/release-npm`, gives one as its default export, which a config of
-semantic-release names in `ecosystems`.
+of an ecosystem's own, as `@wtf/release-npm`, gives one as its default export, which a config
+names in `ecosystems`.
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`Package`](Package.md) = [`Package`](Package.md)
+
+Its packages, as it gives them: a [Package](Package.md), or one of more of its own.
 
 ## Properties
 
@@ -18,19 +26,20 @@ semantic-release names in `ecosystems`.
 
 > `readonly` **name**: `string`
 
-Defined in: [packages/release-trains/src/ecosystem.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L95)
+Defined in: [packages/release/src/ecosystem.ts:99](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L99)
 
-Its name, as an error, the notes and a key of the trains say it: `npm`, `cargo`.
+Its name, as an error, the notes and a key of a config say it: `npm`, `cargo`.
 
 ## Methods
 
 ### packages()
 
-> **packages**(`context`): `Promise`\<readonly [`Package`](Package.md)[]\>
+> **packages**(`context`): `Promise`\<readonly `P`[]\>
 
-Defined in: [packages/release-trains/src/ecosystem.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L103)
+Defined in: [packages/release/src/ecosystem.ts:108](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L108)
 
-The packages of the ecosystem in the repo of `context`, at its `ref`, by the system it gives:
+The packages of the ecosystem in the repo of `context`, at its `ref`, by its folder and its
+platform:
 each manifest of the repo, of its dependencies on the other packages of the ecosystem in it.
 
 #### Parameters
@@ -39,11 +48,11 @@ each manifest of the repo, of its dependencies on the other packages of the ecos
 
 [`EcosystemContext`](EcosystemContext.md)
 
-The folder of the repo, its environment, the system, and the commit.
+The folder of the repo, the platform, and the commit.
 
 #### Returns
 
-`Promise`\<readonly [`Package`](Package.md)[]\>
+`Promise`\<readonly `P`[]\>
 
 The packages, in an order of the ecosystem's own.
 
@@ -53,7 +62,7 @@ The packages, in an order of the ecosystem's own.
 
 > **resolve**(`range`, `version`): `string`
 
-Defined in: [packages/release-trains/src/ecosystem.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L113)
+Defined in: [packages/release/src/ecosystem.ts:118](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L118)
 
 The range a release publishes of `range`, a range of a [Dependency](Dependency.md), of `version`, the
 release of the package it names: `^7.0.0` of npm's `workspace:^` and `7.0.0`. A range of its
@@ -85,7 +94,7 @@ The range the release publishes.
 
 > **satisfies**(`range`, `version`): `boolean`
 
-Defined in: [packages/release-trains/src/ecosystem.ts:123](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L123)
+Defined in: [packages/release/src/ecosystem.ts:128](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L128)
 
 Whether `version` is within `range`, by the ecosystem's own rules of ranges: a prerelease within
 its bounds too, as `7.1.0-beta.1` of `^7.0.0`. A range that names no version, as a tag or a

package/api/@wtf/release/ecosystem/interfaces/EcosystemContext.md

@@ -0,0 +1,56 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/ecosystem](../README.md) / EcosystemContext
+
+# Interface: EcosystemContext
+
+Defined in: [packages/release/src/ecosystem.ts:82](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L82)
+
+Where an ecosystem reads its packages: the folder of the repo, `root`, the platform, whose
+working folder, `dirs.cwd`, is the path of that folder, and the commit. The platform is a
+release's, as an ecosystem may read a commit by its tools in a temporary folder.
+
+## Extends
+
+- [`RepoContext`](../../interfaces/RepoContext.md)\<[`ReleasePlatform`](../../type-aliases/ReleasePlatform.md)\>
+
+## Properties
+
+### platform
+
+> `readonly` **platform**: [`ReleasePlatform`](../../type-aliases/ReleasePlatform.md)
+
+Defined in: [packages/release/src/index.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/index.ts#L80)
+
+The platform, of the folder of the repo as its working folder.
+
+#### Inherited from
+
+[`RepoContext`](../../interfaces/RepoContext.md).[`platform`](../../interfaces/RepoContext.md#platform)
+
+***
+
+### ref?
+
+> `readonly` `optional` **ref?**: `string`
+
+Defined in: [packages/release/src/ecosystem.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L87)
+
+The commit to read the packages at, by git, as `HEAD` or the tag of a release: the files of the
+working tree that git tracks by default.
+
+***
+
+### root
+
+> `readonly` **root**: `FileSystemDirectoryHandle`
+
+Defined in: [packages/release/src/index.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/index.ts#L78)
+
+The folder of the repo, a handle of the File System standard.
+
+#### Inherited from
+
+[`RepoContext`](../../interfaces/RepoContext.md).[`root`](../../interfaces/RepoContext.md#root)

package/api/@wtf/release/ecosystem/interfaces/EcosystemPackages.md

@@ -0,0 +1,35 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/ecosystem](../README.md) / EcosystemPackages
+
+# Interface: EcosystemPackages\<P\>
+
+Defined in: [packages/release/src/ecosystem.ts:224](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L224)
+
+The packages of one ecosystem of a repo, as [readPackages](../functions/readPackages.md) reads them.
+
+## Type Parameters
+
+### P
+
+`P` *extends* [`Package`](Package.md) = [`Package`](Package.md)
+
+Its packages, as the ecosystem gives them.
+
+## Properties
+
+### ecosystem
+
+> `readonly` **ecosystem**: [`Ecosystem`](Ecosystem.md)\<`P`\>
+
+Defined in: [packages/release/src/ecosystem.ts:225](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L225)
+
+***
+
+### packages
+
+> `readonly` **packages**: readonly `P`[]
+
+Defined in: [packages/release/src/ecosystem.ts:226](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L226)

package/api/@wtf/release/ecosystem/interfaces/Package.md

@@ -0,0 +1,71 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/ecosystem](../README.md) / Package
+
+# Interface: Package
+
+Defined in: [packages/release/src/ecosystem.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L58)
+
+A package of an ecosystem in the repo: one manifest, and its folder.
+
+## Extended by
+
+- [`NpmPackage`](../../../release-npm/manifests/interfaces/NpmPackage.md)
+- [`CargoPackage`](../../../release-cargo/ecosystem/interfaces/CargoPackage.md)
+- [`GoPackage`](../../../release-go/ecosystem/interfaces/GoPackage.md)
+- [`MavenModule`](../../../release-maven/interfaces/MavenModule.md)
+- [`OciPackage`](../../../release-oci/ecosystem/interfaces/OciPackage.md)
+
+## Properties
+
+### dependencies
+
+> `readonly` **dependencies**: readonly [`Dependency`](Dependency.md)[]
+
+Defined in: [packages/release/src/ecosystem.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L74)
+
+Its dependencies on the other packages of its ecosystem in the repo.
+
+***
+
+### dir
+
+> `readonly` **dir**: `string`
+
+Defined in: [packages/release/src/ecosystem.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L65)
+
+Its folder, from the root of the repo, as `packages/core`; `.` of the root. A part of the repo,
+as a train, holds it when its paths hold this folder.
+
+***
+
+### manifest
+
+> `readonly` **manifest**: `string`
+
+Defined in: [packages/release/src/ecosystem.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L67)
+
+Its manifest, from the root of the repo, as `packages/core/package.json`.
+
+***
+
+### name
+
+> `readonly` **name**: `string`
+
+Defined in: [packages/release/src/ecosystem.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L60)
+
+Its name, the one its ecosystem's registry knows it by: unique of the ecosystem in the repo.
+
+***
+
+### published
+
+> `readonly` **published**: `boolean`
+
+Defined in: [packages/release/src/ecosystem.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L72)
+
+Whether a release publishes it: not of an npm package that is private, nor of a crate of
+`publish = false`.

package/api/@wtf/release/ecosystem/type-aliases/DependencyKind.md

@@ -0,0 +1,16 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/ecosystem](../README.md) / DependencyKind
+
+# Type Alias: DependencyKind
+
+> **DependencyKind** = `"runtime"` \| `"peer"` \| `"build"` \| `"dev"`
+
+Defined in: [packages/release/src/ecosystem.ts:38](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L38)
+
+How a package depends on another: `runtime`, what it runs with; `peer`, what its users install
+beside it; `build`, what its build runs with; and `dev`, what its own tests and tools run with,
+which no user installs. Each but `dev` orders a release: the package, and the part of the repo
+that holds it, as a train, releases after the package it depends on.

package/api/@wtf/{release-trains → release}/ecosystem/type-aliases/ModuleLoader.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-trains/ecosystem](../README.md) / ModuleLoader
+[Release trains](../../../../README.md) / [@wtf/release/ecosystem](../README.md) / ModuleLoader
 
 # Type Alias: ModuleLoader
 
 > **ModuleLoader** = (`name`) => `Promise`\<`unknown`\>
 
-Defined in: [packages/release-trains/src/ecosystem.ts:151](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L151)
+Defined in: [packages/release/src/ecosystem.ts:156](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L156)
 
 What loads a module of its name, as `import()` of a plugin does, of where the plugin finds it:
 the module's namespace, of its default export.

package/api/@wtf/release/ecosystem/variables/DEPENDENCY_KINDS.md

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/ecosystem](../README.md) / DEPENDENCY\_KINDS
+
+# Variable: DEPENDENCY\_KINDS
+
+> `const` **DEPENDENCY\_KINDS**: readonly [`DependencyKind`](../type-aliases/DependencyKind.md)[]
+
+Defined in: [packages/release/src/ecosystem.ts:41](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/ecosystem.ts#L41)
+
+Each [DependencyKind](../type-aliases/DependencyKind.md), in the order a cascade judges them.

package/api/@wtf/release/errors/README.md

@@ -0,0 +1,41 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/release/errors
+
+# @wtf/release/errors
+
+What the packages of a release throw: [ReleaseError](classes/ReleaseError.md), of a stable `code`, a `message` of
+what is wrong, and `details` of how to fix it. Each package over this one throws errors of a class
+of its own that extends it, as `TrainsError` of `@wtf/release-trains/errors`; this package throws
+`ReleaseError` itself, of the codes of [RELEASE\_ERRORS](variables/RELEASE_ERRORS.md). A step that finds several faults
+throws them together, in an `AggregateError` ([throwAll](functions/throwAll.md)). They are plain errors, of no
+release tool: a tool that prints errors its own way marks them as they leave its steps.
+
+```ts
+import { ReleaseError, throwAll } from '@wtf/release/errors'
+
+// The errors of a package of its own, of its own codes.
+export class DeployError extends ReleaseError {}
+
+throwAll([]) // nothing
+```
+
+## Classes
+
+- [ReleaseError](classes/ReleaseError.md)
+
+## Type Aliases
+
+- [ErrorClass](type-aliases/ErrorClass.md)
+- [ReleaseErrorCode](type-aliases/ReleaseErrorCode.md)
+
+## Variables
+
+- [RELEASE\_ERRORS](variables/RELEASE_ERRORS.md)
+
+## Functions
+
+- [isReleaseError](functions/isReleaseError.md)
+- [throwAll](functions/throwAll.md)

package/api/@wtf/{release-system → release}/errors/classes/ReleaseError.md

@@ -2,15 +2,15 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/errors](../README.md) / ReleaseError
+[Release trains](../../../../README.md) / [@wtf/release/errors](../README.md) / ReleaseError
 
 # Class: ReleaseError
 
-Defined in: [packages/release-system/src/errors.ts:38](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/errors.ts#L38)
+Defined in: [packages/release/src/errors.ts:41](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/errors.ts#L41)
 
 An error of a release: a stable `code`, its `message` what is wrong, and its `details` how to fix
-it. semantic-release prints it as a `SemanticReleaseError`. The errors of each package over this
-one are of a class of its own that extends it.
+it. The errors of each package over this one are of a class of its own that extends it, each
+named after its class.
 
 ## Extends
 
@@ -19,6 +19,8 @@ one are of a class of its own that extends it.
 ## Extended by
 
 - [`TrainsError`](../../../release-trains/errors/classes/TrainsError.md)
+- [`NpmError`](../../../release-npm/errors/classes/NpmError.md)
+- [`ValidateError`](../../../release-validate/errors/classes/ValidateError.md)
 - [`ReplaceError`](../../../release-replace/errors/classes/ReplaceError.md)
 - [`CargoError`](../../../release-cargo/errors/classes/CargoError.md)
 - [`GoError`](../../../release-go/errors/classes/GoError.md)
@@ -31,10 +33,9 @@ one are of a class of its own that extends it.
 
 > **new ReleaseError**(`code`, `message`, `details`): `ReleaseError`
 
-Defined in: [packages/release-system/src/errors.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/errors.ts#L54)
+Defined in: [packages/release/src/errors.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/errors.ts#L54)
 
-An error of `code`, of its `message` and its `details`, named `SemanticReleaseError`, as
-semantic-release prints one.
+An error of `code`, of its `message` and its `details`, named after its class.
 
 #### Parameters
 
@@ -82,7 +83,7 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
 
 > `readonly` **code**: `string`
 
-Defined in: [packages/release-system/src/errors.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/errors.ts#L40)
+Defined in: [packages/release/src/errors.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/errors.ts#L43)
 
 The stable code of the error, as `EGIT`.
 
@@ -92,7 +93,7 @@ The stable code of the error, as `EGIT`.
 
 > `readonly` **details**: `string`
 
-Defined in: [packages/release-system/src/errors.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/errors.ts#L42)
+Defined in: [packages/release/src/errors.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/errors.ts#L45)
 
 How to fix it.
 
@@ -122,16 +123,6 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
 
 ***
 
-### semanticRelease
-
-> `readonly` **semanticRelease**: `true`
-
-Defined in: [packages/release-system/src/errors.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-system/src/errors.ts#L44)
-
-The mark semantic-release prints an error of a plugin by.
-
-***
-
 ### stack?
 
 > `optional` **stack?**: `string`

package/api/@wtf/release/errors/functions/isReleaseError.md

@@ -0,0 +1,28 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/errors](../README.md) / isReleaseError
+
+# Function: isReleaseError()
+
+> **isReleaseError**(`error`): `error is ReleaseError`
+
+Defined in: [packages/release/src/errors.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/errors.ts#L69)
+
+Whether `error` is a [ReleaseError](../classes/ReleaseError.md), of any copy of this package: an `Error` of a string
+`code` and string `details`.
+
+## Parameters
+
+### error
+
+`unknown`
+
+What was thrown.
+
+## Returns
+
+`error is ReleaseError`
+
+Whether it is one.