@wtf/release-docs 9.0.2 → 10.0.0

package/api/@wtf/semantic-release-go/variables/verifyRelease.md

@@ -0,0 +1,40 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-go](../README.md) / verifyRelease
+
+# Variable: verifyRelease
+
+> `const` **verifyRelease**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
+
+Defined in: [packages/semantic-release-go/src/index.ts:303](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-go/src/index.ts#L303)
+
+Runs the ecosystem's `verify`, which semantic-release can by this step, as it knows the version:
+the version is one Go tags a module of, and the path of each module of the release agrees with
+its major; from v2 on, Go needs the path to end in `/v<major>`, and a path that ends in `/vN`
+needs a release of the major N.
+
+## Parameters
+
+### pluginConfig
+
+[`GoPluginOptions`](../interfaces/GoPluginOptions.md)
+
+The plugin's options of the config, with `trains` of its root.
+
+### context
+
+`VerifyReleaseContext` & `OfRun`
+
+The context of semantic-release's `verifyRelease` step: the folder, the
+environment and the logger of the run, and the next release.
+
+## Returns
+
+`Promise`\<`void`\>
+
+## Throws
+
+`EGOSEMVER` of a version Go tags none of, `EGOMAJOR` of each module whose path does not
+agree with the major, together.

package/api/@wtf/semantic-release-maven/README.md

@@ -17,23 +17,35 @@ Maven (`mavenEcosystem` of `@wtf/release-maven/ecosystem`): the modules of the r
 modules of the train, whose `paths` hold their folder (`ownersOf` of
 `@wtf/release-trains/packages`).
 
+Each step maps semantic-release's onto the contract of `@wtf/release/contract`: a `Release` of
+the version of the next release, the dry run, the logger, and the folder and the platform of the
+run, each line and error of it named by the train (`runOf` of `@wtf/semantic-release`,
+`stepRelease` and `inTrain` of `@wtf/semantic-release/release`); and the plan of the train, by `planOf` of
+`@wtf/release-trains/plan`, whose `own` is the plugin's selection of the modules of the train
+(`selectArtifacts` and `publishOrder` of `@wtf/release-maven/artifacts`, of `include` and
+`exclude`), and whose `versions` hold each module of a train, those that do not deploy too, at
+the version of its train. Then it runs the step of the ecosystem of Maven:
+
 - `verifyConditions` checks the options, reads the poms, selects the modules the release deploys
-  and puts them in order, reads the last release of each other train, by its tags
-  (`releasedVersions` of `@wtf/release-trains/packages`), and finds the repository of each
-  module, so a repo that cannot be deployed fails before the tag;
-- `prepare` 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 (`stampModules`), and reads the poms again, so a module that is not at the version of its
-  train fails the run;
-- `publish` asks the repository of each module whether it has its pom, then deploys each it
-  lacks, in the order of their dependencies, by `mvn -B -N -f <dir>/pom.xml deploy`
-  (`deployModules`), and skips each it has, so a release that stopped part way is finished by
-  running it again; and records each module for the links of the release of the host
-  (`recordReleased` of `@wtf/release-trains/links`): its page on Maven Central, the repository it
-  was deployed to, as a Maven registry of GitLab, and its jar, where the build left one.
-
-A dry run of semantic-release runs `verifyConditions` alone of these: it skips `prepare` and
-`publish`, so it stamps and deploys nothing.
+  and puts them in order, and works out the plan, of no version yet, which reads the last release
+  of each other train, by its tags;
+- `verifyRelease` runs `verify`, once the version is known, which checks it by Maven's rules and
+  finds the repository of each module, so a repo that cannot be deployed fails before the tag;
+- `prepare` runs `prepare`, which 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, so a module that is not at the version of
+  its train fails the run;
+- `publish` runs `publish`, which asks the repository of each module whether it has its pom, then
+  deploys each it lacks, in the order of their dependencies, by `mvn -B -N -f <dir>/pom.xml
+  deploy`, and skips each it has, so a release that stopped part way is finished by running it
+  again, each module the release needs to build and neither deploys nor finds served installed
+  before it (`installsOf` of `@wtf/release-maven/artifacts`); and records each module for the
+  links of the release of the host (`recordReleased` of `@wtf/semantic-release/links`): its page
+  on Maven Central, the repository it was deployed to, as a Maven registry of GitLab, and its
+  jar, where the build left one.
+
+A dry run of semantic-release runs `verifyConditions` and `verifyRelease` alone of these: it skips
+`prepare` and `publish`, so it stamps and deploys nothing.
 
 Maven reads the credentials of the repository of the `<server>` of its settings of the
 repository's `id`, which the job writes, as `-s ci_settings.xml` of `args`. The plugin asks the
@@ -60,17 +72,23 @@ export default {
 
 ## Interfaces
 
-- [LookupAuth](interfaces/LookupAuth.md)
 - [MavenPluginOptions](interfaces/MavenPluginOptions.md)
 - [MavenRelease](interfaces/MavenRelease.md)
 
 ## Variables
 
 - [default](variables/default.md)
+- [prepare](variables/prepare.md)
+- [publish](variables/publish.md)
+- [verifyConditions](variables/verifyConditions.md)
+- [verifyRelease](variables/verifyRelease.md)
 
 ## Functions
 
 - [pomLookup](functions/pomLookup.md)
-- [prepare](functions/prepare.md)
-- [publish](functions/publish.md)
-- [verifyConditions](functions/verifyConditions.md)
+
+## References
+
+### LookupAuth
+
+Re-exports [LookupAuth](../release-maven/repository/interfaces/LookupAuth.md)

package/api/@wtf/semantic-release-maven/functions/pomLookup.md

@@ -8,10 +8,10 @@
 
 > **pomLookup**(`url`, `headers?`): `Promise`\<`boolean`\>
 
-Defined in: [packages/semantic-release-maven/src/index.ts:261](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L261)
+Defined in: [packages/semantic-release-maven/src/index.ts:262](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L262)
 
-Asks the repository at `url` whether it has the pom there, by a `HEAD` of `fetch` of the headers
-`headers`, which no error names.
+Asks the repository at `url` whether it has the pom there, by a `HEAD` of Node's `fetch` of the
+headers `headers`, which no error names (`lookupPom` of `@wtf/release-maven/repository`).
 
 ## Parameters
 

package/api/@wtf/semantic-release-maven/interfaces/MavenPluginOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: MavenPluginOptions
 
-Defined in: [packages/semantic-release-maven/src/index.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L95)
+Defined in: [packages/semantic-release-maven/src/index.ts:109](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L109)
 
 The options of the plugin, in the config of semantic-release or at its root.
 
@@ -16,7 +16,7 @@ The options of the plugin, in the config of semantic-release or at its root.
 
 > `readonly` `optional` **args?**: readonly `string`[]
 
-Defined in: [packages/semantic-release-maven/src/index.ts:131](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L131)
+Defined in: [packages/semantic-release-maven/src/index.ts:145](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L145)
 
 The arguments of each deploy after its goal, as `["-s", "ci_settings.xml", "-P", "release"]`.
 
@@ -26,7 +26,7 @@ The arguments of each deploy after its goal, as `["-s", "ci_settings.xml", "-P",
 
 > `readonly` `optional` **command?**: `string`
 
-Defined in: [packages/semantic-release-maven/src/index.ts:129](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L129)
+Defined in: [packages/semantic-release-maven/src/index.ts:143](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L143)
 
 Maven, as it is run: `mvn` by default, or a wrapper, as `./mvnw`.
 
@@ -36,7 +36,7 @@ Maven, as it is run: `mvn` by default, or a wrapper, as `./mvnw`.
 
 > `readonly` **ecosystems**: readonly `string`[]
 
-Defined in: [packages/semantic-release-maven/src/index.ts:104](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L104)
+Defined in: [packages/semantic-release-maven/src/index.ts:118](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L118)
 
 The ecosystems of the repo, of the root of the config, which the trains read the packages of:
 `'@wtf/semantic-release-maven/ecosystem'` or `'@wtf/release-maven'` among them, or
@@ -49,7 +49,7 @@ deploys.
 
 > `readonly` `optional` **exclude?**: readonly `string`[]
 
-Defined in: [packages/semantic-release-maven/src/index.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L113)
+Defined in: [packages/semantic-release-maven/src/index.ts:127](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L127)
 
 The modules of the train not to deploy, by `groupId:artifactId`, as a module of samples.
 
@@ -59,7 +59,7 @@ The modules of the train not to deploy, by `groupId:artifactId`, as a module of
 
 > `readonly` `optional` **include?**: readonly `string`[]
 
-Defined in: [packages/semantic-release-maven/src/index.ts:111](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L111)
+Defined in: [packages/semantic-release-maven/src/index.ts:125](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L125)
 
 The modules of the train to deploy, by `groupId:artifactId`: every module of it that deploys by
 default.
@@ -70,7 +70,7 @@ default.
 
 > `readonly` `optional` **lookup?**: `string`
 
-Defined in: [packages/semantic-release-maven/src/index.ts:125](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L125)
+Defined in: [packages/semantic-release-maven/src/index.ts:139](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L139)
 
 The base URL the plugin asks for each pom: where each module deploys by default. Maven
 Central, which deploys by the Central Portal, is read at `https://repo1.maven.org/maven2`.
@@ -79,9 +79,9 @@ Central, which deploys by the Central Portal, is read at `https://repo1.maven.or
 
 ### lookupAuth?
 
-> `readonly` `optional` **lookupAuth?**: [`LookupAuth`](LookupAuth.md)
+> `readonly` `optional` **lookupAuth?**: [`LookupAuth`](../../release-maven/repository/interfaces/LookupAuth.md)
 
-Defined in: [packages/semantic-release-maven/src/index.ts:127](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L127)
+Defined in: [packages/semantic-release-maven/src/index.ts:141](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L141)
 
 The header each lookup sends, and the variable of its value: none by default.
 
@@ -91,7 +91,7 @@ The header each lookup sends, and the variable of its value: none by default.
 
 > `readonly` `optional` **repository?**: [`Repository`](../../release-maven/repository/interfaces/Repository.md)
 
-Defined in: [packages/semantic-release-maven/src/index.ts:120](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L120)
+Defined in: [packages/semantic-release-maven/src/index.ts:134](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L134)
 
 The repository every module deploys to, as Maven's `altDeploymentRepository`, its `url` of
 `${env.NAME}` of the environment: by default, each module's own of its
@@ -100,21 +100,11 @@ The repository every module deploys to, as Maven's `altDeploymentRepository`, it
 
 ***
 
-### system?
-
-> `readonly` `optional` **system?**: [`SystemInput`](../../release-system/system/type-aliases/SystemInput.md)
-
-Defined in: [packages/semantic-release-maven/src/index.ts:133](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L133)
-
-The system the plugin runs by, over Node's.
-
-***
-
 ### train?
 
 > `readonly` `optional` **train?**: `string`
 
-Defined in: [packages/semantic-release-maven/src/index.ts:106](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L106)
+Defined in: [packages/semantic-release-maven/src/index.ts:120](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L120)
 
 The train of the run: `RELEASE_TRAIN` of the environment of the run by default.
 
@@ -124,6 +114,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-maven/src/index.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L97)
+Defined in: [packages/semantic-release-maven/src/index.ts:111](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L111)
 
 Every train of the repo: the modules of each are those whose folder its paths hold.

package/api/@wtf/semantic-release-maven/interfaces/MavenRelease.md

@@ -6,7 +6,7 @@
 
 # Interface: MavenRelease
 
-Defined in: [packages/semantic-release-maven/src/index.ts:137](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L137)
+Defined in: [packages/semantic-release-maven/src/index.ts:149](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L149)
 
 The release the plugin gives semantic-release of the modules deployed.
 
@@ -16,6 +16,6 @@ The release the plugin gives semantic-release of the modules deployed.
 
 > `readonly` **name**: `string`
 
-Defined in: [packages/semantic-release-maven/src/index.ts:139](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L139)
+Defined in: [packages/semantic-release-maven/src/index.ts:151](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L151)
 
 The repository and the modules, as `gitlab-maven (org.acme:core, org.acme:client)`.

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

@@ -6,11 +6,11 @@
 
 # @wtf/semantic-release-maven/schema
 
-The schema of the options of the plugin, as validators of `@wtf/release-system/validator`: each a
+The schema of the options of the plugin, as validators of `@wtf/release/validator`: each a
 Standard Schema, and a Standard JSON Schema of the JSON Schema of what it checks.
 
 - [mavenSchema](variables/mavenSchema.md): the options the plugin is given, of the root of the config, `trains`,
-  `ecosystems`, `train` and `system`, and of its entry, as it checks them;
+  `ecosystems` and `train`, and of its entry, as it checks them;
 - [mavenOptionsSchema](variables/mavenOptionsSchema.md): the options of its entry, `include`, `exclude`, `repository`,
   `lookup`, `lookupAuth`, `command` and `args`, its own;
 - [configSchema](variables/configSchema.md): this package's part of a whole config of semantic-release, each entry of

package/api/@wtf/semantic-release-maven/schema/type-aliases/MavenOptions.md

@@ -6,8 +6,8 @@
 
 # Type Alias: MavenOptions
 
-> **MavenOptions** = `Omit`\<[`MavenPluginOptions`](../../interfaces/MavenPluginOptions.md), `"train"` \| `"trains"` \| `"ecosystems"` \| `"system"`\>
+> **MavenOptions** = `Omit`\<[`MavenPluginOptions`](../../interfaces/MavenPluginOptions.md), `"train"` \| `"trains"` \| `"ecosystems"`\>
 
-Defined in: [packages/semantic-release-maven/src/schema.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/schema.ts#L40)
+Defined in: [packages/semantic-release-maven/src/schema.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/schema.ts#L40)
 
 The options of an entry of the plugin, its own: every one of the options but those of the root.

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

@@ -6,8 +6,8 @@
 
 # Variable: configSchema
 
-> `const` **configSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<`object`\>
+> `const` **configSchema**: [`Validator`](../../../release/validator/interfaces/Validator.md)\<`object`\>
 
-Defined in: [packages/semantic-release-maven/src/schema.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/schema.ts#L78)
+Defined in: [packages/semantic-release-maven/src/schema.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/schema.ts#L78)
 
 This package's part of a whole config of semantic-release: each entry of `plugins` of the plugin.

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

@@ -6,8 +6,8 @@
 
 # Variable: jsonSchema
 
-> `const` **jsonSchema**: [`JsonSchema`](../../../release-system/validator/type-aliases/JsonSchema.md)
+> `const` **jsonSchema**: [`JsonSchema`](../../../release/validator/type-aliases/JsonSchema.md)
 
-Defined in: [packages/semantic-release-maven/src/schema.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/schema.ts#L84)
+Defined in: [packages/semantic-release-maven/src/schema.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/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

@@ -6,8 +6,8 @@
 
 # Variable: mavenOptionsSchema
 
-> `const` **mavenOptionsSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`MavenOptions`](../type-aliases/MavenOptions.md)\>
+> `const` **mavenOptionsSchema**: [`Validator`](../../../release/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/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/schema.ts#L58)
+Defined in: [packages/semantic-release-maven/src/schema.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/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

@@ -6,9 +6,9 @@
 
 # Variable: mavenSchema
 
-> `const` **mavenSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`RootOptions`](../../../release-trains/schema/interfaces/RootOptions.md) & [`MavenOptions`](../type-aliases/MavenOptions.md)\>
+> `const` **mavenSchema**: [`Validator`](../../../release/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/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/schema.ts#L72)
+Defined in: [packages/semantic-release-maven/src/schema.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/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

@@ -8,7 +8,7 @@
 
 > **default**: `object`
 
-Defined in: [packages/semantic-release-maven/src/index.ts:506](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L506)
+Defined in: [packages/semantic-release-maven/src/index.ts:422](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L422)
 
 ## Type Declaration
 
@@ -16,10 +16,10 @@ Defined in: [packages/semantic-release-maven/src/index.ts:506](https://gitlab.co
 
 > **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.
+Runs `prepare` of the ecosystem: 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
 
@@ -42,18 +42,19 @@ and the logger of the run, and the next release.
 
 #### 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.
+`EDEPENDENCYNOTRAIN`, `EDEPENDENCYNORELEASE` and `EDEPENDENCYUNSATISFIED` of a dependency
+on a module of no release, `EMAVENSTAMP` of a pom that cannot be stamped, `EMAVENVERSION` of a
+version Maven does not release, or 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`).
+Runs `publish` of the ecosystem: 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`).
+Then it records each module deployed or skipped for the links of the release of the host.
 
 #### Parameters
 
@@ -91,10 +92,9 @@ lists `@wtf/semantic-release-maven/ecosystem` or `@wtf/release-maven` (`EMAVENEC
 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.
+train depend on has a release that satisfies it, by the trains' own checks
+(`EDEPENDENCYNOTRAIN`, `EDEPENDENCYNORELEASE`, `EDEPENDENCYUNSATISFIED`). It checks no version
+and no repository: `verifyRelease` does, once the version is known.
 
 #### Parameters
 
@@ -114,3 +114,32 @@ environment and the logger of the run.
 #### Returns
 
 `Promise`\<`void`\>
+
+### verifyRelease
+
+> **verifyRelease**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
+
+Runs `verify` of the ecosystem, once semantic-release knows the version of the release: that the
+version is one Maven releases (`EMAVENVERSION`), and 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. What it says and throws names the train.
+
+#### 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 `verifyRelease` step: the folder, the
+environment and the logger of the run, and the next release.
+
+#### Returns
+
+`Promise`\<`void`\>

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

@@ -0,0 +1,41 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-maven](../README.md) / prepare
+
+# Variable: prepare
+
+> `const` **prepare**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
+
+Defined in: [packages/semantic-release-maven/src/index.ts:343](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L343)
+
+Runs `prepare` of the ecosystem: 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
+
+`PrepareContext` & `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`, `EDEPENDENCYNORELEASE` and `EDEPENDENCYUNSATISFIED` of a dependency
+on a module of no release, `EMAVENSTAMP` of a pom that cannot be stamped, `EMAVENVERSION` of a
+version Maven does not release, or of a module at another version after the stamp.

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

