@wtf/release-docs 8.1.0 → 8.2.1

package/api/@wtf/semantic-release-maven/schema/variables/jsonSchema.md

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/semantic-release-maven/schema](../README.md) / jsonSchema
+
+# Variable: jsonSchema
+
+> `const` **jsonSchema**: [`JsonSchema`](../../../release-system/validator/type-aliases/JsonSchema.md)
+
+Defined in: [packages/semantic-release-maven/src/schema.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/schema.ts#L84)
+
+The JSON Schema of [configSchema](configSchema.md), as the package publishes it, `schema.json`.

package/api/@wtf/semantic-release-maven/schema/variables/mavenOptionsSchema.md

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/semantic-release-maven/schema](../README.md) / mavenOptionsSchema
+
+# Variable: mavenOptionsSchema
+
+> `const` **mavenOptionsSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`MavenOptions`](../type-aliases/MavenOptions.md)\>
+
+Defined in: [packages/semantic-release-maven/src/schema.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/schema.ts#L58)
+
+The validator of the options of an entry of the plugin, its own.

package/api/@wtf/semantic-release-maven/schema/variables/mavenSchema.md

@@ -0,0 +1,14 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/semantic-release-maven/schema](../README.md) / mavenSchema
+
+# Variable: mavenSchema
+
+> `const` **mavenSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`RootOptions`](../../../release-trains/schema/interfaces/RootOptions.md) & [`MavenOptions`](../type-aliases/MavenOptions.md)\>
+
+Defined in: [packages/semantic-release-maven/src/schema.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/schema.ts#L72)
+
+The validator of the options the plugin is given: the root's, `trains` and `ecosystems` required,
+and its own.

package/api/@wtf/semantic-release-maven/variables/default.md

@@ -0,0 +1,116 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-maven](../README.md) / default
+
+# Variable: default
+
+> **default**: `object`
+
+Defined in: [packages/semantic-release-maven/src/index.ts:432](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L432)
+
+## Type Declaration
+
+### prepare
+
+> **prepare**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
+
+Writes the version of the release into the poms of the train, and the last release of each other
+train into its poms, and each into the parents, dependencies and plugins that name them; and reads
+the poms again: a module that is not at the version of its train, as one whose version is of a
+property, fails the run here, before the tag's release.
+
+#### Parameters
+
+##### pluginConfig
+
+[`MavenPluginOptions`](../interfaces/MavenPluginOptions.md)
+
+The plugin's options of the config, with `trains` of its root.
+
+##### context
+
+`VerifyReleaseContext` & `OfRun`
+
+The context of semantic-release's `prepare` step: the folder, the environment
+and the logger of the run, and the next release.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Throws
+
+`EDEPENDENCYNOTRAIN` and `EDEPENDENCYNORELEASE` of a dependency on a module of no release,
+`EMAVENSTAMP` of a pom that cannot be stamped, `EMAVENVERSION` of a module at another version after
+the stamp.
+
+### publish
+
+> **publish**: (`pluginConfig`, `context`) => `Promise`\<`false` \| [`MavenRelease`](../interfaces/MavenRelease.md)\>
+
+Deploys each module of the release the repository lacks, in the order of their dependencies, at
+the version of the release; each the repository has already is skipped. A module the release
+needs to build and neither deploys nor finds served, as a test kit of `maven.deploy.skip`, is
+installed before it (`installsOf` of `@wtf/release-maven/artifacts`).
+
+#### Parameters
+
+##### pluginConfig
+
+[`MavenPluginOptions`](../interfaces/MavenPluginOptions.md)
+
+The plugin's options of the config, with `trains` of its root.
+
+##### context
+
+`VerifyReleaseContext` & `OfRun`
+
+The context of semantic-release's `publish` step: the folder, the environment
+and the logger of the run, and the next release.
+
+#### Returns
+
+`Promise`\<`false` \| [`MavenRelease`](../interfaces/MavenRelease.md)\>
+
+The release of the modules, named of the repository and each module, or `false` of none
+deployed or skipped.
+
+#### Throws
+
+`EMAVENVERSION` of a module not at the version, `EMAVENREPOSITORY` of a repository that
+cannot be asked, `EMAVENDEPLOY` of a deploy mvn fails.
+
+### verifyConditions
+
+> **verifyConditions**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
+
+Checks the options of the plugin, by `mavenSchema` of `./schema` (`EOPTIONS`), that `ecosystems`
+lists `@wtf/semantic-release-maven/ecosystem` or `@wtf/release-maven` (`EMAVENECOSYSTEM`), and the
+train of the run (`ETRAINNOTSELECTED`, `ETRAINUNKNOWN`); that the poms read, and the modules of the
+release select and order: `EMAVENPOM`, `EMAVENARTIFACTS`, `EMAVENPRIVATE`, `EMAVENORDER`; that no
+module is of two trains (`ETRAINOVERLAP`), and each module of another train the modules of the
+train depend on has a release, by the trains' own checks (`EDEPENDENCYNOTRAIN`,
+`EDEPENDENCYNORELEASE`); that each module has a repository to deploy to, of `repository` or of its
+pom, but of a `lookup` and no `repository`, and that the variable of `lookupAuth` is in the
+environment (`EMAVENREPOSITORY`), which a dry run only warns of. It asks the repository nothing.
+
+#### Parameters
+
+##### pluginConfig
+
+[`MavenPluginOptions`](../interfaces/MavenPluginOptions.md)
+
+The plugin's options of the config, with `trains` of its root.
+
+##### context
+
+`VerifyConditionsContext` & `OfRun`
+
+The context of semantic-release's `verifyConditions` step: the folder, the
+environment and the logger of the run.
+
+#### Returns
+
+`Promise`\<`void`\>

