@wtf/release-docs 8.1.0 → 8.2.1

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

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

package/api/@wtf/{semantic-release-trains-changelog → semantic-release-go}/schema/variables/jsonSchema.md

@@ -2,12 +2,12 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/semantic-release-trains-changelog/schema](../README.md) / jsonSchema
+[Release trains](../../../../README.md) / [@wtf/semantic-release-go/schema](../README.md) / jsonSchema
 
 # Variable: jsonSchema
 
 > `const` **jsonSchema**: [`JsonSchema`](../../../release-system/validator/type-aliases/JsonSchema.md)
 
-Defined in: [packages/semantic-release-trains-changelog/src/schema.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains-changelog/src/schema.ts#L61)
+Defined in: [packages/semantic-release-go/src/schema.ts:64](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-go/src/schema.ts#L64)
 
 The JSON Schema of [configSchema](configSchema.md), as the package publishes it, `schema.json`.

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

@@ -0,0 +1,144 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-go](../README.md) / default
+
+# Variable: default
+
+> **default**: `object`
+
+Defined in: [packages/semantic-release-go/src/index.ts:363](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-go/src/index.ts#L363)
+
+## Type Declaration
+
+### prepare
+
+> **prepare**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
+
+Checks the majors again, writes the version of the release into each require of a module of the
+train, and the last release of each other train into each require of its modules, in every go.mod
+of the repo; and reads them again: a require that is not at the version of its train fails the
+run here, before the tags.
+
+#### 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 `prepare` step: the folder, the environment
+and the logger of the run, and the next release.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Throws
+
+`EGOMAJOR` of a path that does not agree with the major, `EDEPENDENCYNOTRAIN` and
+`EDEPENDENCYNORELEASE` of a require of a module of no release, `EGOVERSION` of a require at
+another version after the stamp.
+
+### publish
+
+> **publish**: (`pluginConfig`, `context`) => `Promise`\<`false` \| [`GoRelease`](../interfaces/GoRelease.md)\>
+
+Tags the modules of the release: a commit of the stamped go.mod files on top of `HEAD`, on no
+branch, tagged with the tag of each module the remote lacks, and the tags pushed to
+`repositoryUrl` of the run in one atomic push; each the remote has is skipped. Then, of the option
+`proxy`, asks the Go proxy for each module at its version.
+
+#### 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 `publish` step: the folder, the environment,
+the options and the logger of the run, and the next release.
+
+#### Returns
+
+`Promise`\<`false` \| [`GoRelease`](../interfaces/GoRelease.md)\>
+
+The release of the modules, named of each module, and of `proxy` linked to the first's
+page on pkg.go.dev; `false` of a train of no module to tag.
+
+#### Throws
+
+`EGOVERSION` of a require not at its version, `EGOTAG` of a remote that cannot be asked or
+a tag that cannot be made or pushed, `EGOPROXY` of a module the proxy cannot give.
+
+### verifyConditions
+
+> **verifyConditions**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
+
+Checks the options of the plugin, by `goSchema` of `./schema` (`EOPTIONS`), that `ecosystems`
+lists `@wtf/semantic-release-go/ecosystem` or `@wtf/release-go` (`EGOECOSYSTEM`), and the train of
+the run (`ETRAINNOTSELECTED`, `ETRAINUNKNOWN`); that the go.mod files read and the modules select:
+`EGOMOD`, `EGOMODULES`, `EGOPRIVATE`; that no module is of two trains (`ETRAINOVERLAP`), and each
+module of another train the modules of the train require has a release, by the trains' own checks
+(`EDEPENDENCYNOTRAIN`, `EDEPENDENCYNORELEASE`). It asks the remote nothing.
+
+#### Parameters
+
+##### pluginConfig
+
+[`GoPluginOptions`](../interfaces/GoPluginOptions.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`\>
+
+### verifyRelease
+
+> **verifyRelease**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
+
+Checks the path of each module of the release against the major of its version, which semantic-
+release knows by this step: 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
+
+`EGOMAJOR` of each module whose path does not agree with the major, together.

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

@@ -0,0 +1,74 @@
+[**Release trains**](../../README.md)
+
+***
+
+[Release trains](../../README.md) / @wtf/semantic-release-maven
+
+# @wtf/semantic-release-maven
+
+The plugin of semantic-release that deploys the Maven modules of a train, by `@wtf/release-maven`,
+in the steps of semantic-release, and writes no version into git: each pom.xml holds a
+placeholder, as `0.0.0-SNAPSHOT`, and the tag is the version. Put it in the plugins of the run of
+a tag, before the plugin that makes the release of the host. It reads `trains` and `ecosystems`
+of its options, which semantic-release gives it of the root of the config, and the train of the
+run of its option `train`, or else `RELEASE_TRAIN` of the environment of the run, as
+`@wtf/semantic-release-npm` does; and the modules as the trains read them, of the ecosystem of
+Maven (`mavenEcosystem` of `@wtf/release-maven/ecosystem`): the modules of the release are the
+modules of the train, whose `paths` hold their folder (`ownersOf` of
+`@wtf/release-trains/packages`).
+
+- `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.
+
+A dry run of semantic-release runs `verifyConditions` 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
+repository for each pom by a `HEAD` of `fetch`, at `lookup`, or else where it deploys, with the
+header of `lookupAuth`, its value of a variable of the environment, which no log holds.
+
+```js
+// release.config.mjs
+export default {
+  trains: {
+    core: { paths: ['core'] },
+    // client's modules depend on core's, which the ecosystem of Maven reads: no dependsOn.
+    client: { paths: ['client'] }
+  },
+  ecosystems: ['@wtf/release-maven'],
+  train: process.env.RELEASE_TRAIN,
+  tagFormat: `${process.env.RELEASE_TRAIN}-v\${version}`,
+  plugins: [
+    ['@wtf/semantic-release-trains', { wrap: '@semantic-release/commit-analyzer' }],
+    ['@wtf/semantic-release-maven', { args: ['-s', 'ci_settings.xml'] }]
+  ]
+}
+```
+
+## Interfaces
+
+- [LookupAuth](interfaces/LookupAuth.md)
+- [MavenPluginOptions](interfaces/MavenPluginOptions.md)
+- [MavenRelease](interfaces/MavenRelease.md)
+
+## Variables
+
+- [default](variables/default.md)
+
+## Functions
+
+- [pomLookup](functions/pomLookup.md)
+- [prepare](functions/prepare.md)
+- [publish](functions/publish.md)
+- [verifyConditions](functions/verifyConditions.md)

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

@@ -0,0 +1,38 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-maven](../README.md) / pomLookup
+
+# Function: pomLookup()
+
+> **pomLookup**(`url`, `headers?`): `Promise`\<`boolean`\>
+
+Defined in: [packages/semantic-release-maven/src/index.ts:256](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L256)
+
+Asks the repository at `url` whether it has the pom there, by a `HEAD` of `fetch` of the headers
+`headers`, which no error names.
+
+## Parameters
+
+### url
+
+`string`
+
+The URL of the pom.
+
+### headers?
+
+`Readonly`\<`Record`\<`string`, `string`\>\> = `{}`
+
+The headers of the request, as of `lookupAuth`.
+
+## Returns
+
+`Promise`\<`boolean`\>
+
+Whether the repository has it: a 2xx yes, a 404 no.
+
+## Throws
+
+`EMAVENREPOSITORY` of a repository that cannot be reached, or answers of anything else.

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

@@ -0,0 +1,41 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-maven](../README.md) / prepare
+
+# Function: prepare()
+
+> **prepare**(`pluginConfig`, `context`): `Promise`\<`void`\>
+
+Defined in: [packages/semantic-release-maven/src/index.ts:351](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L351)
+
+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.

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

@@ -0,0 +1,43 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-maven](../README.md) / publish
+
+# Function: publish()
+
+> **publish**(`pluginConfig`, `context`): `Promise`\<`false` \| [`MavenRelease`](../interfaces/MavenRelease.md)\>
+
+Defined in: [packages/semantic-release-maven/src/index.ts:381](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L381)
+
+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.

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

