@wtf/release-docs 8.1.0 → 8.2.0

package/api/@wtf/semantic-release-cargo/interfaces/CargoPluginOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: CargoPluginOptions
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L95)
+Defined in: [packages/semantic-release-cargo/src/index.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L95)
 
 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` **ecosystems**: readonly `string`[]
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L103)
+Defined in: [packages/semantic-release-cargo/src/index.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L103)
 
 The ecosystems of the repo, of the root of the config, which the trains read the packages of:
 `'@wtf/semantic-release-cargo/ecosystem'` or `'@wtf/release-cargo'` among them, or `verifyConditions` fails (`ECARGOECOSYSTEM`), as the
@@ -28,7 +28,7 @@ trains would read no crate this plugin publishes.
 
 > `readonly` `optional` **exclude?**: readonly `string`[]
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:109](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L109)
+Defined in: [packages/semantic-release-cargo/src/index.ts:109](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L109)
 
 The crates of the train not to publish, by name, as an example.
 
@@ -38,7 +38,7 @@ The crates of the train not to publish, by name, as an example.
 
 > `readonly` `optional` **idToken?**: `string`
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:126](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L126)
+Defined in: [packages/semantic-release-cargo/src/index.ts:126](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L126)
 
 The variable of the environment that holds the ID token of the job, for trusted publishing:
 `CRATES_IO_ID_TOKEN`.
@@ -49,7 +49,7 @@ The variable of the environment that holds the ID token of the job, for trusted
 
 > `readonly` `optional` **include?**: readonly `string`[]
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:107](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L107)
+Defined in: [packages/semantic-release-cargo/src/index.ts:107](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L107)
 
 The crates of the train to publish, by name: every crate of it that may be published by default.
 
@@ -59,7 +59,7 @@ The crates of the train to publish, by name: every crate of it that may be publi
 
 > `readonly` `optional` **index?**: `string`
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:119](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L119)
+Defined in: [packages/semantic-release-cargo/src/index.ts:119](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L119)
 
 The base URL of the sparse index of the registry, which the plugin asks which versions exist:
 `https://index.crates.io` by default, and required of a `registry` that is not crates.io.
@@ -70,7 +70,7 @@ The base URL of the sparse index of the registry, which the plugin asks which ve
 
 > `readonly` `optional` **registry?**: `string`
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:114](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L114)
+Defined in: [packages/semantic-release-cargo/src/index.ts:114](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L114)
 
 The registry, by the name of `.cargo/config.toml`: crates.io by default, which `crates-io`
 names too.
@@ -81,7 +81,7 @@ names too.
 
 > `readonly` `optional` **registryApi?**: `string`
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:131](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L131)
+Defined in: [packages/semantic-release-cargo/src/index.ts:131](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L131)
 
 The base URL of the API of the registry, where the ID token is exchanged: `https://crates.io`.
 Required of an ID token and a `registry` that is not crates.io.
@@ -92,7 +92,7 @@ Required of an ID token and a `registry` that is not crates.io.
 
 > `readonly` `optional` **system?**: [`SystemInput`](../../release-system/system/type-aliases/SystemInput.md)
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:133](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L133)
+Defined in: [packages/semantic-release-cargo/src/index.ts:133](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L133)
 
 The system the plugin runs by, over Node's.
 
@@ -102,7 +102,7 @@ The system the plugin runs by, over Node's.
 
 > `readonly` `optional` **train?**: `string`
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:105](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L105)
+Defined in: [packages/semantic-release-cargo/src/index.ts:105](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L105)
 
 The train of the run: `RELEASE_TRAIN` of the environment of the run by default.
 
@@ -112,7 +112,7 @@ 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-cargo/src/index.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L97)
+Defined in: [packages/semantic-release-cargo/src/index.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L97)
 
 Every train of the repo: the crates of each are those whose folder its paths hold.
 
@@ -122,6 +122,6 @@ Every train of the repo: the crates of each are those whose folder its paths hol
 
 > `readonly` `optional` **verify?**: `boolean`
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L121)
+Defined in: [packages/semantic-release-cargo/src/index.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L121)
 
 Whether cargo builds each crate before it publishes it: `true`.

package/api/@wtf/semantic-release-cargo/interfaces/CargoRelease.md

@@ -6,7 +6,7 @@
 
 # Interface: CargoRelease
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:137](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L137)
+Defined in: [packages/semantic-release-cargo/src/index.ts:137](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L137)
 
 The release the plugin gives semantic-release of the crates published.
 
@@ -16,7 +16,7 @@ The release the plugin gives semantic-release of the crates published.
 
 > `readonly` **name**: `string`
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:139](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L139)
+Defined in: [packages/semantic-release-cargo/src/index.ts:139](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L139)
 
 The crates named, as `crates.io (a, b)`.
 
@@ -26,6 +26,6 @@ The crates named, as `crates.io (a, b)`.
 
 > `readonly` `optional` **url?**: `string`
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:141](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L141)
+Defined in: [packages/semantic-release-cargo/src/index.ts:141](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L141)
 
 The page of the first crate that has one.