package/api/@wtf/semantic-release-npm/functions/addChannel.md

@@ -8,7 +8,7 @@
 
 > **addChannel**(`pluginConfig`, `context`): `Promise`\<`false` \| [`PublishedRelease`](../interfaces/PublishedRelease.md)\>
 
-Defined in: [packages/semantic-release-npm/src/index.ts:330](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L330)
+Defined in: [packages/semantic-release-npm/src/index.ts:355](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L355)
 
 Moves every package of the train at the version of the release to the dist-tag of its new
 channel, as semantic-release does to a release merged into the branch of another channel, and

package/api/@wtf/semantic-release-npm/functions/fail.md

@@ -8,7 +8,7 @@
 
 > **fail**(`pluginConfig`, `context`): `Promise`\<`void`\>
 
-Defined in: [packages/semantic-release-npm/src/index.ts:370](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L370)
+Defined in: [packages/semantic-release-npm/src/index.ts:395](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L395)
 
 Removes what `prepare` packed of the run, of its folder and its train, the copies and every
 tarball, of a `tarballDir` it is given too, of a run that fails after it, as semantic-release then

package/api/@wtf/semantic-release-npm/functions/loadPublisher.md

@@ -8,7 +8,7 @@
 
 > **loadPublisher**(`spec?`, `cwd`): `Promise`\<[`Publisher`](../../release-npm/interfaces/Publisher.md)\>
 
-Defined in: [packages/semantic-release-npm/src/index.ts:141](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L141)
+Defined in: [packages/semantic-release-npm/src/index.ts:141](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L141)
 
 The publisher of `spec`: a publisher itself; one built in, by its name; or the default export of
 a module, by its path from `cwd` (`./`, `../` or absolute), a `file:` URL, or the name of a

package/api/@wtf/semantic-release-npm/functions/prepare.md

@@ -8,7 +8,7 @@
 
 > **prepare**(`pluginConfig`, `context`): `Promise`\<`void`\>
 
-Defined in: [packages/semantic-release-npm/src/index.ts:254](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L254)
+Defined in: [packages/semantic-release-npm/src/index.ts:269](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L269)
 
 Resolves the manifest of each package of the train as it publishes, and packs each, before the
 tag: a range no release satisfies, a package that cannot be packed, or a release below the

