@wtf/release-docs 8.1.0 → 8.2.0

package/api/@wtf/release-go/tags/functions/tagOfModule.md

@@ -0,0 +1,34 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/tags](../README.md) / tagOfModule
+
+# Function: tagOfModule()
+
+> **tagOfModule**(`module`, `version`): `string`
+
+Defined in: [packages/release-go/src/tags.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L61)
+
+The tag of `module` at `version`, as Go looks it up: `<prefix>/v<version>`, `v<version>` of a
+module whose prefix is the root ([tagPrefix](tagPrefix.md)).
+
+## Parameters
+
+### module
+
+`Pick`\<[`GoModule`](../../interfaces/GoModule.md), `"path"` \| `"dir"`\>
+
+The module, of its path and its folder.
+
+### version
+
+`string`
+
+The version, as `1.2.3`.
+
+## Returns
+
+`string`
+
+The tag, as `lib/v1.2.3`.

package/api/@wtf/release-go/tags/functions/tagPrefix.md

@@ -0,0 +1,29 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/tags](../README.md) / tagPrefix
+
+# Function: tagPrefix()
+
+> **tagPrefix**(`module`): `string`
+
+Defined in: [packages/release-go/src/tags.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L45)
+
+The prefix of the tags of `module`, as Go looks them up: its folder, `.` at the root; of a module
+in a folder of its major (a path that ends in `/vN`, in the folder `vN` or one that ends in
+`/vN`), the folder above it, as Go finds `lib/v2/go.mod` by the tag `lib/v2.0.0`.
+
+## Parameters
+
+### module
+
+`Pick`\<[`GoModule`](../../interfaces/GoModule.md), `"path"` \| `"dir"`\>
+
+The module, of its path and its folder.
+
+## Returns
+
+`string`
+
+The prefix, as `lib`; `.` of the root.

package/api/@wtf/release-go/tags/interfaces/TagModulesOptions.md

@@ -0,0 +1,93 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/tags](../README.md) / TagModulesOptions
+
+# Interface: TagModulesOptions
+
+Defined in: [packages/release-go/src/tags.ts:214](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L214)
+
+What a release of tags needs.
+
+## Properties
+
+### context
+
+> `readonly` **context**: [`GitContext`](../../../release-system/git/interfaces/GitContext.md)
+
+Defined in: [packages/release-go/src/tags.ts:216](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L216)
+
+The folder of the repo, its environment, and the system git runs by.
+
+***
+
+### files
+
+> `readonly` **files**: readonly `string`[]
+
+Defined in: [packages/release-go/src/tags.ts:224](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L224)
+
+The go.mod files the stamp wrote, from the root of the repo, which the commit holds.
+
+***
+
+### log
+
+> `readonly` **log**: (`line`) => `void`
+
+Defined in: [packages/release-go/src/tags.ts:232](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L232)
+
+Says a line of what is done.
+
+#### Parameters
+
+##### line
+
+`string`
+
+The line.
+
+#### Returns
+
+`void`
+
+***
+
+### message
+
+> `readonly` **message**: `string`
+
+Defined in: [packages/release-go/src/tags.ts:226](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L226)
+
+The message of the commit the tags name.
+
+***
+
+### modules
+
+> `readonly` **modules**: readonly [`GoModule`](../../interfaces/GoModule.md)[]
+
+Defined in: [packages/release-go/src/tags.ts:220](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L220)
+
+The modules of the release.
+
+***
+
+### remote
+
+> `readonly` **remote**: `string`
+
+Defined in: [packages/release-go/src/tags.ts:218](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L218)
+
+The remote the tags are pushed to, by its name or its URL, of its credentials.
+
+***
+
+### version
+
+> `readonly` **version**: `string`
+
+Defined in: [packages/release-go/src/tags.ts:222](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L222)
+
+The version of the release, as `1.2.3`.

package/api/@wtf/release-go/tags/interfaces/TaggedModule.md

@@ -0,0 +1,51 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/tags](../README.md) / TaggedModule
+
+# Interface: TaggedModule
+
+Defined in: [packages/release-go/src/tags.ts:202](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L202)
+
+A module of the release, its tag, and what became of it.
+
+## Properties
+
+### path
+
+> `readonly` **path**: `string`
+
+Defined in: [packages/release-go/src/tags.ts:204](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L204)
+
+The path of the module.
+
+***
+
+### status
+
+> `readonly` **status**: [`ModuleStatus`](../type-aliases/ModuleStatus.md)
+
+Defined in: [packages/release-go/src/tags.ts:210](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L210)
+
+Whether it was tagged and pushed, or skipped as the remote has its tag.
+
+***
+
+### tag
+
+> `readonly` **tag**: `string`
+
+Defined in: [packages/release-go/src/tags.ts:208](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L208)
+
+Its tag, as `lib/v1.2.3`.
+
+***
+
+### version
+
+> `readonly` **version**: `string`
+
+Defined in: [packages/release-go/src/tags.ts:206](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L206)
+
+The version of the release, of the module.

