@wtf/release-docs 8.2.3 → 9.0.1

package/api/@wtf/release-trains/gitlab/interfaces/GenericUpload.md

@@ -0,0 +1,81 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-trains/gitlab](../README.md) / GenericUpload
+
+# Interface: GenericUpload
+
+Defined in: [packages/release-trains/src/gitlab.ts:308](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L308)
+
+What [uploadGeneric](../functions/uploadGeneric.md) uploads.
+
+## Properties
+
+### body
+
+> `readonly` **body**: `Uint8Array`
+
+Defined in: [packages/release-trains/src/gitlab.ts:320](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L320)
+
+The content of the file.
+
+***
+
+### fetch
+
+> `readonly` **fetch**: [`HttpFetch`](../type-aliases/HttpFetch.md)
+
+Defined in: [packages/release-trains/src/gitlab.ts:310](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L310)
+
+The `fetch` the request is made by.
+
+***
+
+### fileName
+
+> `readonly` **fileName**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:318](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L318)
+
+The name of the file in the package, as `acme-demo-1.2.0.tgz`.
+
+***
+
+### headers
+
+> `readonly` **headers**: `Readonly`\<`Record`\<`string`, `string`\>\>
+
+Defined in: [packages/release-trains/src/gitlab.ts:322](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L322)
+
+The headers the request authenticates by.
+
+***
+
+### packageName
+
+> `readonly` **packageName**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:314](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L314)
+
+The name of the generic package, as the train's.
+
+***
+
+### project
+
+> `readonly` **project**: [`GitLabProject`](GitLabProject.md)
+
+Defined in: [packages/release-trains/src/gitlab.ts:312](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L312)
+
+The project whose generic package registry the file goes to.
+
+***
+
+### version
+
+> `readonly` **version**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:316](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L316)
+
+Its version, as the release's.

package/api/@wtf/release-trains/gitlab/interfaces/GitLabOptions.md

@@ -0,0 +1,42 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-trains/gitlab](../README.md) / GitLabOptions
+
+# Interface: GitLabOptions
+
+Defined in: [packages/release-trains/src/gitlab.ts:70](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L70)
+
+The options of `@semantic-release/gitlab` that say where GitLab is and how a run authenticates,
+which a project and its headers are read of, as that plugin reads them.
+
+## Properties
+
+### gitlabApiPathPrefix?
+
+> `readonly` `optional` **gitlabApiPathPrefix?**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:74](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L74)
+
+The path of its API from that URL: `GL_PREFIX` or `GITLAB_PREFIX`, else `/api/v4`.
+
+***
+
+### gitlabUrl?
+
+> `readonly` `optional` **gitlabUrl?**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:72](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L72)
+
+The URL of GitLab: `GL_URL` or `GITLAB_URL` of the environment by default.
+
+***
+
+### useJobToken?
+
+> `readonly` `optional` **useJobToken?**: `boolean`
+
+Defined in: [packages/release-trains/src/gitlab.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L76)
+
+Whether the run authenticates by the job token, `CI_JOB_TOKEN`, alone.

package/api/@wtf/release-trains/gitlab/interfaces/GitLabProject.md

@@ -0,0 +1,61 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-trains/gitlab](../README.md) / GitLabProject
+
+# Interface: GitLabProject
+
+Defined in: [packages/release-trains/src/gitlab.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L80)
+
+The project of a run on GitLab.
+
+## Properties
+
+### api
+
+> `readonly` **api**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:84](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L84)
+
+The URL of its API, as `https://gitlab.com/api/v4`.
+
+***
+
+### gitlabUrl
+
+> `readonly` **gitlabUrl**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:82](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L82)
+
+The URL of GitLab, as `https://gitlab.com`.
+
+***
+
+### id
+
+> `readonly` **id**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L88)
+
+The project as the API names it: its ID, or its path encoded, as `acme%2Frepo`.
+
+***
+
+### path
+
+> `readonly` **path**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:86](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L86)
+
+The path of the project, as `acme/repo`.
+
+***
+
+### url
+
+> `readonly` **url**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:90](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L90)
+
+The page of the project, as `https://gitlab.com/acme/repo`.

package/api/@wtf/release-trains/gitlab/interfaces/GitLabRegistry.md

