@wtf/release-docs 8.1.0 → 8.2.0

package/api/@wtf/release-go/errors/variables/GO_ERRORS.md

@@ -0,0 +1,47 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/errors](../README.md) / GO\_ERRORS
+
+# Variable: GO\_ERRORS
+
+> `const` **GO\_ERRORS**: `object`
+
+Defined in: [packages/release-go/src/errors.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/errors.ts#L15)
+
+The codes of the errors of the Go modules, each with what it means.
+
+## Type Declaration
+
+### EGOECOSYSTEM
+
+> `readonly` **EGOECOSYSTEM**: `` "The `ecosystems` of the config lists neither `@wtf/semantic-release-go/ecosystem` nor `@wtf/release-go`, so the trains read no module." `` = `` 'The `ecosystems` of the config lists neither `@wtf/semantic-release-go/ecosystem` nor `@wtf/release-go`, so the trains read no module.' ``
+
+### EGOMAJOR
+
+> `readonly` **EGOMAJOR**: `` "The major of the release and the path of a module do not agree: from v2 on, a module path ends in `/v<major>`." `` = `` 'The major of the release and the path of a module do not agree: from v2 on, a module path ends in `/v<major>`.' ``
+
+### EGOMOD
+
+> `readonly` **EGOMOD**: `` "A go.mod has no `module` line, or two go.mod files of the repo name the same module path." `` = `` 'A go.mod has no `module` line, or two go.mod files of the repo name the same module path.' ``
+
+### EGOMODULES
+
+> `readonly` **EGOMODULES**: `"An option names a module the repo has not, or of another train, or one that cannot be fetched."` = `'An option names a module the repo has not, or of another train, or one that cannot be fetched.'`
+
+### EGOPRIVATE
+
+> `readonly` **EGOPRIVATE**: `"A module of the release requires a module of the repo that cannot be fetched, as its path has no dot in its first element."` = `'A module of the release requires a module of the repo that cannot be fetched, as its path has no dot in its first element.'`
+
+### EGOPROXY
+
+> `readonly` **EGOPROXY**: `"The Go proxy cannot give a module at the version of the release."` = `'The Go proxy cannot give a module at the version of the release.'`
+
+### EGOTAG
+
+> `readonly` **EGOTAG**: `"The tags of the modules cannot be asked of the remote, made, or pushed."` = `'The tags of the modules cannot be asked of the remote, made, or pushed.'`
+
+### EGOVERSION
+
+> `readonly` **EGOVERSION**: `"A go.mod does not require a module of the repo at the version of its train."` = `'A go.mod does not require a module of the repo at the version of its train.'`

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

@@ -0,0 +1,39 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/release-go/gomod
+
+# @wtf/release-go/gomod
+
+A go.mod read line by line, as Go's own reader of the file splits it, and no more: its tokens,
+quoted or not, up to a `//` comment ([tokensOf](functions/tokensOf.md)); its entries, each of its directive, a
+line of its own (`require a v1.0.0`) or a line of a block (`require (` … `)`), each token of
+where it stands on its line ([entriesOf](functions/entriesOf.md)); and what a release reads of them, the path of the
+module, each `require` and each `replace` ([readGoMod](functions/readGoMod.md)). `./stamp` writes the versions of a
+release into the tokens where they stand, so the comments, the layout, the quoting and the line
+endings of the file stay as they are.
+
+```ts
+import { readGoMod } from '@wtf/release-go/gomod'
+
+const goMod = readGoMod(
+  'module example.com/app\n\nrequire (\n\texample.com/lib v0.0.0 // indirect\n)\n'
+)
+console.log(goMod.module, goMod.requires.map(({ path, version }) => `${path}@${version}`))
+```
+
+## Interfaces
+
+- [Entry](interfaces/Entry.md)
+- [GoMod](interfaces/GoMod.md)
+- [GoReplace](interfaces/GoReplace.md)
+- [GoRequire](interfaces/GoRequire.md)
+- [Token](interfaces/Token.md)
+
+## Functions
+
+- [entriesOf](functions/entriesOf.md)
+- [linesOf](functions/linesOf.md)
+- [readGoMod](functions/readGoMod.md)
+- [tokensOf](functions/tokensOf.md)

package/api/@wtf/release-go/gomod/functions/entriesOf.md

@@ -0,0 +1,29 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/gomod](../README.md) / entriesOf
+
+# Function: entriesOf()
+
+> **entriesOf**(`text`): [`Entry`](../interfaces/Entry.md)[]
+
+Defined in: [packages/release-go/src/gomod.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L121)
+
+The entries of a go.mod, in the order of its lines: each line of a directive and its arguments,
+and each line of a block, `require (` … `)`, of the block's directive. A line of no token, as of a
+comment alone, is none.
+
+## Parameters
+
+### text
+
+`string`
+
+The text of a go.mod.
+
+## Returns
+
+[`Entry`](../interfaces/Entry.md)[]
+
+Its entries.