package/api/@wtf/semantic-release-npm/functions/publish.md

@@ -8,7 +8,7 @@
 
 > **publish**(`pluginConfig`, `context`): `Promise`\<`false` \| [`PublishedRelease`](../interfaces/PublishedRelease.md)\>
 
-Defined in: [packages/semantic-release-npm/src/index.ts:300](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L300)
+Defined in: [packages/semantic-release-npm/src/index.ts:320](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L320)
 
 Publishes every package of the train at the version of the release, under the dist-tag of its
 channel, each the registry has already skipped, and gives the release of the train: named of

package/api/@wtf/semantic-release-npm/functions/verifyConditions.md

@@ -8,7 +8,7 @@
 
 > **verifyConditions**(`pluginConfig`, `context`): `Promise`\<`void`\>
 
-Defined in: [packages/semantic-release-npm/src/index.ts:233](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L233)
+Defined in: [packages/semantic-release-npm/src/index.ts:244](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L244)
 
 Checks, before the release, the options of the plugin, by `publishSchema` of `./schema`
 (`EOPTIONS`, and the codes of the trains); that the publisher loads; and the packages of the

package/api/@wtf/semantic-release-npm/interfaces/PublishPluginOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: PublishPluginOptions
 
-Defined in: [packages/semantic-release-npm/src/index.ts:98](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L98)
+Defined in: [packages/semantic-release-npm/src/index.ts:98](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L98)
 
 The options of the plugin, in the config of semantic-release or at its root.
 
@@ -20,7 +20,7 @@ The options of the plugin, in the config of semantic-release or at its root.
 
 > `readonly` `optional` **access?**: `"public"` \| `"restricted"`
 
