@wtf/release-docs 9.0.2 → 10.0.0

package/api/@wtf/release-cargo/publish/interfaces/PublishCratesOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: PublishCratesOptions
 
-Defined in: [packages/release-cargo/src/publish.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L57)
+Defined in: [packages/release-cargo/src/publish.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L57)
 
 What a publish needs.
 
@@ -16,7 +16,7 @@ What a publish needs.
 
 > `readonly` `optional` **auth?**: [`TrustedPublishing`](../../auth/interfaces/TrustedPublishing.md)
 
-Defined in: [packages/release-cargo/src/publish.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L90)
+Defined in: [packages/release-cargo/src/publish.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L96)
 
 The trusted publishing of the registry, where the job has an ID token: the token `cargo`
 publishes by is exchanged of it and revoked after. None, `cargo` reads the token of its
@@ -28,19 +28,31 @@ environment.
 
 > `readonly` **crates**: readonly [`Crate`](../../interfaces/Crate.md)[]
 
-Defined in: [packages/release-cargo/src/publish.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L63)
+Defined in: [packages/release-cargo/src/publish.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L69)
 
 The crates to publish, in the order to publish them in, at `version` already.
 
 ***
 
-### cwd
+### cwd?
 
-> `readonly` **cwd**: `string`
+> `readonly` `optional` **cwd?**: `string`
 
-Defined in: [packages/release-cargo/src/publish.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L61)
+Defined in: [packages/release-cargo/src/publish.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L67)
 
-The folder of the workspace.
+The folder of the workspace, from the folder of the repo or absolute: the folder of the repo by
+default.
+
+***
+
+### dryRun?
+
+> `readonly` `optional` **dryRun?**: `boolean`
+
+Defined in: [packages/release-cargo/src/publish.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L101)
+
+Whether it publishes nothing: the registry is asked of every crate, and each it lacks is said,
+and given as published, with no `cargo publish` and no token exchanged. `false` by default.
 
 ***
 
@@ -48,7 +60,7 @@ The folder of the workspace.
 
 > `readonly` **log**: (`line`) => `void`
 
-Defined in: [packages/release-cargo/src/publish.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L96)
+Defined in: [packages/release-cargo/src/publish.ts:107](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L107)
 
 The log of the run, a line at a time.
 
@@ -70,7 +82,7 @@ The line to log, of no newline.
 
 > `readonly` **lookup**: (`name`, `version`) => `Promise`\<`boolean`\>
 
-Defined in: [packages/release-cargo/src/publish.ts:73](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L73)
+Defined in: [packages/release-cargo/src/publish.ts:79](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L79)
 
 Whether the registry has a crate at a version: the plugin asks the sparse index.
 
@@ -96,23 +108,24 @@ Whether the registry has it.
 
 ***
 
-### registry?
+### platform
 
-> `readonly` `optional` **registry?**: `string`
+> `readonly` **platform**: [`RepoPlatform`](../../../release/type-aliases/RepoPlatform.md)
 
-Defined in: [packages/release-cargo/src/publish.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L75)
+Defined in: [packages/release-cargo/src/publish.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L62)
 
-The registry, by the name of `.cargo/config.toml`: crates.io by default.
+The platform `cargo` runs by, of the folder of the repo as its working folder: its environment
+holds the registry's token.
 
 ***
 
-### system
+### registry?
 