package/api/@wtf/release-go/gomod/functions/linesOf.md

@@ -0,0 +1,27 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/gomod](../README.md) / linesOf
+
+# Function: linesOf()
+
+> **linesOf**(`text`): `string`[]
+
+Defined in: [packages/release-go/src/gomod.ts:110](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L110)
+
+The lines of a text, each of no line ending: a `\r` before a `\n` is the line ending's.
+
+## Parameters
+
+### text
+
+`string`
+
+The text of a go.mod.
+
+## Returns
+
+`string`[]
+
+Its lines, in order, as `text.split('\n')` gives them, a `\r` at the end of each dropped.

package/api/@wtf/release-go/gomod/functions/readGoMod.md

@@ -0,0 +1,28 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/gomod](../README.md) / readGoMod
+
+# Function: readGoMod()
+
+> **readGoMod**(`text`): [`GoMod`](../interfaces/GoMod.md)
+
+Defined in: [packages/release-go/src/gomod.ts:183](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L183)
+
+The module of a go.mod, and each `require` and `replace` of it, single lines and blocks, each
+path and version unquoted. An entry of fewer tokens than its directive needs is left out.
+
+## Parameters
+
+### text
+
+`string`
+
+The text of a go.mod.
+
+## Returns
+
+[`GoMod`](../interfaces/GoMod.md)
+
+The path of the module, its requires and its replaces, in the order of the file.

package/api/@wtf/release-go/gomod/functions/tokensOf.md

@@ -0,0 +1,29 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/gomod](../README.md) / tokensOf
+
+# Function: tokensOf()
+
+> **tokensOf**(`line`): [`Token`](../interfaces/Token.md)[]
+
+Defined in: [packages/release-go/src/gomod.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L62)
+
+The tokens of one line of a go.mod, as Go reads them: a `(` or a `)` alone, a string of double
+quotes or of backquotes, or a run of the other characters but a space; a `//` outside a string
+starts the comment, which ends the line.
+
+## Parameters
+
+### line
+
+`string`
+
+A line of the file, of no line ending.
+
+## Returns
+
+[`Token`](../interfaces/Token.md)[]
+
+Its tokens, in order.

package/api/@wtf/release-go/gomod/interfaces/Entry.md

@@ -0,0 +1,41 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/gomod](../README.md) / Entry
+
+# Interface: Entry
+
+Defined in: [packages/release-go/src/gomod.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L95)
+
+An entry of a go.mod: a directive and its arguments, on a line of its own or of a block.
+
+## Properties
+
+### directive
+
+> `readonly` **directive**: `string`
+
+Defined in: [packages/release-go/src/gomod.ts:99](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L99)
+
+Its directive, as `module`, `require` or `replace`: of a block, the block's.
+
+***
+
+### line
+
+> `readonly` **line**: `number`
+
+Defined in: [packages/release-go/src/gomod.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L97)
+
+The index of its line in the file, from 0.
+
+***
+
+### tokens
+
+> `readonly` **tokens**: readonly [`Token`](Token.md)[]
+
+Defined in: [packages/release-go/src/gomod.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L101)
+
+Its arguments, the directive's own token left out, each of where it stands on its line.

package/api/@wtf/release-go/gomod/interfaces/GoMod.md

