@wtf/release-docs 8.1.0 → 8.2.0

package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogOptions.md

@@ -1,68 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/write](../README.md) / ChangelogOptions
-
-# Interface: ChangelogOptions
-
-Defined in: [packages/release-trains-changelog/src/write.ts:54](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L54)
-
-What the changelogs of a train are, the same for each of its releases.
-
-## Extended by
-
-- [`ChangelogRelease`](ChangelogRelease.md)
-- [`ChangelogTarget`](ChangelogTarget.md)
-- [`ChangelogPluginOptions`](../../../semantic-release-trains-changelog/interfaces/ChangelogPluginOptions.md)
-
-## Properties
-
-### file?
-
-> `readonly` `optional` **file?**: `string` \| `false`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L59)
-
-The name of the changelog of each package, in its folder: `CHANGELOG.md`; `false` of none, as of
-a train of the train's changelog alone.
-
-***
-
-### repositoryUrl?
-
-> `readonly` `optional` **repositoryUrl?**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L67)
-
-The URL of the repository, which each commit links to the page of: none by default.
-
-***
-
-### title?
-
-> `readonly` `optional` **title?**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L61)
-
-The title of each changelog: `# Changelog`.
-
-***
-
-### trainChangelog?
-
-> `readonly` `optional` **trainChangelog?**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L65)
-
-The changelog of the train, from the root of the repo, of all its commits: none by default.
-
-***
-
-### types?
-
-> `readonly` `optional` **types?**: readonly (readonly \[`string`, `string`\])[]
-
-Defined in: [packages/release-trains-changelog/src/write.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L63)
-
-The types each shows, each with its heading, in order: `DEFAULT_TYPES` of `./render`.

package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogRelease.md

