@wtf/release-docs 8.2.0 → 8.2.2

package/README.md

@@ -1,56 +1,68 @@
 # @wtf/release-docs
 
-The guides of semantic-release for monorepos of more than one ecosystem, released in trains, and
-the API reference of its packages, published with each release of the train `docs`: `npm install --save-dev @wtf/release-docs` reads them beside
-the packages, as `node_modules/@wtf/release-docs/guides/getting-started.md`.
+The guides for wtf release, which releases a monorepo with one or more ecosystems in trains, and the
+API reference of its packages. Each release of the `docs` train publishes this package. Install it
+with `npm install --save-dev @wtf/release-docs` to read the guides beside the packages, as
+`node_modules/@wtf/release-docs/guides/getting-started.md`.
 
 ## Guides
 
-- [Getting started](guides/getting-started.md): the libraries and the plugins, the config, one
-  train run, and the first release.
-- [Configuring trains](guides/configuring-trains.md): the fields of a train, paths and globs, which
-  commits count, generated folders, the config and its values, a preset, and the libraries.
-- [Dependency rules](guides/dependency-rules.md): when a train depends on another, and what a run
-  does about a dependency that is not released.
-- [Publishing](guides/publishing.md): every package of a train published, in order, by a publisher
-  of your choice.
-- [Publishing crates](guides/publishing-crates.md): the crates of a train of a Cargo workspace
-  published to crates.io by the version of a tag, beside the npm packages, each dependency on a
-  crate of another train at that train's last release, `[workspace.package]` of one train, what
-  crates.io needs, and a release finished by a retry.
-- [Publishing Go modules](guides/publishing-go-modules.md): the Go modules of a train tagged for
-  Go to fetch, on a commit of the go.mod files that require each module of another train at that
-  train's last release, majors in the module path, go.work or replace before a release, the Go
-  proxy, and a release finished by a retry.
-- [Publishing Maven modules](guides/publishing-maven.md): the Maven modules of a train deployed to
-  a repository by the version of a tag, each dependency on a module of another train at that
-  train's last release, what the stamp writes, `maven.deploy.skip`, the GitLab Maven registry and
-  Maven Central, and a release finished by a retry.
-- [Ecosystems](guides/ecosystems.md): what an ecosystem is to the trains, its interface, npm's,
-  cargo's, Go's and Maven's, and how to write one.
-- [Changelogs](guides/changelogs.md): a changelog for each package of a train.
-- [The system](guides/system.md): the files, processes and folders the libraries run by, which
-  their caller gives them.
-- [Validating a config](guides/validating-a-config.md): the schema of each package's part of a
-  config, as a validator for code and as `schema.json` for an editor, how they compose, and rules
-  of your own, checked in a run.
-- [CI recipes](guides/ci-recipes.md): GitLab CI and GitHub Actions, one train at a time.
-- [Troubleshooting](guides/troubleshooting.md): the errors and their fixes, and the usual causes of a
-  release that does not happen.
+### Start
+
+- [Getting started](guides/getting-started.md): learn what a train is, how the libraries and the
+  plugins fit together, and how to write a config and make your first release.
+
+### Trains
+
+- [Configure trains](guides/configuring-trains.md): set a train's paths and options, see which
+  commits count for it, commit generated folders, replace text in files, and write the config.
+- [Trains that depend on other trains](guides/dependency-rules.md): learn when a train depends on
+  another, what a run checks, and when a dependency's release makes a train release too.
+- [Changelogs](guides/changelogs.md): write a changelog for each train, and one changelog for every
+  train.
+
+### Ecosystems
+
+- [How ecosystems work](guides/ecosystems.md): learn what an ecosystem gives the trains, how npm,
+  Cargo, Go and Maven fit in, and how to write an ecosystem of your own.
+- [Publish npm packages](guides/publishing.md): publish every npm package in a train in dependency
+  order, with npm, pnpm or a publisher of your choice.
+- [Publish Cargo crates](guides/publishing-crates.md): publish the crates in a train to crates.io,
+  next to npm packages, and finish a release that stopped part way.
+- [Publish Go modules](guides/publishing-go-modules.md): tag the Go modules in a train so that Go
+  can fetch them, and handle majors, `go.work` and the Go proxy.
+- [Publish Maven modules](guides/publishing-maven.md): deploy the Maven modules in a train to the
+  GitLab Maven registry or Maven Central.
+
+### Run releases
+
+- [Run releases in CI](guides/ci-recipes.md): release one train at a time in GitLab CI or GitHub
+  Actions.
+- [Troubleshooting](guides/troubleshooting.md): fix each error, and find out why a release did not
+  happen.
+
+### Libraries
+
+- [The system](guides/system.md): give the libraries the files, processes and folders they run on,
+  from a plugin, a CLI of your own or a test.
+- [Validate a config](guides/validating-a-config.md): check a config in your editor, in code, and in
+  each run against rules of your own.
 
 ## API reference
 