-> `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
+> `readonly` `optional` **registry?**: `string`
 
-Defined in: [packages/release-cargo/src/publish.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L59)
+Defined in: [packages/release-cargo/src/publish.ts:81](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L81)
 
-The system `cargo` runs by: its environment holds the registry's token.
+The registry, by the name of `.cargo/config.toml`: crates.io by default.
 
 ***
 
@@ -120,7 +133,7 @@ The system `cargo` runs by: its environment holds the registry's token.
 
 > `readonly` `optional` **verify?**: `boolean`
 
-Defined in: [packages/release-cargo/src/publish.ts:77](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L77)
+Defined in: [packages/release-cargo/src/publish.ts:83](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L83)
 
 Whether cargo builds each crate before it publishes it: `true`.
 
@@ -130,7 +143,7 @@ Whether cargo builds each crate before it publishes it: `true`.
 
 > `readonly` **version**: `string`
 
-Defined in: [packages/release-cargo/src/publish.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L65)
+Defined in: [packages/release-cargo/src/publish.ts:71](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L71)
 
 The version of the release.
 
@@ -140,7 +153,7 @@ The version of the release.
 
 > `readonly` `optional` **wait?**: (`ms`) => `Promise`\<`void`\>
 
-Defined in: [packages/release-cargo/src/publish.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L84)
+Defined in: [packages/release-cargo/src/publish.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L90)
 
 Waits `ms` milliseconds, between the times the registry is asked again of a crate cargo says it
 has: the index of a registry lags a publish. None, it is asked again at once.

package/api/@wtf/release-cargo/publish/interfaces/PublishedCrate.md

@@ -6,7 +6,7 @@
 
 # Interface: PublishedCrate
 
-Defined in: [packages/release-cargo/src/publish.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L45)
+Defined in: [packages/release-cargo/src/publish.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L45)
 
 A crate of the release, and what became of it.
 
@@ -16,7 +16,7 @@ A crate of the release, and what became of it.
 
 > `readonly` **name**: `string`
 
-Defined in: [packages/release-cargo/src/publish.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L47)
+Defined in: [packages/release-cargo/src/publish.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L47)
 
 The name of the crate.
 
@@ -26,7 +26,7 @@ The name of the crate.
 
 > `readonly` **status**: [`CrateStatus`](../type-aliases/CrateStatus.md)
 
-Defined in: [packages/release-cargo/src/publish.ts:51](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L51)
+Defined in: [packages/release-cargo/src/publish.ts:51](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L51)
 
 Whether it was published, or skipped as the registry has it.
 
@@ -36,7 +36,7 @@ Whether it was published, or skipped as the registry has it.
 
 > `readonly` `optional` **url?**: `string`
 
-Defined in: [packages/release-cargo/src/publish.ts:53](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L53)
+Defined in: [packages/release-cargo/src/publish.ts:53](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L53)
 
 Its page on the registry, where this package knows it.
 
@@ -46,6 +46,6 @@ Its page on the registry, where this package knows it.
 
 > `readonly` **version**: `string`
 
-Defined in: [packages/release-cargo/src/publish.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L49)
+Defined in: [packages/release-cargo/src/publish.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L49)
 
 The version of the release, of the crate.

package/api/@wtf/release-cargo/publish/type-aliases/CrateStatus.md

@@ -8,6 +8,6 @@
 
 > **CrateStatus** = `"published"` \| `"skipped"`
 
-Defined in: [packages/release-cargo/src/publish.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L42)
+Defined in: [packages/release-cargo/src/publish.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L42)
 
 What happened to a crate of the release.

package/api/@wtf/release-cargo/publish/variables/RECHECK_WAITS.md

@@ -8,6 +8,6 @@
 
 > `const` **RECHECK\_WAITS**: readonly `number`[]
 
-Defined in: [packages/release-cargo/src/publish.ts:110](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/publish.ts#L110)
+Defined in: [packages/release-cargo/src/publish.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/publish.ts#L121)
 
 The waits, in milliseconds, before each time the registry is asked again of a crate.

package/api/@wtf/release-cargo/registry/README.md

@@ -6,9 +6,10 @@
 
 # @wtf/release-cargo/registry
 
-What a registry's sparse index says of a crate, of no network: where the index keeps a crate
-([indexPath](functions/indexPath.md)), whether the file it holds lists a version ([indexHasVersion](functions/indexHasVersion.md)), and
-where a crate has its page ([crateUrl](functions/crateUrl.md)). The caller fetches the file; a release asks of
+What a registry's sparse index says of a crate: where the index keeps a crate
+([indexPath](functions/indexPath.md)), whether the file it holds lists a version ([indexHasVersion](functions/indexHasVersion.md)), of no
+network; whether the index has a crate at a version, asked by the `fetch` the caller gives
+([indexLookup](functions/indexLookup.md)); and where a crate has its page ([crateUrl](functions/crateUrl.md)). A release asks of
 crates.io's index, `https://index.crates.io`, by default.
 
 ```ts
@@ -26,4 +27,5 @@ console.log(indexHasVersion('{"name":"a","vers":"1.0.0","yanked":false}\n', '1.0
 
 - [crateUrl](functions/crateUrl.md)
 - [indexHasVersion](functions/indexHasVersion.md)
+- [indexLookup](functions/indexLookup.md)
 - [indexPath](functions/indexPath.md)

package/api/@wtf/release-cargo/registry/functions/crateUrl.md

@@ -8,7 +8,7 @@
 
 > **crateUrl**(`name`, `version`, `registry?`): `string` \| `undefined`
 
-Defined in: [packages/release-cargo/src/registry.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/registry.ts#L63)
+Defined in: [packages/release-cargo/src/registry.ts:107](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/registry.ts#L107)
 
 The page of a crate at a version on crates.io, which a release links; `undefined` of another
 registry, whose pages this package does not know.

package/api/@wtf/release-cargo/registry/functions/indexHasVersion.md

@@ -8,7 +8,7 @@
 
 > **indexHasVersion**(`text`, `version`): `boolean`
 
-Defined in: [packages/release-cargo/src/registry.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/registry.ts#L43)
+Defined in: [packages/release-cargo/src/registry.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/registry.ts#L46)
 
 Whether the file of a crate in a sparse index, a line of JSON for each version, lists `version`.
 A yanked version is listed: it is published, and cannot be published again.

package/api/@wtf/release-cargo/registry/functions/indexLookup.md

@@ -0,0 +1,50 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-cargo/registry](../README.md) / indexLookup
+
+# Function: indexLookup()
+
+> **indexLookup**(`fetch`, `index`, `name`, `version`): `Promise`\<`boolean`\>
+
+Defined in: [packages/release-cargo/src/registry.ts:68](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/registry.ts#L68)
+
+Asks the sparse index `index` whether it has `name` at `version`, by `fetch`: of no file, a crate
+that was never published.
+
+## Parameters
+
+### fetch
+
+[`HttpFetch`](../../auth/type-aliases/HttpFetch.md)
+
+The `fetch` the index is asked by, as the platform's.
+
+### index
+
+`string`
+
+The base URL of the index.
+
+### name
+
+`string`
+
+The name of the crate.
+
+### version
+
+`string`
+
+The version asked of.
+
+## Returns
+
+`Promise`\<`boolean`\>
+
+Whether the index lists it.
+
+## Throws
+
+`ECRATESIO` of an index that cannot be reached, or answers of neither a file nor none.

package/api/@wtf/release-cargo/registry/functions/indexPath.md

@@ -8,7 +8,7 @@
 
 > **indexPath**(`name`): `string`
 
-Defined in: [packages/release-cargo/src/registry.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/registry.ts#L28)
+Defined in: [packages/release-cargo/src/registry.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/registry.ts#L31)
 
 Where a sparse index keeps the file of a crate, by its name, lower-cased: `1/a`, `2/ab`,
 `3/a/abc`, and `ab/cd/abcdef` of a longer name.

package/api/@wtf/release-cargo/registry/variables/CRATES_IO_INDEX.md

@@ -8,6 +8,6 @@
 
 > `const` **CRATES\_IO\_INDEX**: `"https://index.crates.io"` = `'https://index.crates.io'`
 
-Defined in: [packages/release-cargo/src/registry.ts:19](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-cargo/src/registry.ts#L19)
+Defined in: [packages/release-cargo/src/registry.ts:22](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/registry.ts#L22)
 
 The index of crates.io, which the plugin asks by default.

package/api/@wtf/release-cargo/release/README.md

@@ -0,0 +1,54 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/release-cargo/release
+
+# @wtf/release-cargo/release
+
+The release of the crates of a plan, by the steps of the contract of `@wtf/release/contract`,
+which the ecosystem of cargo, the default export of the package, gives a driver: each step takes
+the release, its plan, the crates that publish in order (`own`) and the version of each crate of
+the repo (`versions`), and the options of cargo ([CargoOptions](interfaces/CargoOptions.md)). It knows no train and no
+release tool: the driver works out the plan, as `planOf` of `@wtf/release-trains/plan` does of a
+train.
+
+- [verifyCrates](functions/verifyCrates.md) checks the version of the release, which cargo takes of semver alone, the
+  options, the crates the release publishes and their order, and the credentials of the registry;
+- [prepareCrates](functions/prepareCrates.md) stamps the version of each crate of the plan into the manifests of the
+  workspace, and the dependencies on it, and gives the manifests it wrote;
+- [publishPlan](functions/publishPlan.md) publishes each crate of the release the registry lacks, in the order of the
+  plan, and gives each crate published or found published, by its page on crates.io, or the file
+  `cargo publish` packed of it.
+
+A dry run writes and publishes nothing: `prepareCrates` gives the manifests it would write, and
+`publishPlan` asks the registry alone.
+
+```ts
+import type { Release } from '@wtf/release/contract'
+import cargo from '@wtf/release-cargo'
+
+// The crates of the working tree, each of the version of the release, released to crates.io.
+export async function releaseAll(release: Release) {
+  const own = (await cargo.packages(release)).filter(({ published }) => published)
+  const plan = { own, versions: new Map(own.map(({ name }) => [name, release.version])) }
+  await cargo.verify(release, plan, {})
+  await cargo.prepare(release, plan, {})
+  return cargo.publish(release, plan, {})
+}
+```
+
+## Interfaces
+
+- [CargoOptions](interfaces/CargoOptions.md)
+
+## Type Aliases
+
+- [CargoPlan](type-aliases/CargoPlan.md)
+
+## Functions
+
+- [prepareCrates](functions/prepareCrates.md)
+- [publishedOf](functions/publishedOf.md)
+- [publishPlan](functions/publishPlan.md)
+- [verifyCrates](functions/verifyCrates.md)

package/api/@wtf/release-cargo/release/functions/prepareCrates.md

@@ -0,0 +1,42 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-cargo/release](../README.md) / prepareCrates
+
+# Function: prepareCrates()
+
+> **prepareCrates**(`release`, `plan`): `Promise`\<`string`[]\>
+
+Defined in: [packages/release-cargo/src/release.ts:272](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/release.ts#L272)
+
+Writes the version of each crate of `versions` of the plan into the manifests of the workspace,
+the root's and each crate's, and into each dependency on it (`stampWorkspace` of `./stamp`); and
+reads the workspace again: a crate that is not at its version, as one that sets its own in a form
+the stamp does not read, fails the release (`ECRATEVERSION`). A dry run writes nothing, and gives
+the manifests it would write.
+
+## Parameters
+
+### release
+
+[`Release`](../../../release/contract/interfaces/Release.md)
+
+The release: its folder, its platform, whether it is a dry run, and its log.
+
+### plan
+
+[`CargoPlan`](../type-aliases/CargoPlan.md)
+
+The plan of the release: the version of each crate of the repo.
+
+## Returns
+
+`Promise`\<`string`[]\>
+
+The manifests written, from the root of the repo, as `crates/core/Cargo.toml`.
+
+## Throws
+
+`ESTAMP` of a manifest that cannot be stamped, `ECRATEVERSION` of a crate at another
+version after the stamp.

package/api/@wtf/release-cargo/release/functions/publishPlan.md

@@ -0,0 +1,53 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-cargo/release](../README.md) / publishPlan
+
+# Function: publishPlan()
+
+> **publishPlan**(`release`, `plan`, `options`): `Promise`\<[`Released`](../../../release/forge/interfaces/Released.md)[]\>
+
+Defined in: [packages/release-cargo/src/release.ts:346](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/release.ts#L346)
+
+Publishes each crate of the release the registry lacks, in the order of `own` of the plan, at the
+version of the release, and skips each it has, so a release that stopped part way is finished by
+running it again (`publishCrates` of `./publish`). It reads the workspace again, and fails of a
+crate that is not at the version (`ECRATEVERSION`); it asks the sparse index of the registry,
+`https://index.crates.io` by default, which versions exist, by the platform's `fetch`; and it
+publishes by the credentials of the environment: an ID token, exchanged for a publish token by
+the registry's trusted publishing as late as it can be and revoked after, else the token cargo
+reads. A dry run asks the registry alone, and publishes nothing.
+
+## Parameters
+
+### release
+
+[`Release`](../../../release/contract/interfaces/Release.md)
+
+The release: its version, its platform, whether it is a dry run, and its log.
+
+### plan
+
+[`CargoPlan`](../type-aliases/CargoPlan.md)
+
+The plan of the release: its crates, in order.
+
+### options
+
+[`CargoOptions`](../interfaces/CargoOptions.md)
+
+The options of the release.
+
+## Returns
+
+`Promise`\<[`Released`](../../../release/forge/interfaces/Released.md)[]\>
+
+Each crate published or found published: its page on crates.io, or the file
+`cargo publish` packed of it, of another registry.
+
+## Throws
+
+`ECRATEVERSION` of a crate not at the version, `ECRATESIO` of an index that cannot be
+asked, `ECRATEAUTH` of a registry that refuses the ID token, `ECRATEPUBLISH` of a publish cargo
+fails.