@@ -0,0 +1,41 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/gomod](../README.md) / GoMod
+
+# Interface: GoMod
+
+Defined in: [packages/release-go/src/gomod.ts:167](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L167)
+
+What a release reads of a go.mod.
+
+## Properties
+
+### module
+
+> `readonly` **module**: `string` \| `undefined`
+
+Defined in: [packages/release-go/src/gomod.ts:169](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L169)
+
+The path of the module, of its `module` line: none of a file of no such line.
+
+***
+
+### replaces
+
+> `readonly` **replaces**: readonly [`GoReplace`](GoReplace.md)[]
+
+Defined in: [packages/release-go/src/gomod.ts:173](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L173)
+
+Each `replace`, of a line of its own or of a block.
+
+***
+
+### requires
+
+> `readonly` **requires**: readonly [`GoRequire`](GoRequire.md)[]
+
+Defined in: [packages/release-go/src/gomod.ts:171](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L171)
+
+Each `require`, of a line of its own or of a block.

package/api/@wtf/release-go/gomod/interfaces/GoReplace.md

@@ -0,0 +1,61 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/gomod](../README.md) / GoReplace
+
+# Interface: GoReplace
+
+Defined in: [packages/release-go/src/gomod.ts:153](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L153)
+
+A `replace` of a go.mod: the module and the version it replaces, and by what.
+
+## Properties
+
+### line
+
+> `readonly` **line**: `number`
+
+Defined in: [packages/release-go/src/gomod.ts:163](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L163)
+
+The index of its line in the file, from 0.
+
+***
+
+### path
+
+> `readonly` **path**: `string`
+
+Defined in: [packages/release-go/src/gomod.ts:155](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L155)
+
+The path of the module it replaces.
+
+***
+
+### target
+
+> `readonly` **target**: `string`
+
+Defined in: [packages/release-go/src/gomod.ts:159](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L159)
+
+What it replaces it by: a folder, as `../lib`, or the path of a module.
+
+***
+
+### targetVersion
+
+> `readonly` **targetVersion**: `string` \| `undefined`
+
+Defined in: [packages/release-go/src/gomod.ts:161](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L161)
+
+The version of the module it replaces it by: none of a folder.
+
+***
+
+### version
+
+> `readonly` **version**: `string` \| `undefined`
+
+Defined in: [packages/release-go/src/gomod.ts:157](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L157)
+
+The version it replaces: none of a replace of every version.

package/api/@wtf/release-go/gomod/interfaces/GoRequire.md

@@ -0,0 +1,41 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/gomod](../README.md) / GoRequire
+
+# Interface: GoRequire
+
+Defined in: [packages/release-go/src/gomod.ts:143](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L143)
+
+A `require` of a go.mod: the module it requires, and the version.
+
+## Properties
+
+### line
+
+> `readonly` **line**: `number`
+
+Defined in: [packages/release-go/src/gomod.ts:149](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L149)
+
+The index of its line in the file, from 0.
+
+***
+
+### path
+
+> `readonly` **path**: `string`
+
+Defined in: [packages/release-go/src/gomod.ts:145](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L145)
+
+The path of the module it requires.
+
+***
+
+### version
+
+> `readonly` **version**: `string`
+
+Defined in: [packages/release-go/src/gomod.ts:147](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L147)
+
+The version, as written, as `v1.2.3`.

package/api/@wtf/release-go/gomod/interfaces/Token.md