-The reference of every package is in [`api/`](api/), which `pnpm run docs` writes with TypeDoc,
-each module by its import specifier, and lists in `api/.generated`. The release commits it, as that
-list has it; a branch does not.
+The reference for every package is in [`api/`](api/). `pnpm run docs` writes it with TypeDoc, names
+each module by its import specifier, and lists the files it wrote in `api/.generated`. The release
+commits the reference as that list has it. A branch does not commit it.
 
 ## Trains
 
-Each package is released on a train of its own, at the train's version. `api/trains.json`, which
-the same build writes of `release.config.mjs`, gives the packages of each train by their names, as
-`{ "trains": { "system": ["@wtf/release-system"], … } }`. The version of a package is the version
-of its train, and this package's `devDependencies` pin the version of each package that a release
-of the docs documents. The guides are of the docs train, at the version of this package.
+Each package is released on its own train, at the train's version. The same build writes
+`api/trains.json` from `release.config.mjs`. It lists the packages of each train by name, as
+`{ "trains": { "system": ["@wtf/release-system"], … } }`.
+
+A package's version is its train's version. This package's `devDependencies` pin the version of
+each package that a release of the docs documents. The guides belong to the `docs` train, at this
+package's version.
 
-The code blocks of the guides compile and run in this package's tests (`pnpm test`), and the tests
-hold the map to the trains of the config.
+The code blocks in the guides compile and run in this package's tests (`pnpm test`). The tests also
+check that `api/trains.json` matches the trains of the config.

package/api/@wtf/release-cargo/auth/functions/mask.md

@@ -8,7 +8,7 @@
 
 > **mask**(`text`, `secrets`): `string`
 
-Defined in: [packages/release-cargo/src/auth.ts:112](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L112)
+Defined in: [packages/release-cargo/src/auth.ts:112](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L112)
 
 `text` with each of `secrets` replaced by `***`, so a token is in no log and no error.
 

package/api/@wtf/release-cargo/auth/functions/tokenVariableOf.md

@@ -8,7 +8,7 @@
 
 > **tokenVariableOf**(`registry?`): `string`
 
-Defined in: [packages/release-cargo/src/auth.ts:100](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L100)
+Defined in: [packages/release-cargo/src/auth.ts:100](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L100)
 
 The variable `cargo` reads the token of a registry from: `CARGO_REGISTRY_TOKEN` of crates.io, and
 `CARGO_REGISTRIES_<NAME>_TOKEN` of another, its name in upper case, each `-` an `_`.

package/api/@wtf/release-cargo/auth/functions/trustedPublishing.md

@@ -8,7 +8,7 @@
 
 > **trustedPublishing**(`options`): [`TrustedPublishing`](../interfaces/TrustedPublishing.md)
 