package/api/@wtf/release-cargo/release/functions/publishedOf.md

@@ -0,0 +1,36 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-cargo/release](../README.md) / publishedOf
+
+# Function: publishedOf()
+
+> **publishedOf**(`plan`, `options`): [`CargoPackage`](../../ecosystem/interfaces/CargoPackage.md)[]
+
+Defined in: [packages/release-cargo/src/release.ts:126](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/release.ts#L126)
+
+The crates of `plan` a release of `options` publishes, in its order: each of `own` that may be
+published to the registry, of `include` where it names some, but those of `exclude`. It checks
+nothing and reads nothing, as a driver says what a release will publish; [verifyCrates](verifyCrates.md)
+checks the options.
+
+## Parameters
+
+### plan
+
+[`CargoPlan`](../type-aliases/CargoPlan.md)
+
+The plan of the release.
+
+### options
+
+[`CargoOptions`](../interfaces/CargoOptions.md)
+
+The options of the release.
+
+## Returns
+
+[`CargoPackage`](../../ecosystem/interfaces/CargoPackage.md)[]
+
+The packages of the crates, in the order of `own`.

package/api/@wtf/release-cargo/release/functions/verifyCrates.md

@@ -0,0 +1,44 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-cargo/release](../README.md) / verifyCrates
+
+# Function: verifyCrates()
+
+> **verifyCrates**(`release`, `plan`, `options`): `Promise`\<`void`\>
+
+Defined in: [packages/release-cargo/src/release.ts:211](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/release.ts#L211)
+
+Checks a release of the crates of `plan` before anything is written: that its version is a
+version of semver (`ECRATESEMVER`), which cargo takes alone; that a `registry` other than
+crates.io has its `index` (`EOPTIONS`); that the workspace reads by `cargo metadata` (`ECARGO`),
+and the options select crates of the plan (`ECRATES`), none of which depends on a crate published
+nowhere (`ECRATEPRIVATE`), nor on another in a cycle (`ECRATEORDER`); and, of a release that
+publishes a crate, that its environment holds a credential, an ID token or a token
+(`ECRATEAUTH`), which a dry run needs none of, and warns so, and of an ID token and a `registry`
+other than crates.io, its `registryApi` (`EOPTIONS`). It asks the registry nothing.
+
+## Parameters
+
+### release
+
+[`Release`](../../../release/contract/interfaces/Release.md)
+
+The release: its version, its platform, whether it is a dry run, and its log.
+
+### plan
+
+[`CargoPlan`](../type-aliases/CargoPlan.md)
+
+The plan of the release: its crates, in order.
+
+### options
+
+[`CargoOptions`](../interfaces/CargoOptions.md)
+
+The options of the release.
+
+## Returns
+
+`Promise`\<`void`\>

package/api/@wtf/release-cargo/release/interfaces/CargoOptions.md

@@ -0,0 +1,89 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-cargo/release](../README.md) / CargoOptions
+
+# Interface: CargoOptions
+
+Defined in: [packages/release-cargo/src/release.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/release.ts#L60)
+
+The options of a release of crates, each its own of cargo.
+
+## Extended by
+
+- [`CargoPluginOptions`](../../../semantic-release-cargo/interfaces/CargoPluginOptions.md)
+
+## Properties
+
+### exclude?
+
+> `readonly` `optional` **exclude?**: readonly `string`[]
+
+Defined in: [packages/release-cargo/src/release.ts:64](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/release.ts#L64)
+
+The crates of the plan not to publish, by name, as an example.
+
+***
+
+### idToken?
+
+> `readonly` `optional` **idToken?**: `string`
+
+Defined in: [packages/release-cargo/src/release.ts:81](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/release.ts#L81)
+
+The variable of the environment that holds the ID token of the job, for trusted publishing:
+`CRATES_IO_ID_TOKEN`.
+
+***
+
+### include?
+
+> `readonly` `optional` **include?**: readonly `string`[]
+
+Defined in: [packages/release-cargo/src/release.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/release.ts#L62)
+
+The crates of the plan to publish, by name: every crate of it that may be published by default.
+
+***
+
+### index?
+
+> `readonly` `optional` **index?**: `string`
+
+Defined in: [packages/release-cargo/src/release.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/release.ts#L74)
+
+The base URL of the sparse index of the registry, which the release asks which versions exist:
+`https://index.crates.io` by default, and required of a `registry` that is not crates.io.
+
+***
+
+### registry?
+
+> `readonly` `optional` **registry?**: `string`
+
+Defined in: [packages/release-cargo/src/release.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/release.ts#L69)
+
+The registry, by the name of `.cargo/config.toml`: crates.io by default, which `crates-io`
+names too.
+
+***
+
+### registryApi?
+
+> `readonly` `optional` **registryApi?**: `string`
+
+Defined in: [packages/release-cargo/src/release.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/release.ts#L86)
+
+The base URL of the API of the registry, where the ID token is exchanged: `https://crates.io`.
+Required of an ID token and a `registry` that is not crates.io.
+
+***
+
+### verify?
+
+> `readonly` `optional` **verify?**: `boolean`
+
+Defined in: [packages/release-cargo/src/release.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/release.ts#L76)
+
+Whether cargo builds each crate before it publishes it: `true`.

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

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-cargo/release](../README.md) / CargoPlan
+
+# Type Alias: CargoPlan
+
+> **CargoPlan** = [`Plan`](../../../release/contract/interfaces/Plan.md)\<[`CargoPackage`](../../ecosystem/interfaces/CargoPackage.md)\>
+
+Defined in: [packages/release-cargo/src/release.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-cargo/src/release.ts#L90)
+
+The plan of a release of crates: its crates, each of the crate it is of.