package/api/@wtf/semantic-release-cargo/schema/type-aliases/CargoOptions.md

@@ -8,6 +8,6 @@
 
 > **CargoOptions** = `Omit`\<[`CargoPluginOptions`](../../interfaces/CargoPluginOptions.md), `"train"` \| `"trains"` \| `"ecosystems"` \| `"system"`\>
 
-Defined in: [packages/semantic-release-cargo/src/schema.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/schema.ts#L40)
+Defined in: [packages/semantic-release-cargo/src/schema.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/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-cargo/schema/variables/cargoOptionsSchema.md

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

package/api/@wtf/semantic-release-cargo/schema/variables/cargoSchema.md

@@ -8,7 +8,7 @@
 
 > `const` **cargoSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`RootOptions`](../../../release-trains/schema/interfaces/RootOptions.md) & [`CargoOptions`](../type-aliases/CargoOptions.md)\>
 
-Defined in: [packages/semantic-release-cargo/src/schema.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/schema.ts#L57)
+Defined in: [packages/semantic-release-cargo/src/schema.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/schema.ts#L57)
 
 The validator of the options the plugin is given: the root's, `trains` and `ecosystems` required,
 and its own.

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

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

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

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

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

@@ -8,7 +8,7 @@
 
 > **default**: `object`
 
-Defined in: [packages/semantic-release-cargo/src/index.ts:488](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-cargo/src/index.ts#L488)
+Defined in: [packages/semantic-release-cargo/src/index.ts:503](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-cargo/src/index.ts#L503)
 
 ## Type Declaration
 

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

@@ -0,0 +1,73 @@
+[**Release trains**](../../README.md)
+
+***
+
+[Release trains](../../README.md) / @wtf/semantic-release-go
+
+# @wtf/semantic-release-go
+
+The plugin of semantic-release that releases the Go modules of a train of a repo, by
+`@wtf/release-go`, in the steps of semantic-release, and writes no version into git on the
+branch: each go.mod requires the modules of the repo at a placeholder, as `v0.0.0`, and the tags
+are the versions. Go has no registry: a release of a module is its tag, `<folder>/v<version>`, or
+`v<version>` at the root, on a commit whose go.mod files require the modules of the repo at their
+releases. Put it in the plugins of the run of a tag. 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 Go
+(`goEcosystem` of `@wtf/release-go/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 go.mod files git tracks, selects the modules
+  the release tags, and reads the last release of each other train, by its tags
+  (`releasedVersions` of `@wtf/release-trains/packages`), so a repo that cannot be released fails
+  before the tag: of a module that requires a module of no train (`EDEPENDENCYNOTRAIN`), or of a
+  train with no release (`EDEPENDENCYNORELEASE`);
+- `verifyRelease` checks the path of each module of the release against the major of its
+  version (`EGOMAJOR`): from v2 on, a module path ends in `/v<major>`;
+- `prepare` 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 (`stampModules`), and reads them again, so a require that is not at
+  the version of its train fails the run (`EGOVERSION`);
+- `publish` makes a commit of the stamped go.mod files on top of `HEAD`, on no branch, tags it
+  with the tag of each module the remote lacks, and pushes them in one atomic push, to
+  `repositoryUrl` of the run (`tagModules`), skipping each the remote has, so a release that
+  stopped part way is finished by running it again; then, of the option `proxy`, asks the Go proxy
+  for each module at its version (`askProxy`).
+
+A dry run of semantic-release runs `verifyConditions` and `verifyRelease` alone of these: it
+skips `prepare` and `publish`, so it stamps and tags nothing.
+
+```js
+// release.config.mjs
+export default {
+  trains: {
+    core: { paths: ['core'] },
+    // cli's module requires core's, which the ecosystem of Go reads: no dependsOn.
+    cli: { paths: ['cli'] }
+  },
+  ecosystems: ['@wtf/release-go'],
+  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-go'
+  ]
+}
+```
+
+## Interfaces
+
+- [GoPluginOptions](interfaces/GoPluginOptions.md)
+- [GoRelease](interfaces/GoRelease.md)
+
+## Variables
+
+- [default](variables/default.md)
+
+## Functions
+
+- [prepare](functions/prepare.md)
+- [publish](functions/publish.md)
+- [verifyConditions](functions/verifyConditions.md)
+- [verifyRelease](functions/verifyRelease.md)

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

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

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

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

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

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

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

@@ -0,0 +1,38 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-go](../README.md) / verifyRelease
+
+# Function: verifyRelease()
+
+> **verifyRelease**(`pluginConfig`, `context`): `Promise`\<`void`\>
+
+Defined in: [packages/semantic-release-go/src/index.ts:260](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-go/src/index.ts#L260)
+
+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-go/interfaces/GoPluginOptions.md

@@ -0,0 +1,84 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-go](../README.md) / GoPluginOptions
+
+# Interface: GoPluginOptions
+
+Defined in: [packages/semantic-release-go/src/index.ts:78](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-go/src/index.ts#L78)
+
+The options of the plugin, in the config of semantic-release or at its root.
+
+## Properties
+
+### ecosystems
+
+> `readonly` **ecosystems**: readonly `string`[]
+
+Defined in: [packages/semantic-release-go/src/index.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-go/src/index.ts#L86)
+
+The ecosystems of the repo, of the root of the config, which the trains read the packages of:
+`'@wtf/semantic-release-go/ecosystem'` or `'@wtf/release-go'` among them, or
+`verifyConditions` fails (`EGOECOSYSTEM`), as the trains would read no module this plugin tags.
+
+***
+
+### exclude?
+
+> `readonly` `optional` **exclude?**: readonly `string`[]
+
+Defined in: [packages/semantic-release-go/src/index.ts:94](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-go/src/index.ts#L94)
+
+The modules of the train not to tag, by path, as an example.
+
+***
+
+### include?
+
+> `readonly` `optional` **include?**: readonly `string`[]
+
+Defined in: [packages/semantic-release-go/src/index.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-go/src/index.ts#L92)
+
+The modules of the train to tag, by path: every module of it that Go can fetch by default.
+
+***
+
+### proxy?
+
+> `readonly` `optional` **proxy?**: `boolean`
+
+Defined in: [packages/semantic-release-go/src/index.ts:99](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-go/src/index.ts#L99)
+
+Whether `publish` asks the Go proxy for each module at its version once its tag is pushed:
+`false`, as the public proxy cannot fetch a private repo.
+
+***
+
+### system?
+
+> `readonly` `optional` **system?**: [`SystemInput`](../../release-system/system/type-aliases/SystemInput.md)
+
+Defined in: [packages/semantic-release-go/src/index.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-go/src/index.ts#L101)
+
+The system the plugin runs by, over Node's.
+
+***
+
+### train?
+
+> `readonly` `optional` **train?**: `string`
+
+Defined in: [packages/semantic-release-go/src/index.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-go/src/index.ts#L88)
+
+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-go/src/index.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-go/src/index.ts#L80)
+
+Every train of the repo: the modules of each are those whose folder its paths hold.

package/api/@wtf/semantic-release-go/interfaces/GoRelease.md

@@ -0,0 +1,31 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-go](../README.md) / GoRelease
+
+# Interface: GoRelease
+
+Defined in: [packages/semantic-release-go/src/index.ts:105](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-go/src/index.ts#L105)
+
+The release the plugin gives semantic-release of the modules tagged.
+
+## Properties
+
+### name
+
+> `readonly` **name**: `string`
+
+Defined in: [packages/semantic-release-go/src/index.ts:107](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-go/src/index.ts#L107)
+
+The modules named, as `Go modules (example.com/a, example.com/b)`.
+
+***
+
+### url?
+
+> `readonly` `optional` **url?**: `string`
+
+Defined in: [packages/semantic-release-go/src/index.ts:109](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-go/src/index.ts#L109)
+
+The page of the first module on pkg.go.dev, of a release that asked the proxy.

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

@@ -0,0 +1,37 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/semantic-release-go/schema
+
+# @wtf/semantic-release-go/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.
+
+- [goSchema](variables/goSchema.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;
+- [goOptionsSchema](variables/goOptionsSchema.md): the options of its entry, `include`, `exclude` and `proxy`, 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-go/schema'
+
+const result = await configSchema['~standard'].validate({
+  plugins: [['@wtf/semantic-release-go', { exclude: ['example.com/repo/examples'] }]]
+})
+export const messages = result.issues?.map(({ message }) => message) ?? []
+```
+
+## Type Aliases
+
+- [GoOptions](type-aliases/GoOptions.md)
+
+## Variables
+
+- [configSchema](variables/configSchema.md)
+- [goOptionsSchema](variables/goOptionsSchema.md)
+- [goSchema](variables/goSchema.md)
+- [jsonSchema](variables/jsonSchema.md)

package/api/@wtf/semantic-release-go/schema/type-aliases/GoOptions.md

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/semantic-release-go/schema](../README.md) / GoOptions
+
+# Type Alias: GoOptions
+
+> **GoOptions** = `Omit`\<[`GoPluginOptions`](../../interfaces/GoPluginOptions.md), `"train"` \| `"trains"` \| `"ecosystems"` \| `"system"`\>
+
+Defined in: [packages/semantic-release-go/src/schema.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-go/src/schema.ts#L39)
+
+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-trains-changelog → semantic-release-go}/schema/variables/configSchema.md

@@ -2,12 +2,12 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/semantic-release-trains-changelog/schema](../README.md) / configSchema
+[Release trains](../../../../README.md) / [@wtf/semantic-release-go/schema](../README.md) / configSchema
 
 # Variable: configSchema
 
 > `const` **configSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<`object`\>
 
-Defined in: [packages/semantic-release-trains-changelog/src/schema.ts:55](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains-changelog/src/schema.ts#L55)
+Defined in: [packages/semantic-release-go/src/schema.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/semantic-release-go/src/schema.ts#L58)
 
 This package's part of a whole config of semantic-release: each entry of `plugins` of the plugin.

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

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