@@ -1,176 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/write](../README.md) / ChangelogRelease
-
-# Interface: ChangelogRelease
-
-Defined in: [packages/release-trains-changelog/src/write.ts:71](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L71)
-
-A release of a train, whose changelogs [writeChangelogs](../functions/writeChangelogs.md) writes.
-
-## Extends
-
-- [`ChangelogOptions`](ChangelogOptions.md)
-
-## Properties
-
-### commits
-
-> `readonly` **commits**: readonly [`ChangelogCommit`](../../render/interfaces/ChangelogCommit.md)[]
-
-Defined in: [packages/release-trains-changelog/src/write.ts:89](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L89)
-
-The commits of the release, each by its full hash: those since the train's last release.
-
-***
-
-### cwd?
-
-> `readonly` `optional` **cwd?**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:73](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L73)
-
-The folder of the repo: the system's working folder by default.
-
-***
-
-### date?
-
-> `readonly` `optional` **date?**: `string` \| `Date`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:87](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L87)
-
-The day of the release: the system's `now()` by default.
-
-***
-
-### ecosystems
-
-> `readonly` **ecosystems**: readonly [`Ecosystem`](../../../release-trains/ecosystem/interfaces/Ecosystem.md)[]
-
-Defined in: [packages/release-trains-changelog/src/write.ts:83](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L83)
-
-The ecosystems of the repo, whose packages are the packages of the train.
-
-***
-
-### env?
-
-> `readonly` `optional` **env?**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
-
-Defined in: [packages/release-trains-changelog/src/write.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L75)
-
-The environment git runs in: the system's by default.
-
-***
-
-### file?
-
-> `readonly` `optional` **file?**: `string` \| `false`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L59)
-
-The name of the changelog of each package, in its folder: `CHANGELOG.md`; `false` of none, as of
-a train of the train's changelog alone.
-
-#### Inherited from
-
-[`ChangelogOptions`](ChangelogOptions.md).[`file`](ChangelogOptions.md#file)
-
-***
-
-### repositoryUrl?
-
-> `readonly` `optional` **repositoryUrl?**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L67)
-
-The URL of the repository, which each commit links to the page of: none by default.
-
-#### Inherited from
-
-[`ChangelogOptions`](ChangelogOptions.md).[`repositoryUrl`](ChangelogOptions.md#repositoryurl)
-
-***
-
-### system
-
-> `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
-
-Defined in: [packages/release-trains-changelog/src/write.ts:77](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L77)
-
-The system it runs by, which it requires.
-
-***
-
-### title?
-
-> `readonly` `optional` **title?**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L61)
-
-The title of each changelog: `# Changelog`.
-
-#### Inherited from
-
-[`ChangelogOptions`](ChangelogOptions.md).[`title`](ChangelogOptions.md#title)
-
-***
-
-### train
-
-> `readonly` **train**: `string` \| `undefined`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:81](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L81)
-
-The train of the release: `ETRAINNOTSELECTED` of none.
-
-***
-
-### trainChangelog?
-
-> `readonly` `optional` **trainChangelog?**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L65)
-
-The changelog of the train, from the root of the repo, of all its commits: none by default.
-
-#### Inherited from
-
-[`ChangelogOptions`](ChangelogOptions.md).[`trainChangelog`](ChangelogOptions.md#trainchangelog)
-
-***
-
-### trains
-
-> `readonly` **trains**: [`Trains`](../../../release-trains/type-aliases/Trains.md)
-
-Defined in: [packages/release-trains-changelog/src/write.ts:79](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L79)
-
-Every train of the repo.
-
-***
-
-### types?
-
-> `readonly` `optional` **types?**: readonly (readonly \[`string`, `string`\])[]
-
-Defined in: [packages/release-trains-changelog/src/write.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L63)
-
-The types each shows, each with its heading, in order: `DEFAULT_TYPES` of `./render`.
-
-#### Inherited from
-
-[`ChangelogOptions`](ChangelogOptions.md).[`types`](ChangelogOptions.md#types)
-
-***
-
-### version
-
-> `readonly` **version**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:85](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L85)
-
-The version of the release.

package/api/@wtf/release-trains-changelog/write/interfaces/ChangelogTarget.md

@@ -1,146 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/write](../README.md) / ChangelogTarget
-
-# Interface: ChangelogTarget
-
-Defined in: [packages/release-trains-changelog/src/write.ts:213](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L213)
-
-Where the changelogs of a train go: its trains, its train, and their options.
-
-## Extends
-
-- [`ChangelogOptions`](ChangelogOptions.md)
-
-## Properties
-
-### cwd?
-
-> `readonly` `optional` **cwd?**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:221](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L221)
-
-The folder of the repo: the system's working folder by default.
-
-***
-
-### ecosystems
-
-> `readonly` **ecosystems**: readonly [`Ecosystem`](../../../release-trains/ecosystem/interfaces/Ecosystem.md)[]
-
-Defined in: [packages/release-trains-changelog/src/write.ts:219](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L219)
-
-The ecosystems of the repo, whose packages are the packages of each train.
-
-***
-
-### env?
-
-> `readonly` `optional` **env?**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
-
-Defined in: [packages/release-trains-changelog/src/write.ts:223](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L223)
-
-The environment git runs in: the system's by default.
-
-***
-
-### file?
-
-> `readonly` `optional` **file?**: `string` \| `false`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L59)
-
-The name of the changelog of each package, in its folder: `CHANGELOG.md`; `false` of none, as of
-a train of the train's changelog alone.
-
-#### Inherited from
-
-[`ChangelogOptions`](ChangelogOptions.md).[`file`](ChangelogOptions.md#file)
-
-***
-
-### repositoryUrl?
-
-> `readonly` `optional` **repositoryUrl?**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L67)
-
-The URL of the repository, which each commit links to the page of: none by default.
-
-#### Inherited from
-
-[`ChangelogOptions`](ChangelogOptions.md).[`repositoryUrl`](ChangelogOptions.md#repositoryurl)
-
-***
-
-### system
-
-> `readonly` **system**: [`System`](../../../release-system/system/interfaces/System.md)
-
-Defined in: [packages/release-trains-changelog/src/write.ts:225](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L225)
-
-The system it runs by, which it requires.
-
-***
-
-### title?
-
-> `readonly` `optional` **title?**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L61)
-
-The title of each changelog: `# Changelog`.
-
-#### Inherited from
-
-[`ChangelogOptions`](ChangelogOptions.md).[`title`](ChangelogOptions.md#title)
-
-***
-
-### train
-
-> `readonly` **train**: `string` \| `undefined`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:217](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L217)
-
-The train of the release.
-
-***
-
-### trainChangelog?
-
-> `readonly` `optional` **trainChangelog?**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L65)
-
-The changelog of the train, from the root of the repo, of all its commits: none by default.
-
-#### Inherited from
-
-[`ChangelogOptions`](ChangelogOptions.md).[`trainChangelog`](ChangelogOptions.md#trainchangelog)
-
-***
-
-### trains
-
-> `readonly` **trains**: [`Trains`](../../../release-trains/type-aliases/Trains.md)
-
-Defined in: [packages/release-trains-changelog/src/write.ts:215](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L215)
-
-Every train of the repo.
-
-***
-
-### types?
-
-> `readonly` `optional` **types?**: readonly (readonly \[`string`, `string`\])[]
-
-Defined in: [packages/release-trains-changelog/src/write.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L63)
-
-The types each shows, each with its heading, in order: `DEFAULT_TYPES` of `./render`.
-
-#### Inherited from
-
-[`ChangelogOptions`](ChangelogOptions.md).[`types`](ChangelogOptions.md#types)

package/api/@wtf/release-trains-changelog/write/interfaces/WrittenChangelog.md

@@ -1,37 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/release-trains-changelog/write](../README.md) / WrittenChangelog
-
-# Interface: WrittenChangelog
-
-Defined in: [packages/release-trains-changelog/src/write.ts:117](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L117)
-
-A changelog written, and how many commits its section holds.
-
-## Properties
-
-### commits
-
-> `readonly` **commits**: `number`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:119](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L119)
-
-***
-
-### file
-
-> `readonly` **file**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:118](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L118)
-
-***
-
-### kept
-
-> `readonly` **kept**: `boolean`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L121)
-
-Whether it was kept as it is, as it has a section of the version already.

