@wtf/release-docs 9.0.2 → 10.0.0

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

@@ -7,19 +7,19 @@
 # @wtf/release-go/modules
 
 The Go modules of a repo: [readModules](functions/readModules.md) reads each go.mod git tracks of the working tree,
-and [modulesAt](functions/modulesAt.md) each of a commit; [selectModules](functions/selectModules.md) takes those a release of a train
-tags; and [majorErrors](functions/majorErrors.md) checks the path of each against the major of the release, which Go
-holds in the path from v2 on. A go.mod under a `vendor` or a `testdata` folder is no module of the
-repo: Go reads neither as one.
+and [modulesAt](functions/modulesAt.md) each of a commit; [selectModules](functions/selectModules.md) takes those a release tags of the
+modules of its plan; and [majorErrors](functions/majorErrors.md) checks the path of each against the major of the
+release, which Go holds in the path from v2 on. A go.mod under a `vendor` or a `testdata` folder
+is no module of the repo: Go reads neither as one.
 
 ```ts
+import type { RepoContext } from '@wtf/release'
 import { readModules, selectModules } from '@wtf/release-go/modules'
-import type { System } from '@wtf/release-system'
 
-// The paths of the modules a release of the train of `train` tags.
-export async function paths(system: System, train: ReadonlySet<string>): Promise<string[]> {
-  const modules = await readModules({ system })
-  return selectModules(modules, { train }).map(({ path }) => path)
+// The paths of the modules a release of the modules of `own` tags.
+export async function paths(repo: RepoContext, own: ReadonlySet<string>): Promise<string[]> {
+  const modules = await readModules(repo)
+  return selectModules(modules, { own }).map(({ path }) => path)
 }
 ```
 

package/api/@wtf/release-go/modules/functions/isFetchable.md

@@ -8,7 +8,7 @@
 
 > **isFetchable**(`path`): `boolean`
 