@@ -0,0 +1,40 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-maven](../README.md) / verifyConditions
+
+# Function: verifyConditions()
+
+> **verifyConditions**(`pluginConfig`, `context`): `Promise`\<`void`\>
+
+Defined in: [packages/semantic-release-maven/src/index.ts:318](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L318)
+
+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-maven/interfaces/LookupAuth.md

@@ -0,0 +1,32 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-maven](../README.md) / LookupAuth
+
+# Interface: LookupAuth
+
+Defined in: [packages/semantic-release-maven/src/index.ts:82](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L82)
+
+The header a lookup of the repository sends, and the variable of the environment that holds its
+value, as `{ "header": "Job-Token", "variable": "CI_JOB_TOKEN" }` of the GitLab Maven registry.
+
+## Properties
+
+### header
+
+> `readonly` **header**: `string`
+
+Defined in: [packages/semantic-release-maven/src/index.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L84)
+
+The name of the header, as `Job-Token`, `Private-Token` or `Authorization`.
+
+***
+
+### variable
+
+> `readonly` **variable**: `string`
+
+Defined in: [packages/semantic-release-maven/src/index.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L86)
+
+The variable of the environment that holds its value, as `CI_JOB_TOKEN`.

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

@@ -0,0 +1,129 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-maven](../README.md) / MavenPluginOptions
+
+# Interface: MavenPluginOptions
+
+Defined in: [packages/semantic-release-maven/src/index.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L90)
+
+The options of the plugin, in the config of semantic-release or at its root.
+
+## Properties
+
+### args?
+
+> `readonly` `optional` **args?**: readonly `string`[]
+
+Defined in: [packages/semantic-release-maven/src/index.ts:126](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L126)
+
+The arguments of each deploy after its goal, as `["-s", "ci_settings.xml", "-P", "release"]`.
+
+***
+
+### command?
+
+> `readonly` `optional` **command?**: `string`
+
+Defined in: [packages/semantic-release-maven/src/index.ts:124](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L124)
+
+Maven, as it is run: `mvn` by default, or a wrapper, as `./mvnw`.
+
+***
+
+### ecosystems
+
+> `readonly` **ecosystems**: readonly `string`[]
+
+Defined in: [packages/semantic-release-maven/src/index.ts:99](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L99)
+
+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
+`verifyConditions` fails (`EMAVENECOSYSTEM`), as the trains would read no module this plugin
+deploys.
+
+***
+
+### exclude?
+
+> `readonly` `optional` **exclude?**: readonly `string`[]
+
+Defined in: [packages/semantic-release-maven/src/index.ts:108](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L108)
+
+The modules of the train not to deploy, by `groupId:artifactId`, as a module of samples.
+
+***
+
+### include?
+
+> `readonly` `optional` **include?**: readonly `string`[]
+
+Defined in: [packages/semantic-release-maven/src/index.ts:106](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L106)
+
+The modules of the train to deploy, by `groupId:artifactId`: every module of it that deploys by
+default.
+
+***
+
+### lookup?
+
+> `readonly` `optional` **lookup?**: `string`
+
+Defined in: [packages/semantic-release-maven/src/index.ts:120](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L120)
+
+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`.
+
+***
+
+### lookupAuth?
+
+> `readonly` `optional` **lookupAuth?**: [`LookupAuth`](LookupAuth.md)
+
+Defined in: [packages/semantic-release-maven/src/index.ts:122](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L122)
+
+The header each lookup sends, and the variable of its value: none by default.
+
+***
+
+### repository?
+
+> `readonly` `optional` **repository?**: [`Repository`](../../release-maven/repository/interfaces/Repository.md)
+
+Defined in: [packages/semantic-release-maven/src/index.ts:115](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L115)
+
+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
+`distributionManagement`, or of a parent's in the repo, which a module must have unless
+`lookup` is given, as Maven Central's `central-publishing-maven-plugin` deploys of none.
+
+***
+
+### system?
+
+> `readonly` `optional` **system?**: [`SystemInput`](../../release-system/system/type-aliases/SystemInput.md)
+
+Defined in: [packages/semantic-release-maven/src/index.ts:128](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L128)
+
+The system the plugin runs by, over Node's.
+
+***
+
+### train?
+
+> `readonly` `optional` **train?**: `string`
+
+Defined in: [packages/semantic-release-maven/src/index.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L101)
+
+The train of the run: `RELEASE_TRAIN` of the environment of the run by default.
+
+***
+
+### trains
+
+> `readonly` **trains**: [`Trains`](../../release-trains/type-aliases/Trains.md)
+
+Defined in: [packages/semantic-release-maven/src/index.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L92)
+
+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

@@ -0,0 +1,21 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-maven](../README.md) / MavenRelease
+
+# Interface: MavenRelease
+
+Defined in: [packages/semantic-release-maven/src/index.ts:132](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L132)
+
+The release the plugin gives semantic-release of the modules deployed.
+
+## Properties
+
+### name
+
+> `readonly` **name**: `string`
+
+Defined in: [packages/semantic-release-maven/src/index.ts:134](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-maven/src/index.ts#L134)
+
+The repository and the modules, as `gitlab-maven (org.acme:core, org.acme:client)`.

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

@@ -0,0 +1,38 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/semantic-release-maven/schema
+
+# @wtf/semantic-release-maven/schema
+
+The schema of the options of the plugin, as validators of `@wtf/release-system/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;
+- [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
+  `plugins` of the plugin, and anything else; its JSON Schema is [jsonSchema](variables/jsonSchema.md), which the
+  package publishes as `schema.json`.
+
+```ts
+import { configSchema } from '@wtf/semantic-release-maven/schema'
+
+const result = await configSchema['~standard'].validate({
+  plugins: [['@wtf/semantic-release-maven', { exclude: ['org.acme:samples'] }]]
+})
+export const messages = result.issues?.map(({ message }) => message) ?? []
+```
+
+## Type Aliases
+
+- [MavenOptions](type-aliases/MavenOptions.md)
+
+## Variables
+
+- [configSchema](variables/configSchema.md)
+- [jsonSchema](variables/jsonSchema.md)
+- [mavenOptionsSchema](variables/mavenOptionsSchema.md)
+- [mavenSchema](variables/mavenSchema.md)

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

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/semantic-release-maven/schema](../README.md) / MavenOptions
+
+# Type Alias: MavenOptions
+
+> **MavenOptions** = `Omit`\<[`MavenPluginOptions`](../../interfaces/MavenPluginOptions.md), `"train"` \| `"trains"` \| `"ecosystems"` \| `"system"`\>
+
+Defined in: [packages/semantic-release-maven/src/schema.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/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

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/semantic-release-maven/schema](../README.md) / configSchema
+
+# Variable: configSchema
+
+> `const` **configSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<`object`\>
+
+Defined in: [packages/semantic-release-maven/src/schema.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/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.