@wtf/release-docs 9.0.2 → 10.0.0

package/api/@wtf/semantic-release-npm/variables/default.md

@@ -8,7 +8,7 @@
 
 > **default**: `object`
 
-Defined in: [packages/semantic-release-npm/src/index.ts:449](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-npm/src/index.ts#L449)
+Defined in: [packages/semantic-release-npm/src/index.ts:578](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-npm/src/index.ts#L578)
 
 ## Type Declaration
 
@@ -17,9 +17,10 @@ Defined in: [packages/semantic-release-npm/src/index.ts:449](https://gitlab.com/
 > **addChannel**: (`pluginConfig`, `context`) => `Promise`\<`false` \| [`PublishedRelease`](../interfaces/PublishedRelease.md)\>
 
 Moves every package of the train at the version of the release to the dist-tag of its new
-channel, as semantic-release does to a release merged into the branch of another channel, and
-gives the release as `publish` does, of the packages it moved: none of none. A publisher that
-moves no dist-tag moves none, and says so.
+channel, by the step `move` of `@wtf/release-npm`, which gives each package it moved, as
+semantic-release does to a release merged into the branch of another channel, and gives the
+release as `publish` does, of the packages it moved: none of none. A publisher that moves no
+dist-tag moves none, and says so.
 
 #### Parameters
 
@@ -47,10 +48,10 @@ The release moved, of the publisher and its packages, or `false` of no package m
 > **fail**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
 
 Removes what `prepare` packed of the run, of its folder and its train, the copies and every
-tarball, of a `tarballDir` it is given too, of a run that fails after it, as semantic-release then
-calls no `publish`; what another run of the same process packed stays. semantic-release calls
-`fail` only of an error of its own mark, as a `TrainsError`: of any other, as a push git refuses,
-they stay.
+tarball, of a `tarballDir` it is given too, by `discardPacked` of `@wtf/release-npm/release`, of
+a run that fails after it, as semantic-release then calls no `publish`; what another run of the
+same process packed stays. semantic-release calls `fail` only of an error of its own mark, as a
+`TrainsError`: of any other, as a push git refuses, they stay.
 
 #### Parameters
 
@@ -75,9 +76,12 @@ the logger of the run, and its errors.
 
 > **prepare**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
 
-Resolves the manifest of each package of the train as it publishes, and packs each, before the
-tag: a range no release satisfies, a package that cannot be packed, or a release below the
-version its dist-tag points at on the registry (`EPUBLISHBEHIND`), fails the run here.
+Prepares the release of the train, before the tag, by the steps `prepare` and, of the option
+`smoke`, `smoke` of `@wtf/release-npm`, of the release `verifyRelease` verified: the manifest of
+each package resolved as it publishes and packed, and each tried as a consumer installs it. A
+range no release satisfies, a package that cannot be packed, one the smoke finds a fault of, or a
+release below the version its dist-tag points at on the registry (`EPUBLISHBEHIND`), fails the
+run here.
 
 #### Parameters
 
@@ -102,9 +106,11 @@ and the logger of the run, its options, its branch and the next release.
 
 > **publish**: (`pluginConfig`, `context`) => `Promise`\<`false` \| [`PublishedRelease`](../interfaces/PublishedRelease.md)\>
 
-Publishes every package of the train at the version of the release, under the dist-tag of its
-channel, each the registry has already skipped, and gives the release of the train: named of
-the publisher and every package, with the page of the first that has one.
+Publishes every package of the train at the version of the release, by the step `publish` of
+`@wtf/release-npm`, under the dist-tag of its channel, each the registry has already skipped;
+records each for the links of the release of the host (`recordReleased` of
+`@wtf/semantic-release/links`); and gives the release of the train: named of the publisher and
+every package, with the page of the first that has one.
 
 #### Parameters
 
@@ -134,7 +140,9 @@ package.
 
 Checks, before the release, the options of the plugin, by `publishSchema` of `./schema`
 (`EOPTIONS`, and the codes of the trains); that the publisher loads; and the packages of the
-train as they are in the repo. `EPUBLISHER` and `EPUBLISHCHECK`.
+train as they are in the repo, by `checkPlan` of `@wtf/release-npm/release`, the step `verify` of
+`@wtf/release-npm` but its version, which semantic-release has not yet. `EPUBLISHER` and
+`EPUBLISHCHECK`.
 
 #### Parameters
 
@@ -154,3 +162,31 @@ environment and the logger of the run.
 #### Returns
 
 `Promise`\<`void`\>
+
+### verifyRelease
+
+> **verifyRelease**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
+
+Verifies the release of the train, once semantic-release knows its version, by the step `verify`
+of `@wtf/release-npm`: the version, one of semver (`EPUBLISHVERSION`), the options, and the
+packages of the train as they are, of each range resolved to its version (`EPUBLISHCHECK`). What
+it says and throws names the train.
+
+#### Parameters
+
+##### pluginConfig
+
+[`PublishPluginOptions`](../interfaces/PublishPluginOptions.md)
+
+The plugin's options of the config, with `trains` of its root.
+
+##### context
+
+`VerifyReleaseContext` & `OfRun`
+
+The context of semantic-release's `verifyRelease` step: the folder, the
+environment and the logger of the run, its options, its branch and the next release.
+
+#### Returns
+
+`Promise`\<`void`\>

package/api/@wtf/semantic-release-npm/variables/fail.md

@@ -0,0 +1,36 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-npm](../README.md) / fail
+
+# Variable: fail
+
+> `const` **fail**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
+
+Defined in: [packages/semantic-release-npm/src/index.ts:565](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-npm/src/index.ts#L565)
+
+Removes what `prepare` packed of the run, of its folder and its train, the copies and every
+tarball, of a `tarballDir` it is given too, by `discardPacked` of `@wtf/release-npm/release`, of
+a run that fails after it, as semantic-release then calls no `publish`; what another run of the
+same process packed stays. semantic-release calls `fail` only of an error of its own mark, as a
+`TrainsError`: of any other, as a push git refuses, they stay.
+
+## Parameters
+
+### pluginConfig
+
+[`PublishPluginOptions`](../interfaces/PublishPluginOptions.md)
+
+The plugin's options of the config, with `trains` of its root.
+
+### context
+
+`FailContext` & `Pick`\<`VerifyConditionsContext`, `"env"`\> & `OfRun`
+
+The context of semantic-release's `fail` step: the folder, the environment and
+the logger of the run, and its errors.
+
+## Returns
+
+`Promise`\<`void`\>

package/api/@wtf/semantic-release-npm/variables/prepare.md

@@ -0,0 +1,37 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-npm](../README.md) / prepare
+
+# Variable: prepare
+
+> `const` **prepare**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
+
+Defined in: [packages/semantic-release-npm/src/index.ts:422](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-npm/src/index.ts#L422)
+
+Prepares the release of the train, before the tag, by the steps `prepare` and, of the option
+`smoke`, `smoke` of `@wtf/release-npm`, of the release `verifyRelease` verified: the manifest of
+each package resolved as it publishes and packed, and each tried as a consumer installs it. A
+range no release satisfies, a package that cannot be packed, one the smoke finds a fault of, or a
+release below the version its dist-tag points at on the registry (`EPUBLISHBEHIND`), fails the
+run here.
+
+## Parameters
+
+### pluginConfig
+
+[`PublishPluginOptions`](../interfaces/PublishPluginOptions.md)
+
+The plugin's options of the config, with `trains` of its root.
+
+### context
+
+`VerifyReleaseContext` & `OfRun`
+
+The context of semantic-release's `prepare` step: the folder, the environment
+and the logger of the run, its options, its branch and the next release.
+
+## Returns
+
+`Promise`\<`void`\>

package/api/@wtf/semantic-release-npm/{functions → variables}/publish.md

@@ -4,15 +4,17 @@
 
 [Release trains](../../../README.md) / [@wtf/semantic-release-npm](../README.md) / publish
 
-# Function: publish()
+# Variable: publish
 
-> **publish**(`pluginConfig`, `context`): `Promise`\<`false` \| [`PublishedRelease`](../interfaces/PublishedRelease.md)\>
+> `const` **publish**: (`pluginConfig`, `context`) => `Promise`\<`false` \| [`PublishedRelease`](../interfaces/PublishedRelease.md)\>
 
-Defined in: [packages/semantic-release-npm/src/index.ts:324](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-npm/src/index.ts#L324)
+Defined in: [packages/semantic-release-npm/src/index.ts:456](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-npm/src/index.ts#L456)
 
-Publishes every package of the train at the version of the release, under the dist-tag of its
-channel, each the registry has already skipped, and gives the release of the train: named of
-the publisher and every package, with the page of the first that has one.
+Publishes every package of the train at the version of the release, by the step `publish` of
+`@wtf/release-npm`, under the dist-tag of its channel, each the registry has already skipped;
+records each for the links of the release of the host (`recordReleased` of
+`@wtf/semantic-release/links`); and gives the release of the train: named of the publisher and
+every package, with the page of the first that has one.
 
 ## Parameters
 

package/api/@wtf/semantic-release-npm/{functions → variables}/verifyConditions.md

@@ -4,15 +4,17 @@
 
 [Release trains](../../../README.md) / [@wtf/semantic-release-npm](../README.md) / verifyConditions
 
-# Function: verifyConditions()
+# Variable: verifyConditions
 
-> **verifyConditions**(`pluginConfig`, `context`): `Promise`\<`void`\>
+> `const` **verifyConditions**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
 
-Defined in: [packages/semantic-release-npm/src/index.ts:248](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-npm/src/index.ts#L248)
+Defined in: [packages/semantic-release-npm/src/index.ts:363](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-npm/src/index.ts#L363)
 
 Checks, before the release, the options of the plugin, by `publishSchema` of `./schema`
 (`EOPTIONS`, and the codes of the trains); that the publisher loads; and the packages of the
-train as they are in the repo. `EPUBLISHER` and `EPUBLISHCHECK`.
+train as they are in the repo, by `checkPlan` of `@wtf/release-npm/release`, the step `verify` of
+`@wtf/release-npm` but its version, which semantic-release has not yet. `EPUBLISHER` and
+`EPUBLISHCHECK`.
 
 ## Parameters
 

package/api/@wtf/semantic-release-npm/variables/verifyRelease.md

@@ -0,0 +1,35 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-npm](../README.md) / verifyRelease
+
+# Variable: verifyRelease
+
+> `const` **verifyRelease**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
+
+Defined in: [packages/semantic-release-npm/src/index.ts:394](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-npm/src/index.ts#L394)
+
+Verifies the release of the train, once semantic-release knows its version, by the step `verify`
+of `@wtf/release-npm`: the version, one of semver (`EPUBLISHVERSION`), the options, and the
+packages of the train as they are, of each range resolved to its version (`EPUBLISHCHECK`). What
+it says and throws names the train.
+
+## Parameters
+
+### pluginConfig
+
+[`PublishPluginOptions`](../interfaces/PublishPluginOptions.md)
+
+The plugin's options of the config, with `trains` of its root.
+
+### context
+
+`VerifyReleaseContext` & `OfRun`
+
+The context of semantic-release's `verifyRelease` step: the folder, the
+environment and the logger of the run, its options, its branch and the next release.
+
+## Returns
+
+`Promise`\<`void`\>

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

@@ -0,0 +1,64 @@
+[**Release trains**](../../README.md)
+
+***
+
+[Release trains](../../README.md) / @wtf/semantic-release-oci
+
+# @wtf/semantic-release-oci
+
+The plugin of semantic-release that releases the OCI images of a train of a repo, by
+`@wtf/release-oci`, with no rebuild: the image a pipeline built and tested is copied, by its
+digest, to the tags of the release, so the bytes released are the bytes tested. It writes nothing
+into git: the tags of the registry are the versions. Put it in the plugins of the run of a tag,
+whose pipeline builds and tests each image first, as the devcontainer component does. It reads
+`trains` and `ecosystems` of its options, which semantic-release gives it of the root of the
+config, and the train of the run of its option `train`, or else `RELEASE_TRAIN` of the
+environment of the run, as `@wtf/semantic-release-npm` does; and the images as the trains read
+them, of the ecosystem of OCI images (`ociEcosystem` of `@wtf/release-oci/ecosystem`): the images
+of the release are the images of the train, whose `paths` hold their folder, as the plan of the
+train has them (`planOf` of `@wtf/release-trains/plan`). It runs the steps of the ecosystem, a
+`ReleasingEcosystem` of `@wtf/release/contract`, by `runStep` of `@wtf/release/driver`, of a
+release of the next version, and names the tags that move of a version itself, as
+semantic-release's versions are: of a release, its minor and its major.
+
+- `verifyConditions` checks the options, reads the images git tracks, and names the repository of
+  each image of the train, of the option `image` or `CI_REGISTRY_IMAGE` of the run
+  (`EOCIIMAGE`); it asks the registry nothing, so a dry run checks no image;
+- `verifyRelease` runs the step `verify` of the ecosystem, once the version is known: it checks the
+  version and its tags, and the repository of each image;
+- `publish` runs the steps `publish` and `move` of the ecosystem: it finds the tested image of
+  each, its source, `sourceRepository:sourceTag`, by its
+  digest, of the platforms of `platforms`; copies it by crane to the tag of the version, skipped of
+  a registry that has it at the same digest and refused at another (`EOCIRETAG`), and gives each
+  its page in the container registry of GitLab; then, of a release, points its minor and its
+  major, which move, at the version. It records each image for the links of the release of the
+  host (`recordReleased` of `@wtf/semantic-release/links`).
+
+The version reaches an image's build of no file: a pipeline that labels an image of the next
+version reads it of the dotenv `semantic-release-info` writes, as a build argument of its own.
+
+```js
+// release.config.mjs
+export default {
+  trains: { base: { paths: ['.'] } },
+  ecosystems: ['@wtf/release-oci'],
+  train: process.env.RELEASE_TRAIN,
+  tagFormat: `${process.env.RELEASE_TRAIN}-v\${version}`,
+  plugins: [
+    ['@wtf/semantic-release-trains', { wrap: '@semantic-release/commit-analyzer' }],
+    ['@wtf/semantic-release-oci', { platforms: ['linux/amd64'] }]
+  ]
+}
+```
+
+## Interfaces
+
+- [OciPluginOptions](interfaces/OciPluginOptions.md)
+- [OciRelease](interfaces/OciRelease.md)
+
+## Variables
+
+- [default](variables/default.md)
+- [publish](variables/publish.md)
+- [verifyConditions](variables/verifyConditions.md)
+- [verifyRelease](variables/verifyRelease.md)

package/api/@wtf/semantic-release-oci/interfaces/OciPluginOptions.md

@@ -0,0 +1,119 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-oci](../README.md) / OciPluginOptions
+
+# Interface: OciPluginOptions
+
+Defined in: [packages/semantic-release-oci/src/index.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L87)
+
+The options of the plugin, in the config of semantic-release or at its root.
+
+## Properties
+
+### crane?
+
+> `readonly` `optional` **crane?**: `string`
+
+Defined in: [packages/semantic-release-oci/src/index.ts:118](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L118)
+
+The command of crane, by its name on the path or its path: `crane` by default.
+
+***
+
+### dotenv?
+
+> `readonly` `optional` **dotenv?**: `string` \| `false`
+
+Defined in: [packages/semantic-release-oci/src/index.ts:125](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L125)
+
+The dotenv file `publish` writes of the images it published, from the root of the repo, for a
+job of the pipeline to read (`artifacts:reports:dotenv`): `oci_version`, `oci_images`, each
+`<repository>@<digest>`, and `oci_tags`, each space-separated; `oci.env` by default, none of
+`false`.
+
+***
+
+### ecosystems
+
+> `readonly` **ecosystems**: readonly `string`[]
+
+Defined in: [packages/semantic-release-oci/src/index.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L95)
+
+The ecosystems of the repo, of the root of the config, which the trains read the packages of:
+`'@wtf/semantic-release-oci/ecosystem'` or `'@wtf/release-oci'` among them, or
+`verifyConditions` fails (`EOCIECOSYSTEM`), as the trains would read no image this plugin tags.
+
+***
+
+### image?
+
+> `readonly` `optional` **image?**: `string`
+
+Defined in: [packages/semantic-release-oci/src/index.ts:102](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L102)
+
+The registry image of the project, the repository of the image of the root, and that and its
+folder of another: `CI_REGISTRY_IMAGE` of the run by default.
+
+***
+
+### moving?
+
+> `readonly` `optional` **moving?**: `boolean`
+
+Defined in: [packages/semantic-release-oci/src/index.ts:114](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L114)
+
+Whether a release moves its minor and its major, as `1.4` and `1`: `true` by default.
+
+***
+
+### platforms?
+
+> `readonly` `optional` **platforms?**: readonly `string`[]
+
+Defined in: [packages/semantic-release-oci/src/index.ts:116](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L116)
+
+The platforms each tested image must be of, as `linux/amd64`: any by default.
+
+***
+
+### sourceRepository?
+
+> `readonly` `optional` **sourceRepository?**: `string`
+
+Defined in: [packages/semantic-release-oci/src/index.ts:107](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L107)
+
+The repository of the tested image of each image, `{image}` its repository:
+`{image}/snapshot` by default, as the devcontainer component pushes a snapshot.
+
+***
+
+### sourceTag?
+
+> `readonly` `optional` **sourceTag?**: `string`
+
+Defined in: [packages/semantic-release-oci/src/index.ts:112](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L112)
+
+The tag of the tested image of each image: `CI_COMMIT_REF_SLUG` of the run by default, the
+snapshot of the pipeline of the tag.
+
+***
+
+### train?
+
+> `readonly` `optional` **train?**: `string`
+
+Defined in: [packages/semantic-release-oci/src/index.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L97)
+
+The train of the run: `RELEASE_TRAIN` of the environment of the run by default.
+
+***
+
+### trains
+
+> `readonly` **trains**: [`Trains`](../../release-trains/type-aliases/Trains.md)
+
+Defined in: [packages/semantic-release-oci/src/index.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L89)
+
+Every train of the repo: the images of each are those whose folder its paths hold.

package/api/@wtf/semantic-release-oci/interfaces/OciRelease.md

@@ -0,0 +1,31 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/semantic-release-oci](../README.md) / OciRelease
+
+# Interface: OciRelease
+
+Defined in: [packages/semantic-release-oci/src/index.ts:129](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L129)
+
+The release the plugin gives semantic-release of the images copied.
+
+## Properties
+
+### name
+
+> `readonly` **name**: `string`
+
+Defined in: [packages/semantic-release-oci/src/index.ts:131](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L131)
+
+The images named, as `OCI images (registry.example/a:1.4.2)`.
+
+***
+
+### url?
+
+> `readonly` `optional` **url?**: `string`
+
+Defined in: [packages/semantic-release-oci/src/index.ts:133](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/index.ts#L133)
+
+The page of the first image in the container registry of GitLab.

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

@@ -0,0 +1,38 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/semantic-release-oci/schema
+
+# @wtf/semantic-release-oci/schema
+
+The schema of the options of the plugin, as validators of `@wtf/release/validator`: each a
+Standard Schema, and a Standard JSON Schema of the JSON Schema of what it checks.
+
+- [ociSchema](variables/ociSchema.md): the options the plugin is given, of the root of the config, `trains`,
+  `ecosystems` and `train`, and of its entry, as it checks them;
+- [ociOptionsSchema](variables/ociOptionsSchema.md): the options of its entry, `image`, `sourceRepository`, `sourceTag`,
+  `moving`, `platforms`, `crane` and `dotenv`, its own;
+- [configSchema](variables/configSchema.md): this package's part of a whole config of semantic-release, each entry of
+  `plugins` of the plugin, and anything else; its JSON Schema is [jsonSchema](variables/jsonSchema.md), which the
+  package publishes as `schema.json`.
+
+```ts
+import { configSchema } from '@wtf/semantic-release-oci/schema'
+
+const result = await configSchema['~standard'].validate({
+  plugins: [['@wtf/semantic-release-oci', { platforms: ['linux/amd64'] }]]
+})
+export const messages = result.issues?.map(({ message }) => message) ?? []
+```
+
+## Type Aliases
+
+- [OciOptions](type-aliases/OciOptions.md)
+
+## Variables
+
+- [configSchema](variables/configSchema.md)
+- [jsonSchema](variables/jsonSchema.md)
+- [ociOptionsSchema](variables/ociOptionsSchema.md)
+- [ociSchema](variables/ociSchema.md)

package/api/@wtf/semantic-release-oci/schema/type-aliases/OciOptions.md

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/semantic-release-oci/schema](../README.md) / OciOptions
+
+# Type Alias: OciOptions
+
+> **OciOptions** = `Omit`\<[`OciPluginOptions`](../../interfaces/OciPluginOptions.md), `"train"` \| `"trains"` \| `"ecosystems"`\>
+
+Defined in: [packages/semantic-release-oci/src/schema.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/schema.ts#L42)
+
+The options of an entry of the plugin, its own: every one of the options but those of the root.

package/api/@wtf/semantic-release-oci/schema/variables/configSchema.md

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/semantic-release-oci/schema](../README.md) / configSchema
+
+# Variable: configSchema
+
+> `const` **configSchema**: [`Validator`](../../../release/validator/interfaces/Validator.md)\<`object`\>
+
+Defined in: [packages/semantic-release-oci/src/schema.ts:71](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/schema.ts#L71)
+
+This package's part of a whole config of semantic-release: each entry of `plugins` of the plugin.

package/api/@wtf/semantic-release-oci/schema/variables/jsonSchema.md

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/semantic-release-oci/schema](../README.md) / jsonSchema
+
+# Variable: jsonSchema
+
+> `const` **jsonSchema**: [`JsonSchema`](../../../release/validator/type-aliases/JsonSchema.md)
+
+Defined in: [packages/semantic-release-oci/src/schema.ts:77](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/schema.ts#L77)
+
+The JSON Schema of [configSchema](configSchema.md), as the package publishes it, `schema.json`.

package/api/@wtf/semantic-release-oci/schema/variables/ociOptionsSchema.md

@@ -0,0 +1,13 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/semantic-release-oci/schema](../README.md) / ociOptionsSchema
+
+# Variable: ociOptionsSchema
+
+> `const` **ociOptionsSchema**: [`Validator`](../../../release/validator/interfaces/Validator.md)\<[`OciOptions`](../type-aliases/OciOptions.md)\>
+
+Defined in: [packages/semantic-release-oci/src/schema.ts:45](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/schema.ts#L45)
+
+The validator of the options of an entry of the plugin, its own.

package/api/@wtf/semantic-release-oci/schema/variables/ociSchema.md

@@ -0,0 +1,14 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/semantic-release-oci/schema](../README.md) / ociSchema
+
+# Variable: ociSchema
+
+> `const` **ociSchema**: [`Validator`](../../../release/validator/interfaces/Validator.md)\<[`RootOptions`](../../../release-trains/schema/interfaces/RootOptions.md) & [`OciOptions`](../type-aliases/OciOptions.md)\>
+
+Defined in: [packages/semantic-release-oci/src/schema.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-oci/src/schema.ts#L65)
+
+The validator of the options the plugin is given: the root's, `trains` and `ecosystems` required,
+and its own.