@@ -0,0 +1,51 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-trains/gitlab](../README.md) / GitLabRegistry
+
+# Interface: GitLabRegistry
+
+Defined in: [packages/release-trains/src/gitlab.ts:173](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L173)
+
+A package registry of GitLab, of a project or of a group, as its URL names it.
+
+## Properties
+
+### api
+
+> `readonly` **api**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:177](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L177)
+
+The URL of its API, as `https://gitlab.com/api/v4`.
+
+***
+
+### gitlabUrl
+
+> `readonly` **gitlabUrl**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:175](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L175)
+
+The URL of GitLab, as `https://gitlab.com`.
+
+***
+
+### id
+
+> `readonly` **id**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:181](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L181)
+
+The project or the group, as the API names it: its ID, or its path encoded.
+
+***
+
+### scope
+
+> `readonly` **scope**: `"projects"` \| `"groups"`
+
+Defined in: [packages/release-trains/src/gitlab.ts:179](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L179)
+
+Whether the registry is a project's or a group's.

package/api/@wtf/release-trains/gitlab/interfaces/HttpResponse.md

@@ -0,0 +1,47 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-trains/gitlab](../README.md) / HttpResponse
+
+# Interface: HttpResponse
+
+Defined in: [packages/release-trains/src/gitlab.ts:37](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L37)
+
+What a server answered, of the part of a `Response` this module reads.
+
+## Properties
+
+### ok
+
+> `readonly` **ok**: `boolean`
+
+Defined in: [packages/release-trains/src/gitlab.ts:39](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L39)
+
+Whether the status is of 2xx.
+
+***
+
+### status
+
+> `readonly` **status**: `number`
+
+Defined in: [packages/release-trains/src/gitlab.ts:41](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L41)
+
+The status.
+
+## Methods
+
+### text()
+
+> **text**(): `Promise`\<`string`\>
+
+Defined in: [packages/release-trains/src/gitlab.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L47)
+
+The body, as text.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The body.

package/api/@wtf/release-trains/gitlab/interfaces/PackageQuery.md

@@ -0,0 +1,72 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-trains/gitlab](../README.md) / PackageQuery
+
+# Interface: PackageQuery
+
+Defined in: [packages/release-trains/src/gitlab.ts:209](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L209)
+
+What [findPackage](../functions/findPackage.md) looks up.
+
+## Properties
+
+### fetch
+
+> `readonly` **fetch**: [`HttpFetch`](../type-aliases/HttpFetch.md)
+
+Defined in: [packages/release-trains/src/gitlab.ts:211](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L211)
+
+The `fetch` the request is made by.
+
+***
+
+### headers
+
+> `readonly` **headers**: `Readonly`\<`Record`\<`string`, `string`\>\>
+
+Defined in: [packages/release-trains/src/gitlab.ts:224](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L224)
+
+The headers the request authenticates by: none of a registry that serves anyone.
+
+***
+
+### name
+
+> `readonly` **name**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:220](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L220)
+
+The name of the package, as the registry knows it: as `@acme/core` of npm, and of Maven its
+groupId of a folder for each part, then its artifactId, as `org/acme/core`.
+
+***
+
+### registry
+
+> `readonly` **registry**: [`GitLabRegistry`](GitLabRegistry.md)
+
+Defined in: [packages/release-trains/src/gitlab.ts:213](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L213)
+
+The registry the package was published to.
+
+***
+
+### type
+
+> `readonly` **type**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:215](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L215)
+
+The type of the package, as the registry knows it: `npm`, `maven`, `generic`.
+
+***
+
+### version
+
+> `readonly` **version**: `string`
+
+Defined in: [packages/release-trains/src/gitlab.ts:222](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L222)
+
+The version of the package.

package/api/@wtf/release-trains/gitlab/type-aliases/HttpFetch.md