package/api/@wtf/semantic-release-trains-changelog/README.md

@@ -1,47 +0,0 @@
-[**Release trains**](../../README.md)
-
-***
-
-[Release trains](../../README.md) / @wtf/semantic-release-trains-changelog
-
-# @wtf/semantic-release-trains-changelog
-
-The plugin of semantic-release that writes a changelog of each package of a release train, and
-of the train when it names one (`trainChangelog`), by `@wtf/release-trains-changelog`: in
-`prepare`, at the top of the changelog of each package of the train, the section of the commits
-of the release that change its own folder, grouped by their type. A package no commit of the
-release changes gets no section.
-
-It reads `trains` and `ecosystems` of its options, which semantic-release gives it of the root of
-the config, the packages of each train those of the ecosystems, each loaded of the repo as the
-plugin of the trains loads them; and the train of the run of its option `train`, or else
-`RELEASE_TRAIN` of the environment of the run; and makes Node's system, with the option `system`
-over it, for each call. List it before @semantic-release/git, which commits what it writes:
-
-```js
-// release.config.mjs
-export default {
-  trains: { trains: { paths: ['packages/release-trains', 'packages/release-trains-*'] } },
-  ecosystems: ['@wtf/release-npm'],
-  tagFormat: `${process.env.RELEASE_TRAIN}-v\${version}`,
-  plugins: [
-    ['@wtf/semantic-release-trains', { wrap: '@semantic-release/commit-analyzer' }],
-    ['@wtf/semantic-release-trains', { wrap: '@semantic-release/release-notes-generator' }],
-    '@wtf/semantic-release-trains-changelog',
-    ['@semantic-release/git', { assets: ['packages/release-trains*/CHANGELOG.md'] }]
-  ]
-}
-```
-
-## Interfaces
-
-- [ChangelogPluginOptions](interfaces/ChangelogPluginOptions.md)
-
-## Variables
-
-- [default](variables/default.md)
-
-## Functions
-
-- [prepare](functions/prepare.md)
-- [verifyConditions](functions/verifyConditions.md)

package/api/@wtf/semantic-release-trains-changelog/functions/prepare.md