-Defined in: [packages/release-npm/src/types.ts:148](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/types.ts#L148)
+Defined in: [packages/release-npm/src/types.ts:148](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/types.ts#L148)
 
 The access of each package: its `publishConfig.access` by default.
 
@@ -34,7 +34,7 @@ The access of each package: its `publishConfig.access` by default.
 
 > `readonly` `optional` **aside?**: readonly `string`[]
 
-Defined in: [packages/release-npm/src/types.ts:172](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/types.ts#L172)
+Defined in: [packages/release-npm/src/types.ts:172](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/types.ts#L172)
 
 The packages, by name, each published under the dist-tag of its major's line where its dist-tag
 points above the release, as one that joined the train at a higher version of its own:
@@ -52,7 +52,7 @@ other package whose dist-tag points above the release fails it, and nothing is p
 
 > `readonly` `optional` **check?**: `boolean`
 
-Defined in: [packages/release-npm/src/types.ts:164](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/types.ts#L164)
+Defined in: [packages/release-npm/src/types.ts:164](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/types.ts#L164)
 
 Whether the packages are checked before the first publish: `true`.
 
@@ -66,7 +66,7 @@ Whether the packages are checked before the first publish: `true`.
 
 > `readonly` `optional` **conditions?**: readonly `string`[]
 
-Defined in: [packages/release-npm/src/types.ts:162](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/types.ts#L162)
+Defined in: [packages/release-npm/src/types.ts:162](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/types.ts#L162)
 
 The export conditions of the source, which no tarball ships: `['source']`.
 
@@ -80,7 +80,7 @@ The export conditions of the source, which no tarball ships: `['source']`.
 
 > `readonly` `optional` **distTag?**: `string`
 
-Defined in: [packages/release-npm/src/types.ts:191](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/types.ts#L191)
+Defined in: [packages/release-npm/src/types.ts:191](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/types.ts#L191)
 
 The dist-tag every package is published under, over the one of the channel of the release, as a
 one-off: an empty one is none. The channel's by default.
@@ -95,7 +95,7 @@ one-off: an empty one is none. The channel's by default.
 
 > `readonly` **ecosystems**: readonly `string`[]
 
-Defined in: [packages/semantic-release-npm/src/index.ts:112](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L112)
+Defined in: [packages/semantic-release-npm/src/index.ts:112](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L112)
 
 The ecosystems of the repo, of the root of the config, which the trains read the packages of:
 this plugin publishes those of npm, whichever it names.
@@ -106,7 +106,7 @@ this plugin publishes those of npm, whichever it names.
 
 > `readonly` `optional` **first?**: `string`
 
-Defined in: [packages/release-npm/src/types.ts:158](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/types.ts#L158)
+Defined in: [packages/release-npm/src/types.ts:158](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/types.ts#L158)
 
 The folder of the package published first, as a base: none by default.
 
@@ -120,7 +120,7 @@ The folder of the package published first, as a base: none by default.
 
 > `readonly` `optional` **last?**: `string`
 
-Defined in: [packages/release-npm/src/types.ts:160](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/types.ts#L160)
+Defined in: [packages/release-npm/src/types.ts:160](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/types.ts#L160)
 
 The folder of the package published last, as a docs package: none by default.
 
@@ -134,7 +134,7 @@ The folder of the package published last, as a docs package: none by default.
 
 > `readonly` `optional` **pack?**: readonly `string`[]
 
-Defined in: [packages/release-npm/src/types.ts:186](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/types.ts#L186)
+Defined in: [packages/release-npm/src/types.ts:186](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/types.ts#L186)
 
 The private packages of the train, each by its folder, from the root of the repo, or a glob of
 folders, packed beside those that publish, into the folder of the tarballs, and never published:
@@ -152,7 +152,7 @@ resolved to it too. None by default.
 
 > `readonly` `optional` **provenance?**: `boolean` \| `"auto"`
 
-Defined in: [packages/release-npm/src/types.ts:154](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/types.ts#L154)
+Defined in: [packages/release-npm/src/types.ts:154](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/types.ts#L154)
 
 Whether each package is published with the provenance of the build: `auto`, the default, where
 the CI gives an ID token that npm signs it by (`SIGSTORE_ID_TOKEN` on GitLab, GitHub's OIDC),
@@ -168,7 +168,7 @@ on a runner it hosts: npm refuses provenance of a self-hosted runner.
 
 > `readonly` `optional` **publisher?**: [`PublisherSpec`](../type-aliases/PublisherSpec.md)
 
-Defined in: [packages/semantic-release-npm/src/index.ts:114](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L114)
+Defined in: [packages/semantic-release-npm/src/index.ts:114](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L114)
 
 The publisher: `npm` by default.
 
@@ -178,7 +178,7 @@ The publisher: `npm` by default.
 
 > `readonly` `optional` **registry?**: `string`
 
-Defined in: [packages/release-npm/src/types.ts:156](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/types.ts#L156)
+Defined in: [packages/release-npm/src/types.ts:156](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/types.ts#L156)
 
 The registry: each package's `publishConfig.registry`, or the publisher's, by default.
 
@@ -192,7 +192,7 @@ The registry: each package's `publishConfig.registry`, or the publisher's, by de
 
 > `readonly` `optional` **smoke?**: `boolean` \| [`SmokeOption`](SmokeOption.md)
 
-Defined in: [packages/semantic-release-npm/src/index.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L103)
+Defined in: [packages/semantic-release-npm/src/index.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L103)
 
 Whether `prepare` tries each package it packed as a consumer installs it, by `smokePacked` of
 `@wtf/release-npm/smoke`, before the tag: `true`, or how; `false` by default.
@@ -203,7 +203,7 @@ Whether `prepare` tries each package it packed as a consumer installs it, by `sm
 
 > `readonly` `optional` **system?**: [`SystemInput`](../../release-system/system/type-aliases/SystemInput.md)
 
-Defined in: [packages/semantic-release-npm/src/index.ts:116](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L116)
+Defined in: [packages/semantic-release-npm/src/index.ts:116](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L116)
 
 The system the plugin runs by, over Node's.
 
@@ -213,7 +213,7 @@ The system the plugin runs by, over Node's.
 
 > `readonly` `optional` **tarballDir?**: `string`
 
-Defined in: [packages/release-npm/src/types.ts:178](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/types.ts#L178)
+Defined in: [packages/release-npm/src/types.ts:178](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/types.ts#L178)
 
 The folder the tarballs are packed into, from the root of the repo or absolute, where they stay
 after the release, as assets of the release of the host: one of the system's temporary files by
@@ -229,7 +229,7 @@ default, which goes.
 
 > `readonly` `optional` **train?**: `string`
 
-Defined in: [packages/semantic-release-npm/src/index.ts:105](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L105)
+Defined in: [packages/semantic-release-npm/src/index.ts:105](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L105)
 
 The train of the run: `RELEASE_TRAIN` of the environment of the run by default.
 
@@ -239,6 +239,6 @@ The train of the run: `RELEASE_TRAIN` of the environment of the run by default.
 
 > `readonly` **trains**: [`Trains`](../../release-trains/type-aliases/Trains.md)
 
-Defined in: [packages/semantic-release-npm/src/index.ts:107](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L107)
+Defined in: [packages/semantic-release-npm/src/index.ts:107](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L107)
 
 Every train of the repo.

package/api/@wtf/semantic-release-npm/interfaces/PublishedRelease.md

@@ -6,7 +6,7 @@
 
 # Interface: PublishedRelease
 
-Defined in: [packages/semantic-release-npm/src/index.ts:166](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L166)
+Defined in: [packages/semantic-release-npm/src/index.ts:166](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L166)
 
 The release the plugin gives semantic-release of a train published, or moved to a channel.
 
@@ -16,7 +16,7 @@ The release the plugin gives semantic-release of a train published, or moved to
 
 > `readonly` `optional` **channel?**: `string`
 
-Defined in: [packages/semantic-release-npm/src/index.ts:172](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L172)
+Defined in: [packages/semantic-release-npm/src/index.ts:172](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L172)
 
 The dist-tag of the channel.
 
@@ -26,7 +26,7 @@ The dist-tag of the channel.
 
 > `readonly` **name**: `string`
 
-Defined in: [packages/semantic-release-npm/src/index.ts:168](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L168)
+Defined in: [packages/semantic-release-npm/src/index.ts:168](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L168)
 
 The publisher, and the packages it published or moved.
 
@@ -36,6 +36,6 @@ The publisher, and the packages it published or moved.
 
 > `readonly` `optional` **url?**: `string`
 
-Defined in: [packages/semantic-release-npm/src/index.ts:170](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L170)
+Defined in: [packages/semantic-release-npm/src/index.ts:170](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L170)
 
 The page of the first package that has one, on the registry.

package/api/@wtf/semantic-release-npm/interfaces/SmokeOption.md

@@ -6,7 +6,7 @@
 
 # Interface: SmokeOption
 
-Defined in: [packages/semantic-release-npm/src/index.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L92)
+Defined in: [packages/semantic-release-npm/src/index.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L92)
 
 How the plugin tries the packages it packed, as a consumer installs them, before the tag.
 
@@ -16,6 +16,6 @@ How the plugin tries the packages it packed, as a consumer installs them, before
 
 > `readonly` `optional` **forbid?**: readonly `string`[]
 
-Defined in: [packages/semantic-release-npm/src/index.ts:94](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L94)
+Defined in: [packages/semantic-release-npm/src/index.ts:94](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L94)
 
 Globs of the files no tarball may hold, from its root, as `**/*.tsbuildinfo`: none.

package/api/@wtf/semantic-release-npm/schema/type-aliases/PublishOptions.md

@@ -8,6 +8,6 @@
 
 > **PublishOptions** = `Omit`\<[`PublishPluginOptions`](../../interfaces/PublishPluginOptions.md), `"train"` \| `"trains"` \| `"ecosystems"` \| `"system"`\>
 
-Defined in: [packages/semantic-release-npm/src/schema.ts:33](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/schema.ts#L33)
+Defined in: [packages/semantic-release-npm/src/schema.ts:33](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/schema.ts#L33)
 
 The options of an entry of the plugin, its own.

package/api/@wtf/semantic-release-npm/schema/variables/configSchema.md

@@ -8,7 +8,7 @@
 
 > `const` **configSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<`object`\>
 
-Defined in: [packages/semantic-release-npm/src/schema.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/schema.ts#L85)
+Defined in: [packages/semantic-release-npm/src/schema.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/schema.ts#L85)
 
 This package's part of a whole config of semantic-release: each entry of `plugins` of the plugin,
 and `aside` at its root.

package/api/@wtf/semantic-release-npm/schema/variables/jsonSchema.md

@@ -8,6 +8,6 @@
 
 > `const` **jsonSchema**: [`JsonSchema`](../../../release-system/validator/type-aliases/JsonSchema.md)
 
-Defined in: [packages/semantic-release-npm/src/schema.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/schema.ts#L95)
+Defined in: [packages/semantic-release-npm/src/schema.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/schema.ts#L95)
 
 The JSON Schema of [configSchema](configSchema.md), as the package publishes it, `schema.json`.

package/api/@wtf/semantic-release-npm/schema/variables/publishOptionsSchema.md

@@ -8,6 +8,6 @@
 
 > `const` **publishOptionsSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`PublishOptions`](../type-aliases/PublishOptions.md)\>
 
-Defined in: [packages/semantic-release-npm/src/schema.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/schema.ts#L39)
+Defined in: [packages/semantic-release-npm/src/schema.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/schema.ts#L39)
 
 The validator of the options of an entry of the plugin, its own.

package/api/@wtf/semantic-release-npm/schema/variables/publishSchema.md

@@ -8,6 +8,6 @@
 
 > `const` **publishSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`RootOptions`](../../../release-trains/schema/interfaces/RootOptions.md) & [`PublishOptions`](../type-aliases/PublishOptions.md)\>
 
-Defined in: [packages/semantic-release-npm/src/schema.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/schema.ts#L76)
+Defined in: [packages/semantic-release-npm/src/schema.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/schema.ts#L76)
 
 The validator of the options the plugin is given: the root's, and its own.

package/api/@wtf/semantic-release-npm/type-aliases/PublisherSpec.md

@@ -8,7 +8,7 @@
 
 > **PublisherSpec** = `string` \| [`Publisher`](../../release-npm/interfaces/Publisher.md)
 
-Defined in: [packages/semantic-release-npm/src/index.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L89)
+Defined in: [packages/semantic-release-npm/src/index.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L89)
 
 A publisher as the option names it: `npm`, the default, or `pnpm`, built in; the path of a
 module, from the root of the repo, or the name of a package, whose default export is a publisher;

package/api/@wtf/semantic-release-npm/variables/default.md

@@ -8,7 +8,7 @@
 
 > **default**: `object`
 
-Defined in: [packages/semantic-release-npm/src/index.ts:383](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-npm/src/index.ts#L383)
+Defined in: [packages/semantic-release-npm/src/index.ts:408](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-npm/src/index.ts#L408)
 
 ## Type Declaration
 

package/api/@wtf/semantic-release-replace/functions/functionOf.md

@@ -8,7 +8,7 @@
 
 > **functionOf**(`spec`, `cwd`): `Promise`\<[`ReplaceFunction`](../../release-replace/type-aliases/ReplaceFunction.md)\>
 
-Defined in: [packages/semantic-release-replace/src/index.ts:166](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/index.ts#L166)
+Defined in: [packages/semantic-release-replace/src/index.ts:166](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-replace/src/index.ts#L166)
 
 The function `spec` names, its module imported once a process. Throws `EREPLACEMODULE` of a
 module that cannot be loaded, or an export of no function.

package/api/@wtf/semantic-release-replace/functions/prepare.md

@@ -8,7 +8,7 @@
 
 > **prepare**(`pluginConfig`, `context`): `Promise`\<`void`\>
 
-Defined in: [packages/semantic-release-replace/src/index.ts:305](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/index.ts#L305)
+Defined in: [packages/semantic-release-replace/src/index.ts:305](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-replace/src/index.ts#L305)
 
 Replaces each match of each replacement of each file of the plugin, and writes each file whose
 text changes, each said; and says so of none.

package/api/@wtf/semantic-release-replace/functions/templatesOf.md

@@ -8,7 +8,7 @@
 
 > **templatesOf**(`option`, `cwd`): `Promise`\<`Readonly`\<`Record`\<`string`, [`ReplacementOf`](../../release-replace/interfaces/ReplacementOf.md)\<[`PluginTo`](../schema/type-aliases/PluginTo.md)\>\>\>\>
 
-Defined in: [packages/semantic-release-replace/src/index.ts:210](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/index.ts#L210)
+Defined in: [packages/semantic-release-replace/src/index.ts:210](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-replace/src/index.ts#L210)
 
 The templates of `option`, of the root of the config or of an entry: each set, the export of a
 module (`exportedSetSchema` of `./schema`) or a map of each by its name, a replacement or the

package/api/@wtf/semantic-release-replace/functions/verifyConditions.md

@@ -8,7 +8,7 @@
 
 > **verifyConditions**(`pluginConfig`, `context`): `Promise`\<`void`\>
 
-Defined in: [packages/semantic-release-replace/src/index.ts:288](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/index.ts#L288)
+Defined in: [packages/semantic-release-replace/src/index.ts:288](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-replace/src/index.ts#L288)
 
 Checks the options of the plugin, by `replaceOptionsSchema` of `./schema`, and the templates of
 the root (`EOPTIONS`); imports each template, set of templates and function of a module

package/api/@wtf/semantic-release-replace/interfaces/ReplacePluginOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: ReplacePluginOptions
 
-Defined in: [packages/semantic-release-replace/src/index.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/index.ts#L88)
+Defined in: [packages/semantic-release-replace/src/index.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-replace/src/index.ts#L88)
 
 The options of the plugin: its own, and the system it runs by, of the root of the config.
 
@@ -20,7 +20,7 @@ The options of the plugin: its own, and the system it runs by, of the root of th
 
 > `readonly` **files**: readonly `string`[]
 
-Defined in: [packages/semantic-release-replace/src/schema.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L96)
+Defined in: [packages/semantic-release-replace/src/schema.ts:96](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-replace/src/schema.ts#L96)
 
 The files, from the root of the repo, of the files git tracks, in order: each a path, a glob,
 or of `!` first a negation of what the entries before it hold. A folder holds each file under
@@ -36,7 +36,7 @@ it.
 
 > `readonly` **replacements**: readonly [`PluginReplacementSpec`](../schema/type-aliases/PluginReplacementSpec.md)[]
 
-Defined in: [packages/semantic-release-replace/src/schema.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L101)
+Defined in: [packages/semantic-release-replace/src/schema.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-replace/src/schema.ts#L101)
 
 The replacements of each file, in order: each whole; or of a template, `{ template, … }`, each
 option beside its name over the template's own; or the name of a template alone.
@@ -51,7 +51,7 @@ option beside its name over the template's own; or the name of a template alone.
 
 > `readonly` `optional` **system?**: [`SystemInput`](../../release-system/system/type-aliases/SystemInput.md)
 
-Defined in: [packages/semantic-release-replace/src/index.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/index.ts#L90)
+Defined in: [packages/semantic-release-replace/src/index.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-replace/src/index.ts#L90)
 
 The system the plugin runs by, over Node's: see `@wtf/release-system/system`.
 
@@ -61,7 +61,7 @@ The system the plugin runs by, over Node's: see `@wtf/release-system/system`.
 
 > `readonly` `optional` **templates?**: [`TemplatesOption`](../schema/type-aliases/TemplatesOption.md)
 
-Defined in: [packages/semantic-release-replace/src/schema.ts:106](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-replace/src/schema.ts#L106)
+Defined in: [packages/semantic-release-replace/src/schema.ts:106](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-replace/src/schema.ts#L106)
 
 The templates a replacement names, each by its name, over those of the root of the config of
 the same name: a set, or sets merged in order; none by default.