@@ -0,0 +1,43 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-trains/gitlab](../README.md) / HttpFetch
+
+# Type Alias: HttpFetch
+
+> **HttpFetch** = (`url`, `init`) => `Promise`\<[`HttpResponse`](../interfaces/HttpResponse.md)\>
+
+Defined in: [packages/release-trains/src/gitlab.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/gitlab.ts#L57)
+
+The `fetch` a caller gives, of the part of it this module uses.
+
+## Parameters
+
+### url
+
+`string`
+
+The URL of the request.
+
+### init
+
+Its method, its headers and its body.
+
+#### body?
+
+`string` \| `Uint8Array`
+
+#### headers
+
+`Record`\<`string`, `string`\>
+
+#### method
+
+`string`
+
+## Returns
+
+`Promise`\<[`HttpResponse`](../interfaces/HttpResponse.md)\>
+
+What the server answered.

package/api/@wtf/release-trains/interfaces/Train.md

@@ -6,7 +6,7 @@
 
 # Interface: Train
 
-Defined in: [packages/release-trains/src/index.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-trains/src/index.ts#L57)
+Defined in: [packages/release-trains/src/index.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/index.ts#L61)
 
 A release train: the folders it releases, the shared files that count for it too, the format of
 its tags, its changelog, and the folders its build generates. A path or a glob of `paths` belongs
@@ -18,7 +18,7 @@ to this train alone.
 
 > `readonly` `optional` **changelog?**: `string` \| `false`
 
-Defined in: [packages/release-trains/src/index.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-trains/src/index.ts#L76)
+Defined in: [packages/release-trains/src/index.ts:80](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/index.ts#L80)
 
 The changelog of the train, from the root of the repo: `<first path>/CHANGELOG.md` by
 default, or `false` for none.
@@ -29,7 +29,7 @@ default, or `false` for none.
 
 > `readonly` `optional` **dependsOn?**: readonly `string`[]
 
-Defined in: [packages/release-trains/src/index.ts:88](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-trains/src/index.ts#L88)
+Defined in: [packages/release-trains/src/index.ts:92](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/index.ts#L92)
 
 The trains this train releases after, by their names, besides those a package of its lists a
 package of: as a docs train, which documents the packages of other trains and lists none of
@@ -42,7 +42,7 @@ required of it.
 
 > `readonly` `optional` **generated?**: readonly `string`[]
 
-Defined in: [packages/release-trains/src/index.ts:81](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-trains/src/index.ts#L81)
+Defined in: [packages/release-trains/src/index.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/index.ts#L85)
 
 Files or folders the release writes, as an API reference a build generates: the release
 commit commits them, what was deleted too.
@@ -53,7 +53,7 @@ commit commits them, what was deleted too.
 
 > `readonly` **paths**: readonly `string`[]
 
-Defined in: [packages/release-trains/src/index.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-trains/src/index.ts#L63)
+Defined in: [packages/release-trains/src/index.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/index.ts#L67)
 
 The folders of the train, from the root of the repo, or globs of them, as
 `packages/release-trains` or `packages/release-trains-*`. A file is the train's when it is
@@ -65,7 +65,7 @@ under one of them. No file is of two trains.
 
 > `readonly` `optional` **shared?**: readonly `string`[]
 
-Defined in: [packages/release-trains/src/index.ts:69](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-trains/src/index.ts#L69)
+Defined in: [packages/release-trains/src/index.ts:73](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/index.ts#L73)
 
 Files or folders outside the train that count for it too, as the lockfile or a config the
 train builds with. A file of the root counts for no train unless a train lists it here; more
@@ -77,6 +77,6 @@ than one train may list it.
 
 > `readonly` `optional` **tagFormat?**: `string`
 
-Defined in: [packages/release-trains/src/index.ts:71](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/release-trains/src/index.ts#L71)
+Defined in: [packages/release-trains/src/index.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/index.ts#L75)
 
 The format of the train's tags, with `${version}` once: `<train>-v${version}` by default.

package/api/@wtf/release-trains/links/README.md

@@ -0,0 +1,54 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/release-trains/links
+
+# @wtf/release-trains/links
+
+The packages a release published, and the link of each on the GitLab release of its tag. Each
+plugin that publishes the packages of an ecosystem says what it published and where, by
+[recordReleased](functions/recordReleased.md), in the run of the release; the plugin that makes the release of the host
+reads them back of the same run, by [releasedOf](functions/releasedOf.md), and links each by
+[releaseLinks](functions/releaseLinks.md), by the first of these that it has:
+
+1. its page at the version on a public registry, as npm's, crates.io's, Maven Central's, or
+   pkg.go.dev of a Go module the proxy fetched;
+2. its page on GitLab, of a package published to a package registry of GitLab, of a project or
+   of a group, as the Packages API lists it;
+3. its file, uploaded to the generic package registry of the project, as a package of the train
+   at the version of the release, as of a package packed and never published;
+4. its folder at its tag, of a Go module the proxy was not asked of.
+
+Each link is of the type `package`, named by the package: of two packages of one name, of two
+ecosystems, by the name and the ecosystem.
+
+```ts
+import { recordReleased, releasedOf } from '@wtf/release-trains/links'
+
+const run = { cwd: '/repo', train: 'core', version: '1.2.0' }
+recordReleased(run, 'npm', [
+  {
+    ecosystem: 'npm',
+    name: '@acme/core',
+    version: '1.2.0',
+    page: 'https://www.npmjs.com/package/@acme/core/v/1.2.0'
+  }
+])
+console.log(releasedOf(run).map(({ name }) => name)) // ['@acme/core']
+```
+
+## Interfaces
+
+- [LinkOptions](interfaces/LinkOptions.md)
+- [PackageRegistry](interfaces/PackageRegistry.md)
+- [ReleasedPackage](interfaces/ReleasedPackage.md)
+- [ReleaseLink](interfaces/ReleaseLink.md)
+- [ReleaseRun](interfaces/ReleaseRun.md)
+
+## Functions
+
+- [forgetReleased](functions/forgetReleased.md)
+- [recordReleased](functions/recordReleased.md)
+- [releasedOf](functions/releasedOf.md)
+- [releaseLinks](functions/releaseLinks.md)

package/api/@wtf/release-trains/links/functions/forgetReleased.md

@@ -0,0 +1,25 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-trains/links](../README.md) / forgetReleased
+
+# Function: forgetReleased()
+
+> **forgetReleased**(`run`): `void`
+
+Defined in: [packages/release-trains/src/links.ts:148](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/links.ts#L148)
+
+Forgets what the release of `run` recorded, as once its links are made.
+
+## Parameters
+
+### run
+
+[`ReleaseRun`](../interfaces/ReleaseRun.md)
+
+The folder of the repo, the train and the version of the release.
+
+## Returns
+
+`void`

package/api/@wtf/release-trains/links/functions/recordReleased.md

@@ -0,0 +1,39 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-trains/links](../README.md) / recordReleased
+
+# Function: recordReleased()
+
+> **recordReleased**(`run`, `ecosystem`, `packages`): `void`
+
+Defined in: [packages/release-trains/src/links.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/links.ts#L121)
+
+Records the packages of `ecosystem` that the release of `run` published, or found published, in
+place of what was recorded of the ecosystem in the run before, as of a release run again: none of
+none. A plugin that publishes the packages of an ecosystem calls it in its `publish` step.
+
+## Parameters
+
+### run
+
+[`ReleaseRun`](../interfaces/ReleaseRun.md)
+
+The folder of the repo, the train and the version of the release.
+
+### ecosystem
+
+`string`
+
+The ecosystem of the packages, as `npm`.
+
+### packages
+
+readonly [`ReleasedPackage`](../interfaces/ReleasedPackage.md)[]
+
+Each package, and where it is.
+
+## Returns
+
+`void`

package/api/@wtf/release-trains/links/functions/releaseLinks.md

@@ -0,0 +1,41 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-trains/links](../README.md) / releaseLinks
+
+# Function: releaseLinks()
+
+> **releaseLinks**(`packages`, `options`): `Promise`\<[`ReleaseLink`](../interfaces/ReleaseLink.md)[]\>
+
+Defined in: [packages/release-trains/src/links.ts:261](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/links.ts#L261)
+
+The link of each package of `packages` on the GitLab release of the tag, by the first rule it has
+(see the module): its page; its page on GitLab, of a package registry of GitLab, looked up by
+the Packages API; its file, uploaded to the generic package registry of the project, as the
+package of the train at the version; its folder at the tag. Each link is named by its package:
+of two of one name, by the name and the ecosystem. The run's token of GitLab, as
+`@semantic-release/gitlab` reads it, goes to the GitLab of the project alone. Throws, together,
+`ERELEASELINK` of each package of none, `EGITLABPACKAGE` of each a registry of GitLab does not
+list, and `EGITLAB` of each request GitLab refuses.
+
+## Parameters
+
+### packages
+
+readonly [`ReleasedPackage`](../interfaces/ReleasedPackage.md)[]
+
+The packages of the release, as [releasedOf](releasedOf.md) gives them.
+
+### options
+
+[`LinkOptions`](../interfaces/LinkOptions.md)
+
+The project, the tag, the train and the version of the release, the environment,
+the `fetch`, and what reads a file.
+
+## Returns
+
+`Promise`\<[`ReleaseLink`](../interfaces/ReleaseLink.md)[]\>
+
+The links, in the order of the packages.

package/api/@wtf/release-trains/links/functions/releasedOf.md

@@ -0,0 +1,28 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-trains/links](../README.md) / releasedOf
+
+# Function: releasedOf()
+
+> **releasedOf**(`run`): [`ReleasedPackage`](../interfaces/ReleasedPackage.md)[]
+
+Defined in: [packages/release-trains/src/links.ts:139](https://gitlab.com/wetryfun/release/release/-/blob/c809bd8cecbc1c397a236ebae5ac4646f705ca34/packages/release-trains/src/links.ts#L139)
+
+The packages the release of `run` recorded, of every ecosystem, in the order the plugins
+recorded them: none of a run of none.
+
+## Parameters
+
+### run
+
+[`ReleaseRun`](../interfaces/ReleaseRun.md)
+
+The folder of the repo, the train and the version of the release.
+
+## Returns
+
+[`ReleasedPackage`](../interfaces/ReleasedPackage.md)[]
+
+The packages.