@@ -0,0 +1,51 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/gomod](../README.md) / Token
+
+# Interface: Token
+
+Defined in: [packages/release-go/src/gomod.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L24)
+
+A token of a line of a go.mod: its text as written, its value unquoted, and where it stands.
+
+## Properties
+
+### end
+
+> `readonly` **end**: `number`
+
+Defined in: [packages/release-go/src/gomod.ts:32](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L32)
+
+The index after its last character on the line.
+
+***
+
+### start
+
+> `readonly` **start**: `number`
+
+Defined in: [packages/release-go/src/gomod.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L30)
+
+The index of its first character on the line.
+
+***
+
+### text
+
+> `readonly` **text**: `string`
+
+Defined in: [packages/release-go/src/gomod.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L26)
+
+The token as the line writes it, its quotes too.
+
+***
+
+### value
+
+> `readonly` **value**: `string`
+
+Defined in: [packages/release-go/src/gomod.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/gomod.ts#L28)
+
+Its value: the text, of a quoted string the string it holds.

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

@@ -0,0 +1,61 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/release-go](../README.md) / GoModule
+
+# Interface: GoModule
+
+Defined in: [packages/release-go/src/index.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/index.ts#L26)
+
+A Go module of the repo: one go.mod, and its folder.
+
+## Properties
+
+### dir
+
+> `readonly` **dir**: `string`
+
+Defined in: [packages/release-go/src/index.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/index.ts#L30)
+
+Its folder, from the root of the repo, as `lib`; `.` of the root.
+
+***
+
+### manifest
+
+> `readonly` **manifest**: `string`
+
+Defined in: [packages/release-go/src/index.ts:32](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/index.ts#L32)
+
+Its go.mod, from the root of the repo, as `lib/go.mod`.
+
+***
+
+### path
+
+> `readonly` **path**: `string`
+
+Defined in: [packages/release-go/src/index.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/index.ts#L28)
+
+The path of the module, of its `module` line, as `example.com/lib/v2`.
+
+***
+
+### replaces
+
+> `readonly` **replaces**: readonly [`GoReplace`](../gomod/interfaces/GoReplace.md)[]
+
+Defined in: [packages/release-go/src/index.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/index.ts#L36)
+
+Each `replace` of its go.mod.
+
+***
+
+### requires
+
+> `readonly` **requires**: readonly [`GoRequire`](../gomod/interfaces/GoRequire.md)[]
+
+Defined in: [packages/release-go/src/index.ts:34](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/index.ts#L34)
+
+Each `require` of its go.mod, of a module of the repo or not.

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

@@ -0,0 +1,39 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/release-go/modules
+
+# @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.
+
+```ts
+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)
+}
+```
+
+## Interfaces
+
+- [Selection](interfaces/Selection.md)
+
+## Functions
+
+- [isFetchable](functions/isFetchable.md)
+- [isGoMod](functions/isGoMod.md)
+- [majorErrors](functions/majorErrors.md)
+- [majorOfPath](functions/majorOfPath.md)
+- [modulesAt](functions/modulesAt.md)
+- [modulesOf](functions/modulesOf.md)
+- [readModules](functions/readModules.md)
+- [selectModules](functions/selectModules.md)

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

@@ -0,0 +1,28 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/modules](../README.md) / isFetchable
+
+# Function: isFetchable()
+
+> **isFetchable**(`path`): `boolean`
+
+Defined in: [packages/release-go/src/modules.ts:135](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/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.
+
+## Parameters
+
+### path
+
+`string`
+
+The path of a module.
+
+## Returns
+
+`boolean`
+
+Whether it can be fetched.

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

@@ -0,0 +1,28 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/modules](../README.md) / isGoMod
+
+# Function: isGoMod()
+
+> **isGoMod**(`file`): `boolean`
+
+Defined in: [packages/release-go/src/modules.ts:41](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/modules.ts#L41)
+
+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.
+
+## Parameters
+
+### file
+
+`string`
+
+The file, from the root of the repo.
+
+## Returns
+
+`boolean`
+
+Whether it is.

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

@@ -0,0 +1,37 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/modules](../README.md) / majorErrors
+
+# Function: majorErrors()
+
+> **majorErrors**(`modules`, `version`): [`GoError`](../../errors/classes/GoError.md)[]
+
+Defined in: [packages/release-go/src/modules.ts:243](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/modules.ts#L243)
+
+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
+N. Each says what to change: the `module` line of which go.mod, and each import and require of the
+module. A `gopkg.in/` path is not checked.
+
+## Parameters
+
+### modules
+
+readonly [`GoModule`](../../interfaces/GoModule.md)[]
+
+The modules of the release.
+
+### version
+
+`string`
+
+The version of the release, as `2.0.0`.
+
+## Returns
+
+[`GoError`](../../errors/classes/GoError.md)[]
+
+The errors, `EGOMAJOR`, one of each module whose path does not agree; none when each
+does.

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

@@ -0,0 +1,28 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/modules](../README.md) / majorOfPath
+
+# Function: majorOfPath()
+
+> **majorOfPath**(`path`): `number` \| `undefined`
+
+Defined in: [packages/release-go/src/modules.ts:225](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/modules.ts#L225)
+
+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.
+
+## Parameters
+
+### path
+
+`string`
+
+The path of a module.
+
+## Returns
+
+`number` \| `undefined`
+
+The major, or none.