@wtf/release-docs 8.1.0 → 8.2.1

package/api/@wtf/release-maven/repository/functions/deployTargets.md

@@ -0,0 +1,46 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / deployTargets
+
+# Function: deployTargets()
+
+> **deployTargets**(`modules`, `option`, `env`): `Map`\<`string`, [`Repository`](../interfaces/Repository.md)\>
+
+Defined in: [packages/release-maven/src/repository.ts:126](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/repository.ts#L126)
+
+The repository each module deploys to, by its name: `option` where it is given, else the
+repository of its `distributionManagement`, or of its parents' in the repo, each `${…}` of its URL
+written of the module's properties and the environment.
+
+## Parameters
+
+### modules
+
+readonly [`MavenModule`](../../interfaces/MavenModule.md)[]
+
+The modules of the release.
+
+### option
+
+[`Repository`](../interfaces/Repository.md) \| `undefined`
+
+The repository the plugin's options name: none, each module's own.
+
+### env
+
+`Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
+
+The environment, which `${env.NAME}` of a URL names.
+
+## Returns
+
+`Map`\<`string`, [`Repository`](../interfaces/Repository.md)\>
+
+The repository of each module, by its name.
+
+## Throws
+
+`EMAVENREPOSITORY` of each module of no repository, of no `id` or no `url`, or of a URL
+of a `${…}` of no value, together.

package/api/@wtf/release-maven/repository/functions/expandValues.md

@@ -0,0 +1,42 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / expandValues
+
+# Function: expandValues()
+
+> **expandValues**(`text`, `values`): `object`
+
+Defined in: [packages/release-maven/src/repository.ts:100](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/repository.ts#L100)
+
+The text `text` of each `${…}` it holds written as its value: `${env.NAME}` of the environment, any
+other of the properties; the names of those of no value are given apart, and left in the text.
+
+## Parameters
+
+### text
+
+`string`
+
+The text, as a pom writes it, as `${env.CI_API_V4_URL}/projects/1/packages/maven`.
+
+### values
+
+[`ValuesOf`](../interfaces/ValuesOf.md)
+
+The properties and the environment.
+
+## Returns
+
+`object`
+
+The text, and the names of no value.
+
+### text
+
+> `readonly` **text**: `string`
+
+### unknown
+
+> `readonly` **unknown**: readonly `string`[]

package/api/@wtf/release-maven/repository/functions/hasPom.md

@@ -0,0 +1,38 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / hasPom
+
+# Function: hasPom()
+
+> **hasPom**(`status`, `url`): `boolean`
+
+Defined in: [packages/release-maven/src/repository.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/repository.ts#L72)
+
+Whether the answer of a repository to a request of a pom says it has it: a 2xx yes, a 404 no.
+
+## Parameters
+
+### status
+
+`number`
+
+The status of the answer.
+
+### url
+
+`string`
+
+The URL of the pom, as an error names it.
+
+## Returns
+
+`boolean`
+
+Whether the repository has the pom.
+
+## Throws
+
+`EMAVENREPOSITORY` of any other status, as of a repository that refuses the credentials
+or is down: the release cannot know what it has.

package/api/@wtf/release-maven/repository/functions/pomPath.md

@@ -0,0 +1,40 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / pomPath
+
+# Function: pomPath()
+
+> **pomPath**(`groupId`, `artifactId`, `version`): `string`
+
+Defined in: [packages/release-maven/src/repository.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/repository.ts#L44)
+
+The path of the pom of a module at a version in the layout of a Maven repository: the groupId
+of a folder for each part, then the artifactId and the version.
+
+## Parameters
+
+### groupId
+
+`string`
+
+The groupId, as `org.acme`.
+
+### artifactId
+
+`string`
+
+The artifactId, as `core`.
+
+### version
+
+`string`
+
+The version, as `1.2.3`.
+
+## Returns
+
+`string`
+
+The path, as `org/acme/core/1.2.3/core-1.2.3.pom`.

package/api/@wtf/release-maven/repository/functions/pomUrl.md

@@ -0,0 +1,45 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / pomUrl
+
+# Function: pomUrl()
+
+> **pomUrl**(`base`, `groupId`, `artifactId`, `version`): `string`
+
+Defined in: [packages/release-maven/src/repository.ts:56](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/repository.ts#L56)
+
+The URL of the pom of a module at a version in the repository of `base`.
+
+## Parameters
+
+### base
+
+`string`
+
+The URL of the repository, as `https://repo1.maven.org/maven2`.
+
+### groupId
+
+`string`
+
+The groupId.
+
+### artifactId
+
+`string`
+
+The artifactId.
+
+### version
+
+`string`
+
+The version.
+
+## Returns
+
+`string`
+
+The URL of the pom.

package/api/@wtf/release-maven/repository/interfaces/Repository.md

@@ -0,0 +1,31 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / Repository
+
+# Interface: Repository
+
+Defined in: [packages/release-maven/src/repository.ts:28](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/repository.ts#L28)
+
+A repository a module deploys to: the `<server>` of settings.xml of its credentials, and its URL.
+
+## Properties
+
+### id
+
+> `readonly` **id**: `string`
+
+Defined in: [packages/release-maven/src/repository.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/repository.ts#L30)
+
+Its id, which names the `<server>` of settings.xml Maven deploys by.
+
+***
+
+### url
+
+> `readonly` **url**: `string`
+
+Defined in: [packages/release-maven/src/repository.ts:32](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/repository.ts#L32)
+
+Its URL.

package/api/@wtf/release-maven/repository/interfaces/ValuesOf.md

@@ -0,0 +1,31 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / ValuesOf
+
+# Interface: ValuesOf
+
+Defined in: [packages/release-maven/src/repository.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/repository.ts#L85)
+
+The values a `${…}` of a URL names.
+
+## Properties
+
+### env
+
+> `readonly` **env**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
+
+Defined in: [packages/release-maven/src/repository.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/repository.ts#L89)
+
+The environment, which `${env.NAME}` names.
+
+***
+
+### properties
+
+> `readonly` **properties**: `ReadonlyMap`\<`string`, `string`\>
+
+Defined in: [packages/release-maven/src/repository.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/repository.ts#L87)
+
+The properties of the module, of its parents in the repo, its own over theirs.

package/api/@wtf/release-maven/repository/variables/MAVEN_CENTRAL.md

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/repository](../README.md) / MAVEN\_CENTRAL
+
+# Variable: MAVEN\_CENTRAL
+
+> `const` **MAVEN\_CENTRAL**: `"https://repo1.maven.org/maven2"` = `'https://repo1.maven.org/maven2'`
+
+Defined in: [packages/release-maven/src/repository.ts:25](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/repository.ts#L25)
+
+Maven Central, as it is read: what the Central Portal publishes is served here.

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

@@ -0,0 +1,50 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/release-maven/stamp
+
+# @wtf/release-maven/stamp
+
+The versions of the trains written into the poms of a repo, of no XML serializer: the reader of
+`./pom` gives where each element and its text are in the file, and the stamp writes each version
+into the text at its place, so every other byte, the comments, the layout and the line ends, stays
+as it was, and a release commit changes the versions alone. 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, of
+every pom of the repo:
+
+- the `<version>` of the project of each module that takes a version, a `${revision}` too;
+- the `<version>` of its `<parent>`, where the parent is a module of the repo that takes a
+  version;
+- the `<version>` of each `<dependency>`, wherever the pom holds one (its dependencies, its
+  `dependencyManagement`, the dependencies of a plugin, a profile), and of each `<plugin>`, that
+  names a module that takes a version, but a range, as `[1.0,2.0)`, which is its author's own.
+
+A dependency of no `<version>` is left: it takes the version its `dependencyManagement` gives, which
+is stamped. A module that takes a version and writes no `<version>` of its own takes its parent's,
+so its parent must take the same version: a module of another train than its parent, or whose
+parent is not of the repo, needs a `<version>` of its own (`EMAVENSTAMP`). A module of no train that
+inherits its version moves with its parent.
+
+```ts
+import { stampPom } from '@wtf/release-maven/stamp'
+
+const { text } = stampPom(
+  '<project>\n  <groupId>acme</groupId>\n  <artifactId>core</artifactId>\n  <!-- the tag is the version -->\n  <version>0.0.0-SNAPSHOT</version>\n</project>\n',
+  { groupId: 'acme', version: '1.2.3', parent: undefined, artifacts: new Map() }
+)
+console.log(text)
+```
+
+## Interfaces
+
+- [PomStampOptions](interfaces/PomStampOptions.md)
+- [Stamped](interfaces/Stamped.md)
+- [StampedModules](interfaces/StampedModules.md)
+
+## Functions
+
+- [checkVersions](functions/checkVersions.md)
+- [stampModules](functions/stampModules.md)
+- [stampPom](functions/stampPom.md)

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

@@ -0,0 +1,36 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/stamp](../README.md) / checkVersions
+
+# Function: checkVersions()
+
+> **checkVersions**(`modules`, `versions`): `void`
+
+Defined in: [packages/release-maven/src/stamp.ts:264](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/stamp.ts#L264)
+
+The modules that are not at the version they take, of their poms read again: what a stamp left
+wrong, as a module whose version is of a property the stamp does not write.
+
+## Parameters
+
+### modules
+
+readonly [`MavenModule`](../../interfaces/MavenModule.md)[]
+
+The modules, as `readModules` of `./artifacts` gives them after the stamp.
+
+### versions
+
+`ReadonlyMap`\<`string`, `string`\>
+
+The version each module takes, by its name: a module of none is not checked.
+
+## Returns
+
+`void`
+
+## Throws
+
+`EMAVENVERSION` of a module at another version.

package/api/@wtf/release-maven/stamp/functions/stampModules.md

@@ -0,0 +1,55 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/stamp](../README.md) / stampModules
+
+# Function: stampModules()
+
+> **stampModules**(`system`, `cwd`, `modules`, `versions`): `Promise`\<[`StampedModules`](../interfaces/StampedModules.md)\>
+
+Defined in: [packages/release-maven/src/stamp.ts:216](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/stamp.ts#L216)
+
+Writes `versions` into the poms of `modules`, as the module says: of each module that takes a
+version, its project's `<version>`, the `<parent>` of each child of it, and each dependency and
+plugin that names it, in every pom of the repo. A module that takes no version, as of no train,
+keeps its own, and what names it is left. A pom of no change is not written.
+
+## Parameters
+
+### system
+
+[`System`](../../../release-system/system/interfaces/System.md)
+
+The system the poms are read and written by.
+
+### cwd
+
+`string`
+
+The folder of the repo.
+
+### modules
+
+readonly [`MavenModule`](../../interfaces/MavenModule.md)[]
+
+The modules of the repo, as `readModules` of `./artifacts` gives them.
+
+### versions
+
+`ReadonlyMap`\<`string`, `string`\>
+
+The version each module takes, by its name: of the modules of the train of the
+release, the release's, and of each other train's, its last release (`releasedVersions` of
+`@wtf/release-trains/packages`).
+
+## Returns
+
+`Promise`\<[`StampedModules`](../interfaces/StampedModules.md)\>
+
+The poms written, and how many values.
+
+## Throws
+
+`EMAVENSTAMP` of a module that inherits a version its parent does not take, or of a
+version the stamp cannot write, every one of them together.

package/api/@wtf/release-maven/stamp/functions/stampPom.md

@@ -0,0 +1,45 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/stamp](../README.md) / stampPom
+
+# Function: stampPom()
+
+> **stampPom**(`text`, `options`, `file?`): [`Stamped`](../interfaces/Stamped.md)
+
+Defined in: [packages/release-maven/src/stamp.ts:127](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/stamp.ts#L127)
+
+The pom `text` with the versions written, as the module says: every byte but those of the
+versions as it was. Idempotent: stamped twice, the second changes nothing.
+
+## Parameters
+
+### text
+
+`string`
+
+The pom.xml.
+
+### options
+
+[`PomStampOptions`](../interfaces/PomStampOptions.md)
+
+The groupId of the module, the version of its project and of its parent, and the
+version of each module of the repo that takes one.
+
+### file?
+
+`string` = `'pom.xml'`
+
+The pom, as an error names it.
+
+## Returns
+
+[`Stamped`](../interfaces/Stamped.md)
+
+The pom stamped, and the count of values it wrote.
+
+## Throws
+
+`EMAVENPOM` of a pom that is no XML, `EMAVENSTAMP` of a version the stamp cannot write.

package/api/@wtf/release-maven/stamp/interfaces/PomStampOptions.md

@@ -0,0 +1,51 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/stamp](../README.md) / PomStampOptions
+
+# Interface: PomStampOptions
+
+Defined in: [packages/release-maven/src/stamp.ts:46](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/stamp.ts#L46)
+
+What to write into a pom.
+
+## Properties
+
+### artifacts
+
+> `readonly` **artifacts**: `ReadonlyMap`\<`string`, `string`\>
+
+Defined in: [packages/release-maven/src/stamp.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/stamp.ts#L54)
+
+The version of each module of the repo that takes one, by its name, `groupId:artifactId`.
+
+***
+
+### groupId
+
+> `readonly` **groupId**: `string`
+
+Defined in: [packages/release-maven/src/stamp.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/stamp.ts#L48)
+
+The groupId of the module, which `${project.groupId}` of a dependency names.
+
+***
+
+### parent
+
+> `readonly` **parent**: `string` \| `undefined`
+
+Defined in: [packages/release-maven/src/stamp.ts:52](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/stamp.ts#L52)
+
+The version of its `<parent>`, of a parent of the repo that takes one: none, it is left.
+
+***
+
+### version
+
+> `readonly` **version**: `string` \| `undefined`
+
+Defined in: [packages/release-maven/src/stamp.ts:50](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/stamp.ts#L50)
+
+The version of the project, of a module that takes one: none, it is left.

package/api/@wtf/release-maven/stamp/interfaces/Stamped.md

@@ -0,0 +1,31 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/stamp](../README.md) / Stamped
+
+# Interface: Stamped
+
+Defined in: [packages/release-maven/src/stamp.ts:58](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/stamp.ts#L58)
+
+A pom stamped, and how many values it wrote.
+
+## Properties
+
+### changes
+
+> `readonly` **changes**: `number`
+
+Defined in: [packages/release-maven/src/stamp.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/stamp.ts#L62)
+
+The values that were another, and are of the versions now.
+
+***
+
+### text
+
+> `readonly` **text**: `string`
+
+Defined in: [packages/release-maven/src/stamp.ts:60](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/stamp.ts#L60)
+
+The pom, the versions written.

package/api/@wtf/release-maven/stamp/interfaces/StampedModules.md

@@ -0,0 +1,31 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/stamp](../README.md) / StampedModules
+
+# Interface: StampedModules
+
+Defined in: [packages/release-maven/src/stamp.ts:164](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/stamp.ts#L164)
+
+The result of stamping the poms of a repo: the poms written, and the values in them.
+
+## Properties
+
+### changes
+
+> `readonly` **changes**: `number`
+
+Defined in: [packages/release-maven/src/stamp.ts:168](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/stamp.ts#L168)
+
+The values written.
+
+***
+
+### files
+
+> `readonly` **files**: readonly `string`[]
+
+Defined in: [packages/release-maven/src/stamp.ts:166](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/stamp.ts#L166)
+
+The poms whose text changed, from the root of the repo.

package/api/@wtf/release-npm/check/functions/checkPackages.md

@@ -8,7 +8,7 @@
 
 > **checkPackages**(`packages`, `options?`): [`Issue`](../interfaces/Issue.md)[]
 
-Defined in: [packages/release-npm/src/check.ts:147](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/check.ts#L147)
+Defined in: [packages/release-npm/src/check.ts:147](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/check.ts#L147)
 
 The faults of `packages`, the packages of a train that publish, as each would publish: those of
 each alone, a dependency of one on a private package of `workspace`, and those of the order of

package/api/@wtf/release-npm/check/functions/formatIssue.md

@@ -8,7 +8,7 @@
 
 > **formatIssue**(`issue`): `string`
 
-Defined in: [packages/release-npm/src/check.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/check.ts#L74)
+Defined in: [packages/release-npm/src/check.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/check.ts#L74)
 
 A fault, as one line: its folder, its package's name, and what it is.
 

package/api/@wtf/release-npm/check/interfaces/CheckOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: CheckOptions
 
-Defined in: [packages/release-npm/src/check.ts:55](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/check.ts#L55)
+Defined in: [packages/release-npm/src/check.ts:55](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/check.ts#L55)
 
 What is checked.
 
@@ -16,7 +16,7 @@ What is checked.
 
 > `readonly` `optional` **access?**: `"public"` \| `"restricted"`
 
-Defined in: [packages/release-npm/src/check.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/check.ts#L63)
+Defined in: [packages/release-npm/src/check.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/check.ts#L63)
 
 The access every package publishes with, of the option, over each one's own.
 
@@ -26,7 +26,7 @@ The access every package publishes with, of the option, over each one's own.
 
 > `readonly` `optional` **conditions?**: readonly `string`[]
 
-Defined in: [packages/release-npm/src/check.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/check.ts#L65)
+Defined in: [packages/release-npm/src/check.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/check.ts#L65)
 
 The export conditions of the source: `['source']`.
 
@@ -36,7 +36,7 @@ The export conditions of the source: `['source']`.
 
 > `readonly` `optional` **faults?**: readonly [`OrderFault`](../../../release-trains/packages/interfaces/OrderFault.md)[]
 
-Defined in: [packages/release-npm/src/check.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/check.ts#L59)
+Defined in: [packages/release-npm/src/check.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/check.ts#L59)
 
 What is wrong with the order of publishing, as `publishOrder` found it.
 
@@ -46,7 +46,7 @@ What is wrong with the order of publishing, as `publishOrder` found it.
 
 > `readonly` `optional` **prepared?**: `boolean`
 
-Defined in: [packages/release-npm/src/check.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/check.ts#L57)
+Defined in: [packages/release-npm/src/check.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/check.ts#L57)
 
 Whether the packages are prepared, as they are about to publish: `true`.
 
@@ -56,6 +56,6 @@ Whether the packages are prepared, as they are about to publish: `true`.
 
 > `readonly` `optional` **workspace?**: readonly [`CheckedPackage`](../type-aliases/CheckedPackage.md)[]
 
-Defined in: [packages/release-npm/src/check.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-npm/src/check.ts#L61)
+Defined in: [packages/release-npm/src/check.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-npm/src/check.ts#L61)
 
 Every package of the workspace, private ones too, as a dependency is found among them.