@@ -1,33 +0,0 @@
-[**Release trains**](../../../README.md)
-
-***
-
-[Release trains](../../../README.md) / [@wtf/semantic-release-trains-changelog](../README.md) / prepare
-
-# Function: prepare()
-
-> **prepare**(`pluginConfig`, `context`): `Promise`\<`void`\>
-
-Defined in: [packages/semantic-release-trains-changelog/src/index.ts:152](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains-changelog/src/index.ts#L152)
-
-Writes the changelog of each package of the train, unless `file` is `false`, and the train's, of
-the commits of the release, at the version of the release, dated by the system's `now()`.
-
-## Parameters
-
-### pluginConfig
-
-[`ChangelogPluginOptions`](../interfaces/ChangelogPluginOptions.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, the next release and its commits.
-
-## Returns
-
-`Promise`\<`void`\>

package/api/@wtf/semantic-release-trains-changelog/functions/verifyConditions.md

@@ -1,36 +0,0 @@
-[**Release trains**](../../../README.md)
-
-***
-
-[Release trains](../../../README.md) / [@wtf/semantic-release-trains-changelog](../README.md) / verifyConditions
-
-# Function: verifyConditions()
-
-> **verifyConditions**(`pluginConfig`, `context`): `Promise`\<`void`\>
-
-Defined in: [packages/semantic-release-trains-changelog/src/index.ts:126](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains-changelog/src/index.ts#L126)
-
-Checks the options of the plugin, by `changelogSchema` of `./schema` (`EOPTIONS`, and the codes
-of the trains); that each ecosystem loads (`EECOSYSTEM`); that the train is declared; that its
-changelog, `trainChangelog`, is none of
-a package's, nor another train's: `ECHANGELOG` of one that is; and that, of `file: false`, it has
-one: `ECHANGELOG` of none.
-
-## Parameters
-
-### pluginConfig
-
-[`ChangelogPluginOptions`](../interfaces/ChangelogPluginOptions.md)
-
-The plugin's options of the config, with `trains` of its root.
-
-### context
-
-`VerifyConditionsContext` & `OfRun`
-
-The context of semantic-release's `verifyConditions` step: the folder, the
-environment and the logger of the run.
-
-## Returns
-
-`Promise`\<`void`\>

package/api/@wtf/semantic-release-trains-changelog/interfaces/ChangelogPluginOptions.md

@@ -1,126 +0,0 @@
-[**Release trains**](../../../README.md)
-
-***
-
-[Release trains](../../../README.md) / [@wtf/semantic-release-trains-changelog](../README.md) / ChangelogPluginOptions
-
-# Interface: ChangelogPluginOptions
-
-Defined in: [packages/semantic-release-trains-changelog/src/index.ts:51](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains-changelog/src/index.ts#L51)
-
-The options of the plugin, in the config of semantic-release or at its root.
-
-## Extends
-
-- [`ChangelogOptions`](../../release-trains-changelog/write/interfaces/ChangelogOptions.md)
-
-## Properties
-
-### ecosystems
-
-> `readonly` **ecosystems**: readonly `string`[]
-
-Defined in: [packages/semantic-release-trains-changelog/src/index.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains-changelog/src/index.ts#L57)
-
-The ecosystems of the repo, each the name of a module whose default export is one.
-
-***
-
-### file?
-
-> `readonly` `optional` **file?**: `string` \| `false`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L59)
-
-The name of the changelog of each package, in its folder: `CHANGELOG.md`; `false` of none, as of
-a train of the train's changelog alone.
-
-#### Inherited from
-
-[`ChangelogOptions`](../../release-trains-changelog/write/interfaces/ChangelogOptions.md).[`file`](../../release-trains-changelog/write/interfaces/ChangelogOptions.md#file)
-
-***
-
-### repositoryUrl?
-
-> `readonly` `optional` **repositoryUrl?**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L67)
-
-The URL of the repository, which each commit links to the page of: none by default.
-
-#### Inherited from
-
-[`ChangelogOptions`](../../release-trains-changelog/write/interfaces/ChangelogOptions.md).[`repositoryUrl`](../../release-trains-changelog/write/interfaces/ChangelogOptions.md#repositoryurl)
-
-***
-
-### system?
-
-> `readonly` `optional` **system?**: [`SystemInput`](../../release-system/system/type-aliases/SystemInput.md)
-
-Defined in: [packages/semantic-release-trains-changelog/src/index.ts:59](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains-changelog/src/index.ts#L59)
-
-The system the plugin runs by, over Node's.
-
-***
-
-### title?
-
-> `readonly` `optional` **title?**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L61)
-
-The title of each changelog: `# Changelog`.
-
-#### Inherited from
-
-[`ChangelogOptions`](../../release-trains-changelog/write/interfaces/ChangelogOptions.md).[`title`](../../release-trains-changelog/write/interfaces/ChangelogOptions.md#title)
-
-***
-
-### train?
-
-> `readonly` `optional` **train?**: `string`
-
-Defined in: [packages/semantic-release-trains-changelog/src/index.ts:53](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains-changelog/src/index.ts#L53)
-
-The train of the run: `RELEASE_TRAIN` of the environment of the run by default.
-
-***
-
-### trainChangelog?
-
-> `readonly` `optional` **trainChangelog?**: `string`
-
-Defined in: [packages/release-trains-changelog/src/write.ts:65](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L65)
-
-The changelog of the train, from the root of the repo, of all its commits: none by default.
-
-#### Inherited from
-
-[`ChangelogOptions`](../../release-trains-changelog/write/interfaces/ChangelogOptions.md).[`trainChangelog`](../../release-trains-changelog/write/interfaces/ChangelogOptions.md#trainchangelog)
-
-***
-
-### trains
-
-> `readonly` **trains**: [`Trains`](../../release-trains/type-aliases/Trains.md)
-
-Defined in: [packages/semantic-release-trains-changelog/src/index.ts:55](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains-changelog/src/index.ts#L55)
-
-Every train of the repo.
-
-***
-
-### types?
-
-> `readonly` `optional` **types?**: readonly (readonly \[`string`, `string`\])[]
-
-Defined in: [packages/release-trains-changelog/src/write.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/release-trains-changelog/src/write.ts#L63)
-
-The types each shows, each with its heading, in order: `DEFAULT_TYPES` of `./render`.
-
-#### Inherited from
-
-[`ChangelogOptions`](../../release-trains-changelog/write/interfaces/ChangelogOptions.md).[`types`](../../release-trains-changelog/write/interfaces/ChangelogOptions.md#types)