@wtf/release-docs 8.1.0 → 8.2.1

package/api/@wtf/release-maven/artifacts/functions/selectArtifacts.md

@@ -0,0 +1,44 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/artifacts](../README.md) / selectArtifacts
+
+# Function: selectArtifacts()
+
+> **selectArtifacts**(`modules`, `selection`): [`MavenModule`](../../interfaces/MavenModule.md)[]
+
+Defined in: [packages/release-maven/src/artifacts.ts:302](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/artifacts.ts#L302)
+
+The modules a release deploys: those of its train that are published, of `include` where it
+names some, but those of `exclude`. A name of an option that the repo has not, of another train,
+or of a module of `maven.deploy.skip` that `include` names, is a fault, as a release that skips
+one by a typo deploys less than it says. A module of the release that depends on a module of
+`maven.deploy.skip`, by more than the test scope, or has it as its parent, fails too, as no
+consumer could resolve it.
+
+## Parameters
+
+### modules
+
+readonly [`MavenModule`](../../interfaces/MavenModule.md)[]
+
+The modules of the repo, as [modulesOf](modulesOf.md) gives them.
+
+### selection
+
+[`Selection`](../interfaces/Selection.md)
+
+The modules of the train, and the names to include and to exclude.
+
+## Returns
+
+[`MavenModule`](../../interfaces/MavenModule.md)[]
+
+The modules of the release, in the order of the repo: none of a train of no module to
+deploy.
+
+## Throws
+
+`EMAVENARTIFACTS` of a name of no module, of another train or not published;
+`EMAVENPRIVATE` of a dependency on a module that is not published.

package/api/@wtf/release-maven/artifacts/interfaces/Selection.md

@@ -0,0 +1,42 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/artifacts](../README.md) / Selection
+
+# Interface: Selection
+
+Defined in: [packages/release-maven/src/artifacts.ts:275](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/artifacts.ts#L275)
+
+The names a selection of modules is made of.
+
+## Properties
+
+### exclude?
+
+> `readonly` `optional` **exclude?**: readonly `string`[]
+
+Defined in: [packages/release-maven/src/artifacts.ts:284](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/artifacts.ts#L284)
+
+The modules not to deploy, by name, of the ones `include` or the train gives.
+
+***
+
+### include?
+
+> `readonly` `optional` **include?**: readonly `string`[]
+
+Defined in: [packages/release-maven/src/artifacts.ts:282](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/artifacts.ts#L282)
+
+The modules to deploy, by name: every published module of the train by default.
+
+***
+
+### train
+
+> `readonly` **train**: `ReadonlySet`\<`string`\>
+
+Defined in: [packages/release-maven/src/artifacts.ts:280](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/artifacts.ts#L280)
+
+The modules of the train of the release, by name, as `ownersOf` of
+`@wtf/release-trains/packages` gives them: the release deploys of these alone.

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

@@ -0,0 +1,41 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/release-maven/ecosystem
+
+# @wtf/release-maven/ecosystem
+
+The ecosystem of Maven ([mavenEcosystem](variables/mavenEcosystem.md)), as the trains read it, and the default export of
+the package, which a config names in `ecosystems` as `'@wtf/release-maven'`: the modules of the
+repo, each pom.xml git tracks (`readModules` of `./artifacts`), of the working tree or of a
+commit; a version of a dependency published as the release's version, a range of its author's own
+as it is ([resolveVersion](functions/resolveVersion.md)); and Maven's ranges, by Maven's order of versions
+([compareVersions](functions/compareVersions.md), [satisfiesVersion](functions/satisfiesVersion.md)).
+
+```js
+// release.config.mjs
+export default {
+  trains: {
+    core: { paths: ['core'] },
+    client: { paths: ['client'] }
+  },
+  ecosystems: ['@wtf/release-maven']
+}
+```
+
+## Interfaces
+
+- [Bound](interfaces/Bound.md)
+- [Restriction](interfaces/Restriction.md)
+
+## Variables
+
+- [mavenEcosystem](variables/mavenEcosystem.md)
+
+## Functions
+
+- [compareVersions](functions/compareVersions.md)
+- [parseRange](functions/parseRange.md)
+- [resolveVersion](functions/resolveVersion.md)
+- [satisfiesVersion](functions/satisfiesVersion.md)

package/api/@wtf/release-maven/ecosystem/functions/compareVersions.md

@@ -0,0 +1,38 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/ecosystem](../README.md) / compareVersions
+
+# Function: compareVersions()
+
+> **compareVersions**(`left`, `right`): `number`
+
+Defined in: [packages/release-maven/src/ecosystem.ts:115](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/ecosystem.ts#L115)
+
+Two versions compared by Maven's order of versions, a light one of its `ComparableVersion`: the
+items of each, split at `.`, `-` and where digits and letters meet, compared in turn; a number
+by its value, a missing one `0`; a qualifier by its rank, `alpha` (`a`) < `beta` (`b`) <
+`milestone` (`m`) < `rc` (`cr`) < `snapshot` < none (`ga`, `final`, `release`) < `sp` < any
+other, by its letters; and a number after any qualifier. So `1.5.0-beta.1` < `1.5.0` <
+`1.5.0-sp1`, `1.0` is `1.0.0`, and `1.0-SNAPSHOT` < `1.0`.
+
+## Parameters
+
+### left
+
+`string`
+
+A version, as `1.5.0`.
+
+### right
+
+`string`
+
+The other, as `1.5.0-beta.1`.
+
+## Returns
+
+`number`
+
+Below 0, 0 or above 0, as `left` is below, equal to or above `right`.

package/api/@wtf/release-maven/ecosystem/functions/parseRange.md

@@ -0,0 +1,28 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/ecosystem](../README.md) / parseRange
+
+# Function: parseRange()
+
+> **parseRange**(`range`): [`Restriction`](../interfaces/Restriction.md)[] \| `undefined`
+
+Defined in: [packages/release-maven/src/ecosystem.ts:157](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/ecosystem.ts#L157)
+
+The sets of a range of Maven's, as `[1.0,1.2),[1.5,)`: each of its bounds; `[1.0]` of both, the
+version alone. `undefined` of text that is no range.
+
+## Parameters
+
+### range
+
+`string`
+
+The range, as a pom writes it.
+
+## Returns
+
+[`Restriction`](../interfaces/Restriction.md)[] \| `undefined`
+
+Its sets, in order, or `undefined`.

package/api/@wtf/release-maven/ecosystem/functions/resolveVersion.md

@@ -0,0 +1,36 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/ecosystem](../README.md) / resolveVersion
+
+# Function: resolveVersion()
+
+> **resolveVersion**(`range`, `version`): `string`
+
+Defined in: [packages/release-maven/src/ecosystem.ts:221](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/ecosystem.ts#L221)
+
+The version a release publishes of a dependency on a module of `version`, the release of its
+train: a range of its author's own, as `[1.0,2.0)`, is itself, as the stamp leaves it; anything
+else, an exact version, `${project.version}` or any `${…}`, is the version, as the stamp writes it.
+
+## Parameters
+
+### range
+
+`string`
+
+The text of the `<version>` of the dependency, as the pom writes it before the
+stamp.
+
+### version
+
+`string`
+
+The release of the module it depends on, as `1.4.0`.
+
+## Returns
+
+`string`
+
+The version or the range the release publishes.

package/api/@wtf/release-maven/ecosystem/functions/satisfiesVersion.md

@@ -0,0 +1,36 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/ecosystem](../README.md) / satisfiesVersion
+
+# Function: satisfiesVersion()
+
+> **satisfiesVersion**(`range`, `version`): `boolean`
+
+Defined in: [packages/release-maven/src/ecosystem.ts:194](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/ecosystem.ts#L194)
+
+Whether `version` is within `range`, by Maven's rules: a range (`[` or `(` first) by its bounds,
+in Maven's order of versions ([compareVersions](compareVersions.md)), any of its sets; anything else, a bare
+version or a `${…}`, is Maven's soft requirement, which takes any version. A range Maven cannot
+read takes none.
+
+## Parameters
+
+### range
+
+`string`
+
+A range or a version, as a pom writes it, as `[1.0,2.0)`.
+
+### version
+
+`string`
+
+A version, as `1.5.0`.
+
+## Returns
+
+`boolean`
+
+Whether the range takes the version.

package/api/@wtf/release-maven/ecosystem/interfaces/Bound.md

@@ -0,0 +1,31 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/ecosystem](../README.md) / Bound
+
+# Interface: Bound
+
+Defined in: [packages/release-maven/src/ecosystem.ts:135](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/ecosystem.ts#L135)
+
+A bound of a range of Maven's: its version, and whether the range takes it.
+
+## Properties
+
+### inclusive
+
+> `readonly` **inclusive**: `boolean`
+
+Defined in: [packages/release-maven/src/ecosystem.ts:139](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/ecosystem.ts#L139)
+
+Whether the range takes the version itself: `[` or `]`.
+
+***
+
+### version
+
+> `readonly` **version**: `string`
+
+Defined in: [packages/release-maven/src/ecosystem.ts:137](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/ecosystem.ts#L137)
+
+The version, as `1.0`.

package/api/@wtf/release-maven/ecosystem/interfaces/Restriction.md

@@ -0,0 +1,31 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/ecosystem](../README.md) / Restriction
+
+# Interface: Restriction
+
+Defined in: [packages/release-maven/src/ecosystem.ts:143](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/ecosystem.ts#L143)
+
+A set of a range of Maven's, as `[1.0,2.0)`: its bounds, none where it is open.
+
+## Properties
+
+### lower
+
+> `readonly` **lower**: [`Bound`](Bound.md) \| `undefined`
+
+Defined in: [packages/release-maven/src/ecosystem.ts:145](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/ecosystem.ts#L145)
+
+Its lower bound, none of `(,1.0]`.
+
+***
+
+### upper
+
+> `readonly` **upper**: [`Bound`](Bound.md) \| `undefined`
+
+Defined in: [packages/release-maven/src/ecosystem.ts:147](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/ecosystem.ts#L147)
+
+Its upper bound, none of `[1.0,)`.

package/api/@wtf/release-maven/ecosystem/variables/mavenEcosystem.md

@@ -0,0 +1,15 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/ecosystem](../README.md) / mavenEcosystem
+
+# Variable: mavenEcosystem
+
+> `const` **mavenEcosystem**: [`Ecosystem`](../../../release-trains/ecosystem/interfaces/Ecosystem.md)
+
+Defined in: [packages/release-maven/src/ecosystem.ts:229](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/ecosystem.ts#L229)
+
+The ecosystem of Maven: its packages, each pom.xml of the repo, of the working tree or of a
+commit (`readModules` of `./artifacts`); a dependency published as the stamp writes it
+([resolveVersion](../functions/resolveVersion.md)); and Maven's ranges ([satisfiesVersion](../functions/satisfiesVersion.md)).

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

@@ -0,0 +1,25 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/release-maven/errors
+
+# @wtf/release-maven/errors
+
+What the release of Maven modules throws: [MavenError](classes/MavenError.md), a `ReleaseError` of
+`@wtf/release-system/errors` of the codes of [MAVEN\_ERRORS](variables/MAVEN_ERRORS.md), which semantic-release prints by
+its mark, beside the codes of the options of a plugin, its `SYSTEM_ERRORS` (`EOPTIONS`). What is
+the same of every ecosystem, as a dependency on a module of no train or of a train with no
+release, is the trains' own, `TRAINS_ERRORS` of `@wtf/release-trains/errors`.
+
+## Classes
+
+- [MavenError](classes/MavenError.md)
+
+## Type Aliases
+
+- [MavenErrorCode](type-aliases/MavenErrorCode.md)
+
+## Variables
+
+- [MAVEN\_ERRORS](variables/MAVEN_ERRORS.md)

package/api/@wtf/release-maven/errors/classes/MavenError.md

@@ -0,0 +1,268 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/errors](../README.md) / MavenError
+
+# Class: MavenError
+
+Defined in: [packages/release-maven/src/errors.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/errors.ts#L40)
+
+An error of the Maven modules, or of the options of the plugin over them: a stable `code`, of
+[MAVEN\_ERRORS](../variables/MAVEN_ERRORS.md) or of `SYSTEM_ERRORS` of `@wtf/release-system/errors`, its `message` what is
+wrong, and its `details` how to fix it.
+
+## Extends
+
+- [`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md)
+
+## Constructors
+
+### Constructor
+
+> **new MavenError**(`code`, `message`, `details`): `MavenError`
+
+Defined in: [packages/release-system/src/errors.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-system/src/errors.ts#L54)
+
+An error of `code`, of its `message` and its `details`, named `SemanticReleaseError`, as
+semantic-release prints one.
+
+#### Parameters
+
+##### code
+
+`string`
+
+The stable code of the error, as `EGIT`.
+
+##### message
+
+`string`
+
+What is wrong, as a reader is told it.
+
+##### details
+
+`string`
+
+How to fix it, of the steps a reader takes.
+
+#### Returns
+
+`MavenError`
+
+#### Inherited from
+
+[`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`constructor`](../../../release-system/errors/classes/ReleaseError.md#constructor)
+
+## Properties
+
+### cause?
+
+> `optional` **cause?**: `unknown`
+
+Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24
+
+#### Inherited from
+
+[`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`cause`](../../../release-system/errors/classes/ReleaseError.md#cause)
+
+***
+
+### code
+
+> `readonly` **code**: `string`
+
+Defined in: [packages/release-system/src/errors.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-system/src/errors.ts#L40)
+
+The stable code of the error, as `EGIT`.
+
+#### Inherited from
+
+[`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`code`](../../../release-system/errors/classes/ReleaseError.md#code)
+
+***
+
+### details
+
+> `readonly` **details**: `string`
+
+Defined in: [packages/release-system/src/errors.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-system/src/errors.ts#L42)
+
+How to fix it.
+
+#### Inherited from
+
+[`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`details`](../../../release-system/errors/classes/ReleaseError.md#details)
+
+***
+
+### message
+
+> **message**: `string`
+
+Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1075
+
+#### Inherited from
+
+[`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`message`](../../../release-system/errors/classes/ReleaseError.md#message)
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1074
+
+#### Inherited from
+
+[`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`name`](../../../release-system/errors/classes/ReleaseError.md#name)
+
+***
+
+### semanticRelease
+
+> `readonly` **semanticRelease**: `true`
+
+Defined in: [packages/release-system/src/errors.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-system/src/errors.ts#L44)
+
+The mark semantic-release prints an error of a plugin by.
+
+#### Inherited from
+
+[`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`semanticRelease`](../../../release-system/errors/classes/ReleaseError.md#semanticrelease)
+
+***
+
+### stack?
+
+> `optional` **stack?**: `string`
+
+Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
+
+#### Inherited from
+
+[`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`stack`](../../../release-system/errors/classes/ReleaseError.md#stack)
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+Defined in: node\_modules/.pnpm/@types+node@24.19.2/node\_modules/@types/node/globals.d.ts:68
+
+The `Error.stackTraceLimit` property specifies the number of stack frames
+collected by a stack trace (whether generated by `new Error().stack` or
+`Error.captureStackTrace(obj)`).
+
+The default value is `10` but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured _after_ the value has been changed.
+
+If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
+
+#### Inherited from
+
+[`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`stackTraceLimit`](../../../release-system/errors/classes/ReleaseError.md#stacktracelimit)
+
+## Methods
+
+### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: node\_modules/.pnpm/@types+node@24.19.2/node\_modules/@types/node/globals.d.ts:52
+
+Creates a `.stack` property on `targetObject`, which when accessed returns
+a string representing the location in the code at which
+`Error.captureStackTrace()` was called.
+
+```js
+const myObject = {};
+Error.captureStackTrace(myObject);
+myObject.stack;  // Similar to `new Error().stack`
+```
+
+The first line of the trace will be prefixed with
+`${myObject.name}: ${myObject.message}`.
+
+The optional `constructorOpt` argument accepts a function. If given, all frames
+above `constructorOpt`, including `constructorOpt`, will be omitted from the
+generated stack trace.
+
+The `constructorOpt` argument is useful for hiding implementation
+details of error generation from the user. For instance:
+
+```js
+function a() {
+  b();
+}
+
+function b() {
+  c();
+}
+
+function c() {
+  // Create an error without stack trace to avoid calculating the stack trace twice.
+  const { stackTraceLimit } = Error;
+  Error.stackTraceLimit = 0;
+  const error = new Error();
+  Error.stackTraceLimit = stackTraceLimit;
+
+  // Capture the stack trace above function b
+  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
+  throw error;
+}
+
+a();
+```
+
+#### Parameters
+
+##### targetObject
+
+`object`
+
+##### constructorOpt?
+
+`Function`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`captureStackTrace`](../../../release-system/errors/classes/ReleaseError.md#capturestacktrace)
+
+***
+
+### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+Defined in: node\_modules/.pnpm/@types+node@24.19.2/node\_modules/@types/node/globals.d.ts:56
+
+#### Parameters
+
+##### err
+
+`Error`
+
+##### stackTraces
+
+`CallSite`[]
+
+#### Returns
+
+`any`
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+[`ReleaseError`](../../../release-system/errors/classes/ReleaseError.md).[`prepareStackTrace`](../../../release-system/errors/classes/ReleaseError.md#preparestacktrace)

package/api/@wtf/release-maven/errors/type-aliases/MavenErrorCode.md

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/errors](../README.md) / MavenErrorCode
+
+# Type Alias: MavenErrorCode
+
+> **MavenErrorCode** = keyof *typeof* [`MAVEN_ERRORS`](../variables/MAVEN_ERRORS.md)
+
+Defined in: [packages/release-maven/src/errors.ts:33](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/release-maven/src/errors.ts#L33)
+
+A code of [MAVEN\_ERRORS](../variables/MAVEN_ERRORS.md).