@wtf/release-docs 9.0.2 → 9.1.0

package/api/@wtf/release-npm/release/type-aliases/ReleaseRun.md

@@ -8,6 +8,6 @@
 
 > **ReleaseRun** = [`ResolveRelease`](../interfaces/ResolveRelease.md) & [`PackOptions`](../interfaces/PackOptions.md) & [`PublishRun`](../interfaces/PublishRun.md)
 
-Defined in: [packages/release-npm/src/release.ts:811](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/release.ts#L811)
+Defined in: [packages/release-npm/src/release.ts:811](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/release.ts#L811)
 
 A release of a train [releaseTrain](../functions/releaseTrain.md) publishes: what each of its three steps takes.

package/api/@wtf/release-npm/release/variables/ID_TOKENS.md

@@ -8,7 +8,7 @@
 
 > `const` **ID\_TOKENS**: readonly `string`[]
 
-Defined in: [packages/release-npm/src/release.ts:117](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/release.ts#L117)
+Defined in: [packages/release-npm/src/release.ts:117](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/release.ts#L117)
 
 The variables of the environment of an ID token the CI gives, of which npm signs provenance:
 Sigstore's on GitLab, GitHub's OIDC on GitHub Actions. Not `NPM_ID_TOKEN`, of npm's trusted

package/api/@wtf/release-npm/release/variables/RUNNER_ENVIRONMENTS.md

@@ -8,7 +8,7 @@
 
 > `const` **RUNNER\_ENVIRONMENTS**: readonly `string`[]
 
-Defined in: [packages/release-npm/src/release.ts:124](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/release.ts#L124)
+Defined in: [packages/release-npm/src/release.ts:124](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/release.ts#L124)
 
 The variables of the environment that name the runner of a job, `self-hosted` of one the CI does
 not host: GitLab's, then GitHub's. npm takes provenance of the runners of GitLab.com and GitHub

package/api/@wtf/release-npm/workspace/functions/pnpmWorkspaceGlobs.md

@@ -8,7 +8,7 @@
 
 > **pnpmWorkspaceGlobs**(`yaml`): `string`[]
 
-Defined in: [packages/release-npm/src/workspace.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/workspace.ts#L48)
+Defined in: [packages/release-npm/src/workspace.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/workspace.ts#L48)
 
 The `packages` globs of the text of a pnpm-workspace.yaml, as a list or inline.
 

package/api/@wtf/release-npm/workspace/functions/publishableOf.md

@@ -8,7 +8,7 @@
 
 > **publishableOf**(`packages`): [`Manifest`](../../manifests/interfaces/Manifest.md)[]
 
-Defined in: [packages/release-npm/src/workspace.ts:190](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/workspace.ts#L190)
+Defined in: [packages/release-npm/src/workspace.ts:190](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/workspace.ts#L190)
 
 The packages that publish: every one that is not private.
 

package/api/@wtf/release-npm/workspace/functions/readWorkspace.md

@@ -8,7 +8,7 @@
 
 > **readWorkspace**(`root`, `options`): `Promise`\<[`Manifest`](../../manifests/interfaces/Manifest.md)[]\>
 
-Defined in: [packages/release-npm/src/workspace.ts:163](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/workspace.ts#L163)
+Defined in: [packages/release-npm/src/workspace.ts:163](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/workspace.ts#L163)
 
 Each package of the workspace at `root`, read, by the folders of [workspaceFolders](workspaceFolders.md).
 

package/api/@wtf/release-npm/workspace/functions/workspaceFolders.md

@@ -8,7 +8,7 @@
 
 > **workspaceFolders**(`root`, `options`): `Promise`\<`string`[]\>
 
-Defined in: [packages/release-npm/src/workspace.ts:123](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/workspace.ts#L123)
+Defined in: [packages/release-npm/src/workspace.ts:123](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/workspace.ts#L123)
 
 The folder of each package of the workspace at `root`, relative to it, with `/`, in order: each
 its globs name and none of its `!` globs, that holds a package.json. With no workspace, each

package/api/@wtf/release-npm/workspace/functions/workspaceGlobs.md

@@ -8,7 +8,7 @@
 
 > **workspaceGlobs**(`root`, `options`): `Promise`\<[`WorkspaceGlobs`](../interfaces/WorkspaceGlobs.md) \| `undefined`\>
 
-Defined in: [packages/release-npm/src/workspace.ts:77](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/workspace.ts#L77)
+Defined in: [packages/release-npm/src/workspace.ts:77](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/workspace.ts#L77)
 
 The globs of the workspace at `root`: of its pnpm-workspace.yaml, else of the `workspaces` of its
 package.json, a list or `{ packages }`; `undefined` of a repo that declares no workspace.

package/api/@wtf/release-npm/workspace/interfaces/WorkspaceGlobs.md

@@ -6,7 +6,7 @@
 
 # Interface: WorkspaceGlobs
 
-Defined in: [packages/release-npm/src/workspace.ts:35](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/workspace.ts#L35)
+Defined in: [packages/release-npm/src/workspace.ts:35](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/workspace.ts#L35)
 
 The globs of a workspace: those that name its packages, and those that leave some out.
 
@@ -16,7 +16,7 @@ The globs of a workspace: those that name its packages, and those that leave som
 
 > `readonly` **exclude**: readonly `string`[]
 
-Defined in: [packages/release-npm/src/workspace.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/workspace.ts#L37)
+Defined in: [packages/release-npm/src/workspace.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/workspace.ts#L37)
 
 ***
 
@@ -24,4 +24,4 @@ Defined in: [packages/release-npm/src/workspace.ts:37](https://gitlab.com/wetryf
 
 > `readonly` **include**: readonly `string`[]
 
-Defined in: [packages/release-npm/src/workspace.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/workspace.ts#L36)
+Defined in: [packages/release-npm/src/workspace.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/workspace.ts#L36)

package/api/@wtf/release-npm/workspace/interfaces/WorkspaceOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: WorkspaceOptions
 
-Defined in: [packages/release-npm/src/workspace.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/workspace.ts#L30)
+Defined in: [packages/release-npm/src/workspace.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/workspace.ts#L30)
 
 How a workspace is read: by the system it is given, which it requires.
 
@@ -16,4 +16,4 @@ How a workspace is read: by the system it is given, which it requires.
 
 > `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
 
-Defined in: [packages/release-npm/src/workspace.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/workspace.ts#L31)
+Defined in: [packages/release-npm/src/workspace.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-npm/src/workspace.ts#L31)

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

@@ -0,0 +1,36 @@
+[**Release trains**](../../README.md)
+
+***
+
+[Release trains](../../README.md) / @wtf/release-oci
+
+# @wtf/release-oci
+
+The OCI images of a repo released in trains, of no release tool and no rebuild. Its default export
+is the ecosystem of OCI images, `ociEcosystem` of `./ecosystem`, which a config of the trains
+names in `ecosystems` as `'@wtf/release-oci'`, so the trains read the images of the repo by it;
+and this module holds the type of an image, which the modules of this package do with: the
+images of the repo, each folder of a Dockerfile, a Containerfile or a
+`.devcontainer/devcontainer.json` (`./images`), the tags of a release (`./tags`), the tested image
+of each copied to them by crane (`./publish`), and the page of each in the container registry of
+GitLab (`./registry`). An image is built and tested by its own pipeline; a release copies the
+image it tested, by its digest, to the tags of its version, so the bytes released are the bytes
+tested. Each function takes the `System` it runs by, and runs `git` and `crane` through it.
+
+```ts
+import type { OciImage } from '@wtf/release-oci'
+
+// The repositories of the images, as a release lists them.
+export const repositoriesOf = (images: readonly OciImage[]): (string | undefined)[] =>
+  images.map(({ repository }) => repository)
+```
+
+## Interfaces
+
+- [OciImage](interfaces/OciImage.md)
+
+## References
+
+### default
+
+Renames and re-exports [ociEcosystem](ecosystem/variables/ociEcosystem.md)

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

@@ -0,0 +1,41 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/release-oci/ecosystem
+
+# @wtf/release-oci/ecosystem
+
+The ecosystem of OCI images ([ociEcosystem](variables/ociEcosystem.md)), as the trains read it, and the default export
+of the package, which a config names in `ecosystems` as `'@wtf/release-oci'`: the images of the
+repo, each folder of a file an image is built of that git tracks ([packagesOfRepo](functions/packagesOfRepo.md)), of the
+working tree or of a commit; a repo of none has none. An image names no other image of the repo
+as a dependency the trains could read: a `FROM` or a base pins a tag of a registry, not a package
+of the repo. A range of an image is a tag: a release publishes the version itself
+([resolveTag](functions/resolveTag.md)), which takes that version alone ([satisfiesTag](functions/satisfiesTag.md)).
+
+```js
+// release.config.mjs
+export default {
+  trains: {
+    base: { paths: ['images/base'] },
+    release: { paths: ['images/release'] }
+  },
+  ecosystems: ['@wtf/release-oci']
+}
+```
+
+## Interfaces
+
+- [OciPackage](interfaces/OciPackage.md)
+
+## Variables
+
+- [ociEcosystem](variables/ociEcosystem.md)
+
+## Functions
+
+- [packagesOfImages](functions/packagesOfImages.md)
+- [packagesOfRepo](functions/packagesOfRepo.md)
+- [resolveTag](functions/resolveTag.md)
+- [satisfiesTag](functions/satisfiesTag.md)

package/api/@wtf/release-oci/ecosystem/functions/packagesOfImages.md

@@ -0,0 +1,29 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-oci/ecosystem](../README.md) / packagesOfImages
+
+# Function: packagesOfImages()
+
+> **packagesOfImages**(`images`): [`OciPackage`](../interfaces/OciPackage.md)[]
+
+Defined in: [packages/release-oci/src/ecosystem.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-oci/src/ecosystem.ts#L43)
+
+The images of the repo as the trains read them: each a package named by its repository, or by its
+folder where the environment names no registry image; of its folder and the file it is built of;
+published, as every image a pipeline builds is; and of no dependency.
+
+## Parameters
+
+### images
+
+readonly [`OciImage`](../../interfaces/OciImage.md)[]
+
+The images of the repo, as `readImages` of `./images` gives them.
+
+## Returns
+
+[`OciPackage`](../interfaces/OciPackage.md)[]
+
+The packages, one of each image, in the order of `images`.

package/api/@wtf/release-oci/ecosystem/functions/packagesOfRepo.md

@@ -0,0 +1,32 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-oci/ecosystem](../README.md) / packagesOfRepo
+
+# Function: packagesOfRepo()
+
+> **packagesOfRepo**(`context`): `Promise`\<[`OciPackage`](../interfaces/OciPackage.md)[]\>
+
+Defined in: [packages/release-oci/src/ecosystem.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-oci/src/ecosystem.ts#L84)
+
+The images of the repo of `context` as the trains read them, of the commit `ref` where it names
+one, else of the working tree.
+
+## Parameters
+
+### context
+
+[`EcosystemContext`](../../../release-trains/ecosystem/interfaces/EcosystemContext.md)
+
+The folder of the repo, its environment, the system, and the commit.
+
+## Returns
+
+`Promise`\<[`OciPackage`](../interfaces/OciPackage.md)[]\>
+
+The packages, one of each image.
+
+## Throws
+
+`EGIT` of a commit git has not.

package/api/@wtf/release-oci/ecosystem/functions/resolveTag.md

@@ -0,0 +1,35 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-oci/ecosystem](../README.md) / resolveTag
+
+# Function: resolveTag()
+
+> **resolveTag**(`_range`, `version`): `string`
+
+Defined in: [packages/release-oci/src/ecosystem.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-oci/src/ecosystem.ts#L63)
+
+The tag a release publishes of an image of `version`, the release of its train: the version
+itself, as `1.4.0`. No image of the repo names another as a dependency, so a range is never read
+of a manifest.
+
+## Parameters
+
+### \_range
+
+`string`
+
+The tag before the release, as a manifest would write it.
+
+### version
+
+`string`
+
+The release of the image, as `1.4.0`.
+
+## Returns
+
+`string`
+
+The tag, as `1.4.0`.

package/api/@wtf/release-oci/ecosystem/functions/satisfiesTag.md

@@ -0,0 +1,34 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-oci/ecosystem](../README.md) / satisfiesTag
+
+# Function: satisfiesTag()
+
+> **satisfiesTag**(`tag`, `version`): `boolean`
+
+Defined in: [packages/release-oci/src/ecosystem.ts:73](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-oci/src/ecosystem.ts#L73)
+
+Whether `version` is the one `tag` names: a tag of an image names one version, and a moving tag,
+as `1`, is no range the trains read.
+
+## Parameters
+
+### tag
+
+`string`
+
+A tag, as `1.4.0`.
+
+### version
+
+`string`
+
+A version, as `1.4.0`.
+
+## Returns
+
+`boolean`
+
+Whether they are the same version.

package/api/@wtf/release-oci/ecosystem/interfaces/OciPackage.md

@@ -0,0 +1,97 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-oci/ecosystem](../README.md) / OciPackage
+
+# Interface: OciPackage
+
+Defined in: [packages/release-oci/src/ecosystem.ts:30](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-oci/src/ecosystem.ts#L30)
+
+An image as the trains read it: a package of the trains, and the image it is of.
+
+## Extends
+
+- [`Package`](../../../release-trains/ecosystem/interfaces/Package.md)
+
+## Properties
+
+### dependencies
+
+> `readonly` **dependencies**: readonly [`Dependency`](../../../release-trains/ecosystem/interfaces/Dependency.md)[]
+
+Defined in: [packages/release-trains/src/ecosystem.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L76)
+
+Its dependencies on the other packages of its ecosystem in the repo.
+
+#### Inherited from
+
+[`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`dependencies`](../../../release-trains/ecosystem/interfaces/Package.md#dependencies)
+
+***
+
+### dir
+
+> `readonly` **dir**: `string`
+
+Defined in: [packages/release-trains/src/ecosystem.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L67)
+
+Its folder, from the root of the repo, as `packages/core`; `.` of the root. A train holds it
+when the train's `paths` hold this folder.
+
+#### Inherited from
+
+[`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`dir`](../../../release-trains/ecosystem/interfaces/Package.md#dir)
+
+***
+
+### image
+
+> `readonly` **image**: [`OciImage`](../../interfaces/OciImage.md)
+
+Defined in: [packages/release-oci/src/ecosystem.ts:32](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-oci/src/ecosystem.ts#L32)
+
+The image, as `readImages` of `./images` gives it.
+
+***
+
+### manifest
+
+> `readonly` **manifest**: `string`
+
+Defined in: [packages/release-trains/src/ecosystem.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L69)
+
+Its manifest, from the root of the repo, as `packages/core/package.json`.
+
+#### Inherited from
+
+[`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`manifest`](../../../release-trains/ecosystem/interfaces/Package.md#manifest)
+
+***
+
+### name
+
+> `readonly` **name**: `string`
+
+Defined in: [packages/release-trains/src/ecosystem.ts:62](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L62)
+
+Its name, the one its ecosystem's registry knows it by: unique of the ecosystem in the repo.
+
+#### Inherited from
+
+[`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`name`](../../../release-trains/ecosystem/interfaces/Package.md#name)
+
+***
+
+### published
+
+> `readonly` **published**: `boolean`
+
+Defined in: [packages/release-trains/src/ecosystem.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-trains/src/ecosystem.ts#L74)
+
+Whether a release publishes it: not of an npm package that is private, nor of a crate of
+`publish = false`.
+
+#### Inherited from
+
+[`Package`](../../../release-trains/ecosystem/interfaces/Package.md).[`published`](../../../release-trains/ecosystem/interfaces/Package.md#published)

package/api/@wtf/release-oci/ecosystem/variables/ociEcosystem.md

@@ -0,0 +1,15 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-oci/ecosystem](../README.md) / ociEcosystem
+
+# Variable: ociEcosystem
+
+> `const` **ociEcosystem**: [`Ecosystem`](../../../release-trains/ecosystem/interfaces/Ecosystem.md)
+
+Defined in: [packages/release-oci/src/ecosystem.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/838e75e66ef604439e05c0180870e65b00370ea2/packages/release-oci/src/ecosystem.ts#L95)
+
+The ecosystem of OCI images: its packages, the images of the repo, of the working tree or of a
+commit ([packagesOfRepo](../functions/packagesOfRepo.md)); a tag published as the version ([resolveTag](../functions/resolveTag.md)); and a tag
+of one version ([satisfiesTag](../functions/satisfiesTag.md)).

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

@@ -0,0 +1,25 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/release-oci/errors
+
+# @wtf/release-oci/errors
+
+What the release of OCI images throws: [OciError](classes/OciError.md), a `ReleaseError` of
+`@wtf/release-system/errors` of the codes of [OCI\_ERRORS](variables/OCI_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 package of two trains, is the trains' own, `TRAINS_ERRORS` of
+`@wtf/release-trains/errors`.
+
+## Classes
+
+- [OciError](classes/OciError.md)
+
+## Type Aliases
+
+- [OciErrorCode](type-aliases/OciErrorCode.md)
+
+## Variables
+
+- [OCI\_ERRORS](variables/OCI_ERRORS.md)