package/api/@wtf/release-go/tags/type-aliases/ModuleStatus.md

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/tags](../README.md) / ModuleStatus
+
+# Type Alias: ModuleStatus
+
+> **ModuleStatus** = `"tagged"` \| `"skipped"`
+
+Defined in: [packages/release-go/src/tags.ts:199](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L199)
+
+What happened to a module of the release.

package/api/@wtf/release-go/tags/variables/RELEASE_AUTHOR.md

@@ -0,0 +1,23 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-go/tags](../README.md) / RELEASE\_AUTHOR
+
+# Variable: RELEASE\_AUTHOR
+
+> `const` **RELEASE\_AUTHOR**: `object`
+
+Defined in: [packages/release-go/src/tags.ts:32](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-go/src/tags.ts#L32)
+
+The author and the committer of a release commit, where the environment names none.
+
+## Type Declaration
+
+### email
+
+> `readonly` **email**: `"semantic-release-bot@martynus.net"` = `'semantic-release-bot@martynus.net'`
+
+### name
+
+> `readonly` **name**: `"semantic-release-bot"` = `'semantic-release-bot'`

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

@@ -0,0 +1,33 @@
+[**Release trains**](../../README.md)
+
+***
+
+[Release trains](../../README.md) / @wtf/release-maven
+
+# @wtf/release-maven
+
+The modules of a Maven repo released in trains, of no release tool. Its default export is the
+ecosystem of Maven, `mavenEcosystem` of `./ecosystem`, which a config of the trains names in
+`ecosystems` as `'@wtf/release-maven'`, so the trains read the modules of the repo by it; and this
+module holds the types of the modules, which the modules of this package do with: each pom.xml
+read by a small reader of XML (`./pom`), the modules of a train in the order they deploy in
+(`./artifacts`), the versions of the trains written into the poms (`./stamp`), where a repository
+serves a pom (`./repository`), and each module it lacks deployed (`./publish`). Each function
+takes the `System` it runs by, and runs `git` and `mvn` through it.
+
+```ts
+import type { MavenModule } from '@wtf/release-maven'
+
+// The coordinates of the modules, as a release lists them.
+export const namesOf = (modules: readonly MavenModule[]): string[] => modules.map(({ name }) => name)
+```
+
+## Interfaces
+
+- [MavenModule](interfaces/MavenModule.md)
+
+## References
+
+### default
+
+Renames and re-exports [mavenEcosystem](ecosystem/variables/mavenEcosystem.md)

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

@@ -0,0 +1,41 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/release-maven/artifacts
+
+# @wtf/release-maven/artifacts
+
+The modules of a Maven repo: [readPoms](functions/readPoms.md) reads each pom.xml git tracks, of the working tree
+or of a commit; [modulesOf](functions/modulesOf.md) makes the modules of them, each of what it inherits of its
+parents in the repo and of its dependencies on the other modules; [selectArtifacts](functions/selectArtifacts.md) takes
+those a release of a train deploys; and [publishOrder](functions/publishOrder.md) puts them in the order of their
+dependencies, each after the modules it depends on, as a repository needs them deployed.
+
+```ts
+import { publishOrder, readModules, selectArtifacts } from '@wtf/release-maven/artifacts'
+import type { System } from '@wtf/release-system'
+
+// The names of the modules a release of the train of `train` deploys, in order.
+export async function names(system: System, train: ReadonlySet<string>): Promise<string[]> {
+  const modules = await readModules({ system })
+  return publishOrder(selectArtifacts(modules, { train })).map(({ name }) => name)
+}
+```
+
+## Interfaces
+
+- [Selection](interfaces/Selection.md)
+
+## Functions
+
+- [groupIdOf](functions/groupIdOf.md)
+- [installsOf](functions/installsOf.md)
+- [isPomFile](functions/isPomFile.md)
+- [isRange](functions/isRange.md)
+- [modulesOf](functions/modulesOf.md)
+- [nameOf](functions/nameOf.md)
+- [publishOrder](functions/publishOrder.md)
+- [readModules](functions/readModules.md)
+- [readPoms](functions/readPoms.md)
+- [selectArtifacts](functions/selectArtifacts.md)

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

@@ -0,0 +1,33 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/artifacts](../README.md) / groupIdOf
+
+# Function: groupIdOf()
+
+> **groupIdOf**(`groupId`, `own`): `string` \| `undefined`
+
+Defined in: [packages/release-maven/src/artifacts.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/artifacts.ts#L85)
+
+A groupId as a pom writes it, of `${project.groupId}` read as the groupId of the module.
+
+## Parameters
+
+### groupId
+
+`string` \| `undefined`
+
+The groupId, as written.
+
+### own
+
+`string`
+
+The groupId of the module.
+
+## Returns
+
+`string` \| `undefined`
+
+The groupId.

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

@@ -0,0 +1,44 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/artifacts](../README.md) / installsOf
+
+# Function: installsOf()
+
+> **installsOf**(`modules`, `release`, `served`): [`MavenModule`](../../interfaces/MavenModule.md)[]
+
+Defined in: [packages/release-maven/src/artifacts.ts:373](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/artifacts.ts#L373)
+
+The modules of the repo a release installs before it deploys, as `mvn` of one module finds the
+modules it depends on in the local repository, or in the remote one: each module the modules of
+the release depend on, by any kind, the test scope too, as Maven resolves it to build them, that
+neither the release deploys nor the remote serves, as a module of `maven.deploy.skip`, of no
+train, or of the train but excluded; and each such module those depend on, in turn.
+
+## Parameters
+
+### modules
+
+readonly [`MavenModule`](../../interfaces/MavenModule.md)[]
+
+The modules of the repo, as [modulesOf](modulesOf.md) gives them.
+
+### release
+
+readonly [`MavenModule`](../../interfaces/MavenModule.md)[]
+
+The modules the release deploys, as [selectArtifacts](selectArtifacts.md) gives them.
+
+### served
+
+`ReadonlySet`\<`string`\>
+
+The modules the remote serves at the version the stamp writes, by name: those of
+each other train that has released.
+
+## Returns
+
+[`MavenModule`](../../interfaces/MavenModule.md)[]
+
+The modules to install, in the order of the repo.

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

@@ -0,0 +1,28 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/artifacts](../README.md) / isPomFile
+
+# Function: isPomFile()
+
+> **isPomFile**(`file`): `boolean`
+
+Defined in: [packages/release-maven/src/artifacts.ts:41](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/artifacts.ts#L41)
+
+Whether `file` is the pom of a module: a `pom.xml` in no `src` or `target` folder, as the fixtures
+of the tests of a plugin and the output of a build are.
+
+## Parameters
+
+### file
+
+`string`
+
+A file of the repo, from its root.
+
+## Returns
+
+`boolean`
+
+Whether it is.

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

@@ -0,0 +1,27 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/artifacts](../README.md) / isRange
+
+# Function: isRange()
+
+> **isRange**(`version`): `boolean`
+
+Defined in: [packages/release-maven/src/artifacts.ts:94](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/artifacts.ts#L94)
+
+Whether a range or a version, as a pom writes it, is a range of Maven's: `[1.0,2.0)`.
+
+## Parameters
+
+### version
+
+`string`
+
+The text of a `<version>`.
+
+## Returns
+
+`boolean`
+
+Whether it is a range.

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

@@ -0,0 +1,44 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/artifacts](../README.md) / modulesOf
+
+# Function: modulesOf()
+
+> **modulesOf**(`poms`): [`MavenModule`](../../interfaces/MavenModule.md)[]
+
+Defined in: [packages/release-maven/src/artifacts.ts:129](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/artifacts.ts#L129)
+
+The modules of `poms`, each of the values it inherits of its parents in the repo: its groupId
+and version where it writes none, `maven.deploy.skip` (published unless it is `true`, its own
+over its parents'), its properties, and its repository of `distributionManagement`. Its
+dependencies are on the other modules alone:
+
+- its parent, `runtime`, of the version its `<parent>` writes;
+- each of `<dependencies>`, by its scope: `compile`, `runtime` and none `runtime`, `provided`
+  `peer`, `test` `dev` of no range, as no consumer resolves the test scope; `system` none. Of no
+  `<version>`, the version of its `<dependencyManagement>`, or of a parent's in the repo;
+- each of `<dependencyManagement>` of the scope `import`, `runtime`; no other, as a parent that
+  manages the versions of its children would depend on them;
+- each plugin of `<build><plugins>`, and each dependency of a plugin, `build`; of no `<version>`,
+  the version of a `<pluginManagement>`.
+
+## Parameters
+
+### poms
+
+readonly [`Pom`](../../pom/interfaces/Pom.md)[]
+
+The poms of the repo, as [readPoms](readPoms.md) reads them.
+
+## Returns
+
+[`MavenModule`](../../interfaces/MavenModule.md)[]
+
+The modules, in the order of `poms`.
+
+## Throws
+
+`EMAVENPOM` of a pom of no groupId, of its own or of its parent, of two poms of one name,
+and of poms that are each other's parents.

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

@@ -0,0 +1,33 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/artifacts](../README.md) / nameOf
+
+# Function: nameOf()
+
+> **nameOf**(`groupId`, `artifactId`): `string`
+
+Defined in: [packages/release-maven/src/artifacts.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/artifacts.ts#L76)
+
+The name of an artifact: `groupId:artifactId`.
+
+## Parameters
+
+### groupId
+
+`string`
+
+Its groupId.
+
+### artifactId
+
+`string`
+
+Its artifactId.
+
+## Returns
+
+`string`
+
+The name.

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

@@ -0,0 +1,34 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/artifacts](../README.md) / publishOrder
+
+# Function: publishOrder()
+
+> **publishOrder**(`modules`): [`MavenModule`](../../interfaces/MavenModule.md)[]
+
+Defined in: [packages/release-maven/src/artifacts.ts:403](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/artifacts.ts#L403)
+
+The modules in the order to deploy or install them in: each after the modules of the list that it
+depends on, by any kind, its parent and the test scope too, as Maven builds a module of what its
+tests need, and its reactor allows no cycle of any scope; those of no order between them by name.
+
+## Parameters
+
+### modules
+
+readonly [`MavenModule`](../../interfaces/MavenModule.md)[]
+
+The modules of a release, as [selectArtifacts](selectArtifacts.md) gives them, and those it
+installs ([installsOf](installsOf.md)).
+
+## Returns
+
+[`MavenModule`](../../interfaces/MavenModule.md)[]
+
+The same modules, in the order to deploy them in.
+
+## Throws
+
+`EMAVENORDER` of modules that depend on one another in a cycle.

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

@@ -0,0 +1,31 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/artifacts](../README.md) / readModules
+
+# Function: readModules()
+
+> **readModules**(`context`): `Promise`\<[`MavenModule`](../../interfaces/MavenModule.md)[]\>
+
+Defined in: [packages/release-maven/src/artifacts.ts:271](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/artifacts.ts#L271)
+
+The modules of the repo of `context`, at its `ref`: [modulesOf](modulesOf.md) of [readPoms](readPoms.md).
+
+## Parameters
+
+### context
+
+[`EcosystemContext`](../../../release-trains/ecosystem/interfaces/EcosystemContext.md)
+
+The folder of the repo, its environment, the system, and the commit.
+
+## Returns
+
+`Promise`\<[`MavenModule`](../../interfaces/MavenModule.md)[]\>
+
+The modules, in the order git lists their poms.
+
+## Throws
+
+`EGIT` of a commit git has not, `EMAVENPOM` of a pom that cannot be read.

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

@@ -0,0 +1,32 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-maven/artifacts](../README.md) / readPoms
+
+# Function: readPoms()
+
+> **readPoms**(`context`): `Promise`\<[`Pom`](../../pom/interfaces/Pom.md)[]\>
+
+Defined in: [packages/release-maven/src/artifacts.ts:52](https://gitlab.com/wetryfun/release/release/-/blob/a387d2dfc7054e3ce27012a942d72d35e4f4b45f/packages/release-maven/src/artifacts.ts#L52)
+
+Each pom.xml of the repo of `context` ([isPomFile](isPomFile.md)), read: of the files git tracks of the
+working tree, or of the commit `ref` of the context, by `git show`.
+
+## Parameters
+
+### context
+
+[`EcosystemContext`](../../../release-trains/ecosystem/interfaces/EcosystemContext.md)
+
+The folder of the repo, its environment, the system, and the commit.
+
+## Returns
+
+`Promise`\<[`Pom`](../../pom/interfaces/Pom.md)[]\>
+
+The poms, in the order git lists them.
+
+## Throws
+
+`EGIT` of a commit git has not, `EMAVENPOM` of a pom that cannot be read.