-Defined in: [packages/release-go/src/modules.ts:135](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/modules.ts#L135)
+Defined in: [packages/release-go/src/modules.ts:135](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/modules.ts#L135)
 
 Whether Go can fetch the module of `path`: its first element has a dot, as a host does
 (`example.com/lib`); a path of none, as `tools`, is the module of a repo alone.

package/api/@wtf/release-go/modules/functions/isGoMod.md

@@ -8,7 +8,7 @@
 
 > **isGoMod**(`file`): `boolean`
 
-Defined in: [packages/release-go/src/modules.ts:41](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/modules.ts#L41)
+Defined in: [packages/release-go/src/modules.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/modules.ts#L43)
 
 Whether `file`, a file of the repo, is the go.mod of a module of it: one of no `vendor` and no
 `testdata` folder above it.

package/api/@wtf/release-go/modules/functions/majorErrors.md

@@ -8,7 +8,7 @@
 
 > **majorErrors**(`modules`, `version`): [`GoError`](../../errors/classes/GoError.md)[]
 
-Defined in: [packages/release-go/src/modules.ts:243](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/modules.ts#L243)
+Defined in: [packages/release-go/src/modules.ts:244](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/modules.ts#L244)
 
 The faults of the paths of `modules` against `version`, the release: from v2 on, Go needs the
 path of a module to end in `/v<major>`, and a path that ends in `/vN` needs a release of the major

package/api/@wtf/release-go/modules/functions/majorOfPath.md

@@ -8,7 +8,7 @@
 
 > **majorOfPath**(`path`): `number` \| `undefined`
 
-Defined in: [packages/release-go/src/modules.ts:225](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/modules.ts#L225)
+Defined in: [packages/release-go/src/modules.ts:226](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/modules.ts#L226)
 
 The major the path of a module names at its end, as `2` of `example.com/lib/v2`: none of a path
 of no `/vN` of 2 or more, nor of a `gopkg.in/` path, whose `.vN` is its own.

package/api/@wtf/release-go/modules/functions/modulesAt.md

@@ -8,7 +8,7 @@
 
 > **modulesAt**(`ref`, `context`): `Promise`\<[`GoModule`](../../interfaces/GoModule.md)[]\>
 
-Defined in: [packages/release-go/src/modules.ts:117](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/modules.ts#L117)
+Defined in: [packages/release-go/src/modules.ts:117](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/modules.ts#L117)
 
 The modules of the repo of `context` at the commit `ref`: each go.mod of its tree, as
 [isGoMod](isGoMod.md) says, read by `git show`.
@@ -23,9 +23,9 @@ The commit, as `HEAD` or the tag of a release.
 
 ### context
 
-[`GitContext`](../../../release-system/git/interfaces/GitContext.md)
+[`GitContext`](../../../release/git/interfaces/GitContext.md)
 
-The folder of the repo, its environment, and the system git runs by.
+The platform git runs by, of the folder of the repo.
 
 ## Returns
 

package/api/@wtf/release-go/modules/functions/modulesOf.md

@@ -8,7 +8,7 @@
 
 > **modulesOf**(`manifests`): [`GoModule`](../../interfaces/GoModule.md)[]
 
-Defined in: [packages/release-go/src/modules.ts:52](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/modules.ts#L52)
+Defined in: [packages/release-go/src/modules.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/modules.ts#L54)
 
 The modules of go.mod files, each of its file and its text: each of the path of its `module`
 line, its folder, its requires and its replaces. Throws `EGOMOD` of a go.mod of no `module` line,

package/api/@wtf/release-go/modules/functions/readModules.md

@@ -8,19 +8,18 @@
 
 > **readModules**(`context`): `Promise`\<[`GoModule`](../../interfaces/GoModule.md)[]\>
 
-Defined in: [packages/release-go/src/modules.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/modules.ts#L97)
+Defined in: [packages/release-go/src/modules.ts:98](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/modules.ts#L98)
 
 The modules of the working tree of the repo of `context`: each go.mod git tracks, as
-[isGoMod](isGoMod.md) says, read by the system.
+[isGoMod](isGoMod.md) says, read of the folder of the repo.
 
 ## Parameters
 
 ### context
 
-[`GitContext`](../../../release-system/git/interfaces/GitContext.md)
+[`RepoContext`](../../../release/interfaces/RepoContext.md)
 
-The folder of the repo, its environment, and the system git runs and the files
-are read by.
+The folder of the repo, whose files are read, and the platform git runs by.
 
 ## Returns
 

package/api/@wtf/release-go/modules/functions/selectModules.md

@@ -8,13 +8,15 @@
 
 > **selectModules**(`modules`, `selection`): [`GoModule`](../../interfaces/GoModule.md)[]
 
-Defined in: [packages/release-go/src/modules.ts:166](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/modules.ts#L166)
+Defined in: [packages/release-go/src/modules.ts:167](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/modules.ts#L167)
 
-The modules a release tags: those of its train that can be fetched ([isFetchable](isFetchable.md)), of
+The modules a release tags: those of `own` that can be fetched ([isFetchable](isFetchable.md)), of
 `include` where it names some, but those of `exclude`, in the order of their paths. A module of an
-option that the repo has not, or that is of another train, or that cannot be fetched, is a fault,
-as a release that skips it by a typo tags less than it says. A module of the release that requires
-a module of the repo that cannot be fetched fails too, as no user of it could build it.
+option that the repo has not, that cannot be fetched of `include`, or that Go can fetch and is not
+of `own`, is a fault, as a release that skips it by a typo tags less than it says; one of
+`exclude` that cannot be fetched is never tagged, of whichever release, and is none. A module of
+the release that requires a module of the repo that cannot be fetched fails too, as no user of it
+could build it.
 
 ## Parameters
 
@@ -28,17 +30,17 @@ The modules of the repo, as [readModules](readModules.md) gives them.
 
 [`Selection`](../interfaces/Selection.md)
 
-The modules of the train, and the paths to include and to exclude.
+The modules of the release, and the paths to include and to exclude.
 
 ## Returns
 
 [`GoModule`](../../interfaces/GoModule.md)[]
 
-The modules of the release, in the order of their paths: none of a train of no module to
-tag.
+The modules of the release, in the order of their paths: none of a release of no module
+to tag.
 
 ## Throws
 
-`EGOMODULES` of a path no module has, or of a module of another train or that cannot be
-fetched that `include` names; `EGOPRIVATE` of a require of a module of the
-repo that cannot be fetched.
+`EGOMODULES` of a path no module has, of a module that cannot be fetched that `include`
+names, or of one that can that is not of `own`; `EGOPRIVATE` of a require of a module of the repo
+that cannot be fetched.

package/api/@wtf/release-go/modules/interfaces/Selection.md

@@ -6,7 +6,7 @@
 
 # Interface: Selection
 
-Defined in: [packages/release-go/src/modules.ts:138](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/modules.ts#L138)
+Defined in: [packages/release-go/src/modules.ts:138](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/modules.ts#L138)
 
 The names a selection of modules is made of.
 
@@ -16,9 +16,9 @@ The names a selection of modules is made of.
 
 > `readonly` `optional` **exclude?**: readonly `string`[]
 
-Defined in: [packages/release-go/src/modules.ts:148](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/modules.ts#L148)
+Defined in: [packages/release-go/src/modules.ts:147](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/modules.ts#L147)
 
-The modules not to tag, by path, of the ones `include` or the train gives.
+The modules not to tag, by path, of the ones `include` or `own` gives.
 
 ***
 
@@ -26,18 +26,17 @@ The modules not to tag, by path, of the ones `include` or the train gives.
 
 > `readonly` `optional` **include?**: readonly `string`[]
 
-Defined in: [packages/release-go/src/modules.ts:146](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/modules.ts#L146)
+Defined in: [packages/release-go/src/modules.ts:145](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/modules.ts#L145)
 
-The modules to tag, by path: every module of the train that can be fetched by default.
+The modules to tag, by path: every module of `own` that can be fetched by default.
 
 ***
 
-### train
+### own
 
-> `readonly` **train**: `ReadonlySet`\<`string`\>
+> `readonly` **own**: `ReadonlySet`\<`string`\>
 
-Defined in: [packages/release-go/src/modules.ts:144](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/modules.ts#L144)
+Defined in: [packages/release-go/src/modules.ts:143](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/modules.ts#L143)
 
-The modules of the train of the release, by path, as `ownersOf` of
-`@wtf/release-trains/packages` gives them of the packages of `goEcosystem` of `./ecosystem`: the
-release tags of these alone.
+The modules of the release, by path, as `own` of its plan gives them, each of a module Go can
+fetch: the release tags of these alone.

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

@@ -0,0 +1,45 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/release-go/release
+
+# @wtf/release-go/release
+
+The steps of a release of Go modules, as the contract of `@wtf/release/contract` has them, each
+over the plan of the release it is given, of no train and no release tool: the modules of the
+plan's `own` it tags ([releaseModules](functions/releaseModules.md)), the version and the majors checked
+([verifyModules](functions/verifyModules.md)), the versions of the plan's `versions` written into every go.mod of the
+repo ([prepareModules](functions/prepareModules.md)), and the tags pushed of a commit of the stamped go.mod files, and
+asked of the Go proxy ([publishModules](functions/publishModules.md)). `goEcosystem` of `./ecosystem` is these steps,
+and the read side.
+
+```ts
+import type { Plan, Release } from '@wtf/release/contract'
+import type { GoPackage } from '@wtf/release-go/ecosystem'
+import { prepareModules, publishModules, verifyModules } from '@wtf/release-go/release'
+
+declare const release: Release
+declare const plan: Plan<GoPackage>
+const options = {
+  remote: 'origin',
+  author: { name: 'Release Bot', email: 'release@example.com' },
+  proxy: true
+}
+await verifyModules(release, plan, options)
+await prepareModules(release, plan, options)
+export const released = await publishModules(release, plan, options)
+```
+
+## Interfaces
+
+- [ReleaseModules](interfaces/ReleaseModules.md)
+
+## Functions
+
+- [isGoVersion](functions/isGoVersion.md)
+- [prepareModules](functions/prepareModules.md)
+- [publishModules](functions/publishModules.md)
+- [releasedOf](functions/releasedOf.md)
+- [releaseModules](functions/releaseModules.md)
+- [verifyModules](functions/verifyModules.md)

package/api/@wtf/release-go/release/functions/isGoVersion.md

@@ -0,0 +1,28 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/release](../README.md) / isGoVersion
+
+# Function: isGoVersion()
+
+> **isGoVersion**(`version`): `boolean`
+
+Defined in: [packages/release-go/src/release.ts:82](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/release.ts#L82)
+
+Whether `version` is a version Go tags a module of: a semver version as it is written, of three
+numbers, of a prerelease or none, of no `v` and no build.
+
+## Parameters
+
+### version
+
+`string`
+
+The version, as `1.2.3`.
+
+## Returns
+
+`boolean`
+
+Whether it is one.

package/api/@wtf/release-go/release/functions/prepareModules.md

@@ -0,0 +1,47 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/release](../README.md) / prepareModules
+
+# Function: prepareModules()
+
+> **prepareModules**(`release`, `plan`, `options`): `Promise`\<readonly `string`[]\>
+
+Defined in: [packages/release-go/src/release.ts:124](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/release.ts#L124)
+
+Writes the version of each module of `versions` of the plan into each `require` of it, and the
+version a `replace` of it replaces, in every go.mod of the repo, and reads them again: a require
+that is not at its version fails here, before the tags. A release of no module to tag writes
+nothing; a dry run writes nothing, and checks the go.mod files as they would be.
+
+## Parameters
+
+### release
+
+[`Release`](../../../release/contract/interfaces/Release.md)
+
+The release: the folder of the repo and the platform, and whether it is a dry
+run.
+
+### plan
+
+[`Plan`](../../../release/contract/interfaces/Plan.md)\<[`Package`](../../../release/ecosystem/interfaces/Package.md)\>
+
+What the release is of: its modules, and the version of each module of the repo.
+
+### options
+
+[`GoOptions`](../../interfaces/GoOptions.md)
+
+The modules to include and to exclude.
+
+## Returns
+
+`Promise`\<readonly `string`[]\>
+
+The go.mod files it wrote, or would write, from the root of the repo.
+
+## Throws
+
+`EGOVERSION` of a require at another version after the stamp.

package/api/@wtf/release-go/release/functions/publishModules.md

@@ -0,0 +1,54 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/release](../README.md) / publishModules
+
+# Function: publishModules()
+
+> **publishModules**(`release`, `plan`, `options`): `Promise`\<readonly [`Released`](../../../release/forge/interfaces/Released.md)[]\>
+
+Defined in: [packages/release-go/src/release.ts:184](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/release.ts#L184)
+
+Tags the modules of a release: checks that the go.mod files require each module of `versions` of
+the plan at its version, as `prepare` writes them; then makes a commit of every go.mod of the repo
+on top of `HEAD`, on no branch, of the author of `options`, tags it with the tag of each module the
+remote lacks, and pushes them to `remote` in one atomic push, each the remote has skipped, so a
+release that stopped part way is finished by running it again (`tagModules` of `./tags`). Then, of
+`proxy`, asks the Go proxy for each module at its version. A dry run checks the go.mod files as
+`prepare` would write them, and makes, pushes and asks nothing.
+
+## Parameters
+
+### release
+
+[`Release`](../../../release/contract/interfaces/Release.md)
+
+The release: its version, the folder of the repo and the platform, whether it is
+a dry run, and the log.
+
+### plan
+
+[`Plan`](../../../release/contract/interfaces/Plan.md)\<[`Package`](../../../release/ecosystem/interfaces/Package.md)\>
+
+What the release is of: its modules, and the version of each module of the repo.
+
+### options
+
+[`GoOptions`](../../interfaces/GoOptions.md)
+
+The modules, the remote, the author and the committer, the message of the
+commit, and whether to ask the proxy.
+
+## Returns
+
+`Promise`\<readonly [`Released`](../../../release/forge/interfaces/Released.md)[]\>
+
+Each module of the release, tagged or found tagged, of its page on pkg.go.dev of `proxy`,
+else of its folder and its tag.
+
+## Throws
+
+`EGOVERSION` of a require not at its version, `EGOTAG` of no remote or no author, or 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/release-go/release/functions/releaseModules.md

@@ -0,0 +1,48 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/release](../README.md) / releaseModules
+
+# Function: releaseModules()
+
+> **releaseModules**(`context`, `plan`, `options`): `Promise`\<[`ReleaseModules`](../interfaces/ReleaseModules.md)\>
+
+Defined in: [packages/release-go/src/release.ts:64](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/release.ts#L64)
+
+The modules of a release of `plan`: every module of the repo of `context`, of its working tree,
+and of the modules of `own` of the plan, those the release tags, of `include` and `exclude` of
+`options` (`selectModules` of `./modules`).
+
+## Parameters
+
+### context
+
+[`RepoContext`](../../../release/interfaces/RepoContext.md)
+
+The folder of the repo, whose go.mod files are read, and the platform git runs
+by.
+
+### plan
+
+[`Plan`](../../../release/contract/interfaces/Plan.md)\<[`Package`](../../../release/ecosystem/interfaces/Package.md)\>
+
+What the release is of: its modules in `own`.
+
+### options
+
+`Pick`\<[`GoOptions`](../../interfaces/GoOptions.md), `"include"` \| `"exclude"`\>
+
+The modules to include and to exclude.
+
+## Returns
+
+`Promise`\<[`ReleaseModules`](../interfaces/ReleaseModules.md)\>
+
+Every module of the repo, and those the release tags: none of a plan of no module to
+tag.
+
+## Throws
+
+`EGOMOD` of a go.mod of no module, and of two of one path; `EGOMODULES` and `EGOPRIVATE`
+of the selection.

package/api/@wtf/release-go/release/functions/releasedOf.md

@@ -0,0 +1,41 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/release](../README.md) / releasedOf
+
+# Function: releasedOf()
+
+> **releasedOf**(`tagged`, `selected`, `proxied`): [`Released`](../../../release/forge/interfaces/Released.md)[]
+
+Defined in: [packages/release-go/src/release.ts:148](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/release.ts#L148)
+
+Each module of a release, for the links of its release: its page on pkg.go.dev, of a release that
+asked the proxy, which then knows it; and its folder and its tag, which link it where pkg.go.dev
+does not.
+
+## Parameters
+
+### tagged
+
+readonly `Pick`\<[`TaggedModule`](../../tags/interfaces/TaggedModule.md), `"path"` \| `"tag"` \| `"version"`\>[]
+
+The modules of the release, and their tags.
+
+### selected
+
+readonly [`GoModule`](../../interfaces/GoModule.md)[]
+
+The modules of the release, of their folders.
+
+### proxied
+
+`boolean`
+
+Whether the proxy was asked for them.
+
+## Returns
+
+[`Released`](../../../release/forge/interfaces/Released.md)[]
+
+Each module, and where it is.

package/api/@wtf/release-go/release/functions/verifyModules.md

@@ -0,0 +1,44 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/release](../README.md) / verifyModules
+
+# Function: verifyModules()
+
+> **verifyModules**(`release`, `plan`, `options`): `Promise`\<`void`\>
+
+Defined in: [packages/release-go/src/release.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/release.ts#L95)
+
+Checks a release before anything is written: the modules it tags, of the options; that its
+version is one Go tags a module of; and that the path of each module it tags agrees with its
+major, as Go holds it in the path from v2 on. It writes nothing, and asks the remote nothing.
+
+## Parameters
+
+### release
+
+[`Release`](../../../release/contract/interfaces/Release.md)
+
+The release: its version, and the folder of the repo and the platform.
+
+### plan
+
+[`Plan`](../../../release/contract/interfaces/Plan.md)\<[`Package`](../../../release/ecosystem/interfaces/Package.md)\>
+
+What the release is of.
+
+### options
+
+[`GoOptions`](../../interfaces/GoOptions.md)
+
+The modules to include and to exclude.
+
+## Returns
+
+`Promise`\<`void`\>
+
+## Throws
+
+`EGOMOD`, `EGOMODULES` and `EGOPRIVATE` of the modules; `EGOSEMVER` of a version that is
+none; `EGOMAJOR` of each module whose path does not agree with the major, together.

package/api/@wtf/release-go/release/interfaces/ReleaseModules.md

@@ -0,0 +1,31 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/release](../README.md) / ReleaseModules
+
+# Interface: ReleaseModules
+
+Defined in: [packages/release-go/src/release.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/release.ts#L43)
+
+The modules of a release: every module of the repo, and those the release tags.
+
+## Properties
+
+### modules
+
+> `readonly` **modules**: readonly [`GoModule`](../../interfaces/GoModule.md)[]
+
+Defined in: [packages/release-go/src/release.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/release.ts#L45)
+
+Every module of the repo, as `readModules` of `./modules` gives them.
+
+***
+
+### selected
+
+> `readonly` **selected**: readonly [`GoModule`](../../interfaces/GoModule.md)[]
+
+Defined in: [packages/release-go/src/release.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/release.ts#L47)
+
+The modules the release tags, in the order of their paths.

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

@@ -6,12 +6,12 @@
 
 # @wtf/release-go/stamp
 
-The versions of the trains written into the go.mod files of a repo, by the line reader of
+The versions of a release written into the go.mod files of a repo, by the line reader of
 `./gomod`, and no parser that writes the file again: the comments, the layout, the quoting and
-the line endings of a go.mod that people edit stay as they are. Each module takes the version of
-its train: of the train of the release, the release's; of another train, its last release
-(`releasedVersions` of `@wtf/release-trains/packages`); of no train, none. What it writes, in every
-go.mod of the repo:
+the line endings of a go.mod that people edit stay as they are. Each module takes the version its
+plan gives it, `versions` of a `Plan` of `@wtf/release/contract`: of a module of the release, the
+release's; of another, the last release of its own, as of another train; of none, none. What it
+writes, in every go.mod of the repo:
 
 - the version of each `require` of a module that takes one, of a line of its own or of a block,
   `// indirect` too, as `v1.4.0`;
@@ -36,6 +36,7 @@ console.log(text)
 
 - [Stamped](interfaces/Stamped.md)
 - [StampedModules](interfaces/StampedModules.md)
+- [StampOptions](interfaces/StampOptions.md)
 
 ## Functions
 

package/api/@wtf/release-go/stamp/functions/checkVersions.md

@@ -8,7 +8,7 @@
 
 > **checkVersions**(`modules`, `versions`): `void`
 
-Defined in: [packages/release-go/src/stamp.ts:149](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/stamp.ts#L149)
+Defined in: [packages/release-go/src/stamp.ts:160](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/stamp.ts#L160)
 
 Checks that each `require` of a module of `versions`, of the go.mod files read again after the
 stamp, names the version that module takes: what a stamp left wrong, as a require of a form the

package/api/@wtf/release-go/stamp/functions/stampGoMod.md

@@ -8,7 +8,7 @@
 
 > **stampGoMod**(`text`, `versions`): [`Stamped`](../interfaces/Stamped.md)
 
-Defined in: [packages/release-go/src/stamp.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-go/src/stamp.ts#L74)
+Defined in: [packages/release-go/src/stamp.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-go/src/stamp.ts#L75)
 
 The go.mod `text` with the versions written, as the module says: each `require` of a module of
 `versions`, and the version a `replace` of it replaces. Idempotent: stamped twice, the second