-Defined in: [packages/release-cargo/src/auth.ts:146](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L146)
+Defined in: [packages/release-cargo/src/auth.ts:146](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L146)
 
 The trusted publishing of a registry, by an ID token and a `fetch`. Nothing is requested until
 [TrustedPublishing.exchange](../interfaces/TrustedPublishing.md#exchange) is called, so a release that has nothing to publish asks the

package/api/@wtf/release-cargo/auth/interfaces/HttpResponse.md

@@ -6,7 +6,7 @@
 
 # Interface: HttpResponse
 
-Defined in: [packages/release-cargo/src/auth.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L40)
+Defined in: [packages/release-cargo/src/auth.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L40)
 
 What a registry answers: the part of a `Response` this package reads.
 
@@ -16,7 +16,7 @@ What a registry answers: the part of a `Response` this package reads.
 
 > `readonly` **ok**: `boolean`
 
-Defined in: [packages/release-cargo/src/auth.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L42)
+Defined in: [packages/release-cargo/src/auth.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L42)
 
 Whether the status is of a success, 2xx.
 
@@ -26,7 +26,7 @@ Whether the status is of a success, 2xx.
 
 > `readonly` **status**: `number`
 
-Defined in: [packages/release-cargo/src/auth.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L44)
+Defined in: [packages/release-cargo/src/auth.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L44)
 
 The status of the answer.
 
@@ -36,7 +36,7 @@ The status of the answer.
 
 > **json**(): `Promise`\<`unknown`\>
 
-Defined in: [packages/release-cargo/src/auth.ts:50](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L50)
+Defined in: [packages/release-cargo/src/auth.ts:50](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L50)
 
 The body, read as JSON.
 
@@ -52,7 +52,7 @@ The parsed body.
 
 > **text**(): `Promise`\<`string`\>
 
-Defined in: [packages/release-cargo/src/auth.ts:56](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L56)
+Defined in: [packages/release-cargo/src/auth.ts:56](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L56)
 
 The body, read as text.
 

package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishing.md

@@ -6,7 +6,7 @@
 
 # Interface: TrustedPublishing
 
-Defined in: [packages/release-cargo/src/auth.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L72)
+Defined in: [packages/release-cargo/src/auth.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L72)
 
 What a release does of trusted publishing: it exchanges a token when it needs one, and revokes it.
 
@@ -16,7 +16,7 @@ What a release does of trusted publishing: it exchanges a token when it needs on
 
 > `readonly` **hidden**: readonly `string`[]
 
-Defined in: [packages/release-cargo/src/auth.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L76)
+Defined in: [packages/release-cargo/src/auth.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L76)
 
 The variables of the environment `cargo` is not given: the ID token.
 
@@ -26,7 +26,7 @@ The variables of the environment `cargo` is not given: the ID token.
 
 > `readonly` **tokenVariable**: `string`
 
-Defined in: [packages/release-cargo/src/auth.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L74)
+Defined in: [packages/release-cargo/src/auth.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L74)
 
 The variable the publish token is given to `cargo` in.
 
@@ -36,7 +36,7 @@ The variable the publish token is given to `cargo` in.
 
 > **exchange**(): `Promise`\<`string`\>
 
-Defined in: [packages/release-cargo/src/auth.ts:83](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L83)
+Defined in: [packages/release-cargo/src/auth.ts:83](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L83)
 
 Exchanges the ID token for a publish token.
 
@@ -56,7 +56,7 @@ The publish token, a secret.
 
 > **revoke**(`token`): `Promise`\<`void`\>
 
-Defined in: [packages/release-cargo/src/auth.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L90)
+Defined in: [packages/release-cargo/src/auth.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L90)
 
 Revokes a publish token, so it is of no use once the release is done.
 

package/api/@wtf/release-cargo/auth/interfaces/TrustedPublishingOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: TrustedPublishingOptions
 
-Defined in: [packages/release-cargo/src/auth.ts:119](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L119)
+Defined in: [packages/release-cargo/src/auth.ts:119](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L119)
 
 How [trustedPublishing](../functions/trustedPublishing.md) is made.
 
@@ -16,7 +16,7 @@ How [trustedPublishing](../functions/trustedPublishing.md) is made.
 
 > `readonly` `optional` **api?**: `string`
 
-Defined in: [packages/release-cargo/src/auth.ts:127](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L127)
+Defined in: [packages/release-cargo/src/auth.ts:127](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L127)
 
 The base URL of the registry's API: [CRATES\_IO\_API](../variables/CRATES_IO_API.md) by default.
 
@@ -26,7 +26,7 @@ The base URL of the registry's API: [CRATES\_IO\_API](../variables/CRATES_IO_API
 
 > `readonly` **fetch**: [`HttpFetch`](../type-aliases/HttpFetch.md)
 
-Defined in: [packages/release-cargo/src/auth.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L121)
+Defined in: [packages/release-cargo/src/auth.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L121)
 
 The `fetch` the requests are made by.
 
@@ -36,7 +36,7 @@ The `fetch` the requests are made by.
 
 > `readonly` **idToken**: `string`
 
-Defined in: [packages/release-cargo/src/auth.ts:123](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L123)
+Defined in: [packages/release-cargo/src/auth.ts:123](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L123)
 
 The ID token of the job, a secret.
 
@@ -46,7 +46,7 @@ The ID token of the job, a secret.
 
 > `readonly` `optional` **idTokenVariable?**: `string`
 
-Defined in: [packages/release-cargo/src/auth.ts:129](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L129)
+Defined in: [packages/release-cargo/src/auth.ts:129](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L129)
 
 The variable the ID token was read from, which `cargo` is not given.
 
@@ -56,6 +56,6 @@ The variable the ID token was read from, which `cargo` is not given.
 
 > `readonly` **tokenVariable**: `string`
 
-Defined in: [packages/release-cargo/src/auth.ts:125](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L125)
+Defined in: [packages/release-cargo/src/auth.ts:125](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L125)
 
 The variable `cargo` is given the publish token in: [tokenVariableOf](../functions/tokenVariableOf.md) of the registry.

package/api/@wtf/release-cargo/auth/type-aliases/HttpFetch.md

@@ -8,7 +8,7 @@
 
 > **HttpFetch** = (`url`, `init`) => `Promise`\<[`HttpResponse`](../interfaces/HttpResponse.md)\>
 
-Defined in: [packages/release-cargo/src/auth.ts:66](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L66)
+Defined in: [packages/release-cargo/src/auth.ts:66](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L66)
 
 The `fetch` a caller gives, of the part of it this package uses.
 

package/api/@wtf/release-cargo/auth/variables/CRATES_IO_API.md

@@ -8,6 +8,6 @@
 
 > `const` **CRATES\_IO\_API**: `"https://crates.io"` = `'https://crates.io'`
 
-Defined in: [packages/release-cargo/src/auth.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L31)
+Defined in: [packages/release-cargo/src/auth.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L31)
 
 The registry whose API trusted publishing is asked of by default.

package/api/@wtf/release-cargo/auth/variables/ID_TOKEN_VARIABLE.md

@@ -8,6 +8,6 @@
 
 > `const` **ID\_TOKEN\_VARIABLE**: `"CRATES_IO_ID_TOKEN"` = `'CRATES_IO_ID_TOKEN'`
 
-Defined in: [packages/release-cargo/src/auth.ts:34](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L34)
+Defined in: [packages/release-cargo/src/auth.ts:34](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L34)
 
 The variable of the environment that holds the ID token of the job, by default.

package/api/@wtf/release-cargo/auth/variables/USER_AGENT.md

@@ -8,6 +8,6 @@
 
 > `const` **USER\_AGENT**: `"@wtf/semantic-release-cargo"` = `'@wtf/semantic-release-cargo'`
 
-Defined in: [packages/release-cargo/src/auth.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/auth.ts#L37)
+Defined in: [packages/release-cargo/src/auth.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/auth.ts#L37)
 
 The `User-Agent` of the requests: crates.io asks every client to name itself.

package/api/@wtf/release-cargo/crates/functions/publishOrder.md

@@ -8,7 +8,7 @@
 
 > **publishOrder**(`crates`): [`Crate`](../../interfaces/Crate.md)[]
 
-Defined in: [packages/release-cargo/src/crates.ts:246](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/crates.ts#L246)
+Defined in: [packages/release-cargo/src/crates.ts:246](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/crates.ts#L246)
 
 The crates in the order to publish them in: each after the crates of the list that it depends on
 by a normal or a build dependency, those of no order between them by name. A dev-dependency is no

package/api/@wtf/release-cargo/crates/functions/publishable.md

@@ -8,7 +8,7 @@
 
 > **publishable**(`crate`, `registry?`): `boolean`
 
-Defined in: [packages/release-cargo/src/crates.ts:150](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/crates.ts#L150)
+Defined in: [packages/release-cargo/src/crates.ts:150](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/crates.ts#L150)
 
 Whether `crate` may be published to `registry`: not of `publish = false` (an empty list), and of
 a list, only where it names the registry; `crates-io` where none is named.

package/api/@wtf/release-cargo/crates/functions/readWorkspace.md

@@ -8,7 +8,7 @@
 
 > **readWorkspace**(`system`, `cwd`): `Promise`\<[`Workspace`](../../interfaces/Workspace.md)\>
 
-Defined in: [packages/release-cargo/src/crates.ts:93](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/crates.ts#L93)
+Defined in: [packages/release-cargo/src/crates.ts:93](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/crates.ts#L93)
 
 The workspace `cwd` is of, read by `cargo metadata --no-deps --format-version 1`: each crate of
 it, its version as its manifest says it now (an inherited one resolved), the registries it may be

package/api/@wtf/release-cargo/crates/functions/selectCrates.md

@@ -8,7 +8,7 @@
 
 > **selectCrates**(`crates`, `selection`): [`Crate`](../../interfaces/Crate.md)[]
 
-Defined in: [packages/release-cargo/src/crates.ts:187](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/crates.ts#L187)
+Defined in: [packages/release-cargo/src/crates.ts:187](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/crates.ts#L187)
 
 The crates a release publishes: those of its train that may be published to the registry, of
 `include` where it names some, but those of `exclude`. A crate of an option that the workspace

package/api/@wtf/release-cargo/crates/interfaces/Selection.md

@@ -6,7 +6,7 @@
 
 # Interface: Selection
 
-Defined in: [packages/release-cargo/src/crates.ts:154](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/crates.ts#L154)
+Defined in: [packages/release-cargo/src/crates.ts:154](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/crates.ts#L154)
 
 The names a selection of crates is made of.
 
@@ -16,7 +16,7 @@ The names a selection of crates is made of.
 
 > `readonly` `optional` **exclude?**: readonly `string`[]
 
-Defined in: [packages/release-cargo/src/crates.ts:163](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/crates.ts#L163)
+Defined in: [packages/release-cargo/src/crates.ts:163](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/crates.ts#L163)
 
 The crates not to publish, by name, of the ones `include` or the train gives.
 
@@ -26,7 +26,7 @@ The crates not to publish, by name, of the ones `include` or the train gives.
 
 > `readonly` `optional` **include?**: readonly `string`[]
 
-Defined in: [packages/release-cargo/src/crates.ts:161](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/crates.ts#L161)
+Defined in: [packages/release-cargo/src/crates.ts:161](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/crates.ts#L161)
 
 The crates to publish, by name: every publishable crate of the train by default.
 
@@ -36,7 +36,7 @@ The crates to publish, by name: every publishable crate of the train by default.
 
 > `readonly` `optional` **registry?**: `string`
 
-Defined in: [packages/release-cargo/src/crates.ts:165](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/crates.ts#L165)
+Defined in: [packages/release-cargo/src/crates.ts:165](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/crates.ts#L165)
 
 The registry the crates are published to: crates.io by default.
 
@@ -46,7 +46,7 @@ The registry the crates are published to: crates.io by default.
 
 > `readonly` **train**: `ReadonlySet`\<`string`\>
 
-Defined in: [packages/release-cargo/src/crates.ts:159](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/crates.ts#L159)
+Defined in: [packages/release-cargo/src/crates.ts:159](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/crates.ts#L159)
 
 The crates of the train of the release, by name, as `ownersOf` of `@wtf/release-trains/packages`
 gives them of the packages of `cargoEcosystem` of `./ecosystem`: the release publishes of these alone.

package/api/@wtf/release-cargo/ecosystem/functions/packagesAt.md

@@ -8,7 +8,7 @@
 
 > **packagesAt**(`ref`, `context`): `Promise`\<[`CargoPackage`](../interfaces/CargoPackage.md)[]\>
 
-Defined in: [packages/release-cargo/src/ecosystem.ts:102](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/ecosystem.ts#L102)
+Defined in: [packages/release-cargo/src/ecosystem.ts:102](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/ecosystem.ts#L102)
 
 The crates of the Cargo workspace of the repo of `context` at the commit `ref`, as
 [packagesOfWorkspace](packagesOfWorkspace.md) gives them: none where the commit has no Cargo.toml at its root.

package/api/@wtf/release-cargo/ecosystem/functions/packagesOfTree.md

@@ -8,7 +8,7 @@
 
 > **packagesOfTree**(`context`): `Promise`\<[`CargoPackage`](../interfaces/CargoPackage.md)[]\>
 
-Defined in: [packages/release-cargo/src/ecosystem.ts:139](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/ecosystem.ts#L139)
+Defined in: [packages/release-cargo/src/ecosystem.ts:139](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/ecosystem.ts#L139)
 
 The crates of the Cargo workspace of the repo of `context`, of its working tree, as
 [packagesOfWorkspace](packagesOfWorkspace.md) gives them: none where it has no Cargo.toml at its root.

package/api/@wtf/release-cargo/ecosystem/functions/packagesOfWorkspace.md

@@ -8,7 +8,7 @@
 
 > **packagesOfWorkspace**(`workspace`): [`CargoPackage`](../interfaces/CargoPackage.md)[]
 
-Defined in: [packages/release-cargo/src/ecosystem.ts:70](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/ecosystem.ts#L70)
+Defined in: [packages/release-cargo/src/ecosystem.ts:70](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/ecosystem.ts#L70)
 
 The crates of `workspace` as the trains read them: each a package of its folder and its
 Cargo.toml, from the root of the workspace; published unless `publish = false`; and each

package/api/@wtf/release-cargo/ecosystem/functions/resolveRequirement.md

@@ -8,7 +8,7 @@
 
 > **resolveRequirement**(`_requirement`, `version`): `string`
 
-Defined in: [packages/release-cargo/src/ecosystem.ts:194](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/ecosystem.ts#L194)
+Defined in: [packages/release-cargo/src/ecosystem.ts:194](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/ecosystem.ts#L194)
 
 The requirement a release publishes of a dependency on a crate of `version`, the release of its
 train: the version itself, as `stampWorkspace` of `./stamp` writes it, `version = "1.4.0"`, which

package/api/@wtf/release-cargo/ecosystem/functions/satisfiesRequirement.md

@@ -8,7 +8,7 @@
 
 > **satisfiesRequirement**(`requirement`, `version`): `boolean`
 
-Defined in: [packages/release-cargo/src/ecosystem.ts:181](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/ecosystem.ts#L181)
+Defined in: [packages/release-cargo/src/ecosystem.ts:181](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/ecosystem.ts#L181)
 
 Whether `version` is within `requirement`, by cargo's rules of requirements, as semver reads
 them once [semverRange](semverRange.md) writes them as npm does: a prerelease within its bounds too, as

package/api/@wtf/release-cargo/ecosystem/functions/semverRange.md

@@ -8,7 +8,7 @@
 
 > **semverRange**(`requirement`): `string`
 
-Defined in: [packages/release-cargo/src/ecosystem.ts:157](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/ecosystem.ts#L157)
+Defined in: [packages/release-cargo/src/ecosystem.ts:157](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/ecosystem.ts#L157)
 
 A requirement of cargo as npm writes a range, which semver reads: a comparator of no operator,
 as `1.2.3`, `1.2` or `1`, is cargo's caret, `^1.2.3`; `=`, `>`, `>=`, `<`, `<=`, `~`, `^` and

package/api/@wtf/release-cargo/ecosystem/interfaces/CargoPackage.md

@@ -6,7 +6,7 @@
 
 # Interface: CargoPackage
 
-Defined in: [packages/release-cargo/src/ecosystem.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/ecosystem.ts#L46)
+Defined in: [packages/release-cargo/src/ecosystem.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/ecosystem.ts#L46)
 
 A crate as the trains read it: a package of the trains, and the crate it is of.
 
@@ -20,7 +20,7 @@ A crate as the trains read it: a package of the trains, and the crate it is of.
 
 > `readonly` **crate**: [`Crate`](../../interfaces/Crate.md)
 
-Defined in: [packages/release-cargo/src/ecosystem.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/ecosystem.ts#L48)
+Defined in: [packages/release-cargo/src/ecosystem.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/ecosystem.ts#L48)
 
 The crate, as `readWorkspace` of `./crates` gives it.
 
@@ -30,7 +30,7 @@ The crate, as `readWorkspace` of `./crates` gives it.
 
 > `readonly` **dependencies**: readonly [`Dependency`](../../../release-trains/ecosystem/interfaces/Dependency.md)[]
 
-Defined in: [packages/release-trains/src/ecosystem.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-trains/src/ecosystem.ts#L76)
+Defined in: [packages/release-trains/src/ecosystem.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L76)
 
 Its dependencies on the other packages of its ecosystem in the repo.
 
@@ -44,7 +44,7 @@ Its dependencies on the other packages of its ecosystem in the repo.
 
 > `readonly` **dir**: `string`
 
-Defined in: [packages/release-trains/src/ecosystem.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-trains/src/ecosystem.ts#L67)
+Defined in: [packages/release-trains/src/ecosystem.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L67)
 
 Its folder, from the root of the repo, as `packages/core`; `.` of the root. A train holds it
 when the train's `paths` hold this folder.
@@ -59,7 +59,7 @@ when the train's `paths` hold this folder.
 
 > `readonly` **manifest**: `string`
 
-Defined in: [packages/release-trains/src/ecosystem.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-trains/src/ecosystem.ts#L69)
+Defined in: [packages/release-trains/src/ecosystem.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L69)
 
 Its manifest, from the root of the repo, as `packages/core/package.json`.
 
@@ -73,7 +73,7 @@ Its manifest, from the root of the repo, as `packages/core/package.json`.
 
 > `readonly` **name**: `string`
 
-Defined in: [packages/release-trains/src/ecosystem.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-trains/src/ecosystem.ts#L62)
+Defined in: [packages/release-trains/src/ecosystem.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L62)
 
 Its name, the one its ecosystem's registry knows it by: unique of the ecosystem in the repo.
 
@@ -87,7 +87,7 @@ Its name, the one its ecosystem's registry knows it by: unique of the ecosystem
 
 > `readonly` **published**: `boolean`
 
-Defined in: [packages/release-trains/src/ecosystem.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-trains/src/ecosystem.ts#L74)
+Defined in: [packages/release-trains/src/ecosystem.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-trains/src/ecosystem.ts#L74)
 
 Whether a release publishes it: not of an npm package that is private, nor of a crate of
 `publish = false`.

package/api/@wtf/release-cargo/ecosystem/variables/cargoEcosystem.md

@@ -8,7 +8,7 @@
 
 > `const` **cargoEcosystem**: [`Ecosystem`](../../../release-trains/ecosystem/interfaces/Ecosystem.md)
 
-Defined in: [packages/release-cargo/src/ecosystem.ts:203](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/ecosystem.ts#L203)
+Defined in: [packages/release-cargo/src/ecosystem.ts:203](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/ecosystem.ts#L203)
 
 The ecosystem of cargo: its packages, the crates of the Cargo workspace at the root of the repo,
 of the working tree ([packagesOfTree](../functions/packagesOfTree.md)), or of a commit ([packagesAt](../functions/packagesAt.md)), none of a repo

package/api/@wtf/release-cargo/errors/classes/CargoError.md

@@ -6,7 +6,7 @@
 
 # Class: CargoError
 
-Defined in: [packages/release-cargo/src/errors.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-cargo/src/errors.ts#L42)
+Defined in: [packages/release-cargo/src/errors.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-cargo/src/errors.ts#L42)
 
 An error of the crates, or of the options of the plugin over them: a stable `code`, of
 [CARGO\_ERRORS](../variables/CARGO_ERRORS.md) or of `SYSTEM_ERRORS` of `@wtf/release-system/errors`, its `message` what is
@@ -22,7 +22,7 @@ wrong, and its `details` how to fix it.
 
 > **new CargoError**(`code`, `message`, `details`): `CargoError`
 
-Defined in: [packages/release-system/src/errors.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-system/src/errors.ts#L54)
+Defined in: [packages/release-system/src/errors.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L54)
 
 An error of `code`, of its `message` and its `details`, named `SemanticReleaseError`, as
 semantic-release prints one.
@@ -73,7 +73,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/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-system/src/errors.ts#L40)
+Defined in: [packages/release-system/src/errors.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L40)
 
 The stable code of the error, as `EGIT`.
 
@@ -87,7 +87,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/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-system/src/errors.ts#L42)
+Defined in: [packages/release-system/src/errors.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L42)
 
 How to fix it.
 
@@ -125,7 +125,7 @@ Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/li
 
 > `readonly` **semanticRelease**: `true`
 
-Defined in: [packages/release-system/src/errors.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-system/src/errors.ts#L44)
+Defined in: [packages/release-system/src/errors.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/6bce751a5f77722140839fbd7f6f807cf78147e8/packages/release-system/src/errors.ts#L44)
 
 The mark semantic-release prints an error of a plugin by.