@@ -0,0 +1,44 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-maven](../README.md) / publish
+
+# Variable: publish
+
+> `const` **publish**: (`pluginConfig`, `context`) => `Promise`\<[`MavenRelease`](../interfaces/MavenRelease.md) \| `false`\>
+
+Defined in: [packages/semantic-release-maven/src/index.ts:376](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L376)
+
+Runs `publish` of the ecosystem: 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`).
+Then it records each module deployed or skipped for the links of the release of the host.
+
+## Parameters
+
+### pluginConfig
+
+[`MavenPluginOptions`](../interfaces/MavenPluginOptions.md)
+
+The plugin's options of the config, with `trains` of its root.
+
+### context
+
+`PublishContext` & `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`\<[`MavenRelease`](../interfaces/MavenRelease.md) \| `false`\>
+
+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.

package/api/@wtf/semantic-release-maven/{functions → variables}/verifyConditions.md

@@ -4,21 +4,20 @@
 
 [Release trains](../../../README.md) / [@wtf/semantic-release-maven](../README.md) / verifyConditions
 
-# Function: verifyConditions()
+# Variable: verifyConditions
 
-> **verifyConditions**(`pluginConfig`, `context`): `Promise`\<`void`\>
+> `const` **verifyConditions**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
 
-Defined in: [packages/semantic-release-maven/src/index.ts:323](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-maven/src/index.ts#L323)
+Defined in: [packages/semantic-release-maven/src/index.ts:292](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L292)
 
 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.
+train depend on has a release that satisfies it, by the trains' own checks
+(`EDEPENDENCYNOTRAIN`, `EDEPENDENCYNORELEASE`, `EDEPENDENCYUNSATISFIED`). It checks no version
+and no repository: `verifyRelease` does, once the version is known.
 
 ## Parameters
 

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

@@ -0,0 +1,36 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-maven](../README.md) / verifyRelease
+
+# Variable: verifyRelease
+
+> `const` **verifyRelease**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
+
+Defined in: [packages/semantic-release-maven/src/index.ts:317](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-maven/src/index.ts#L317)
+
+Runs `verify` of the ecosystem, once semantic-release knows the version of the release: that the
+version is one Maven releases (`EMAVENVERSION`), and 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. What it says and throws names the train.
+
+## 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 `verifyRelease` step: the folder, the
+environment and the logger of the run, and the next release.
+
+## Returns
+
+`Promise`\<`void`\>