@wtf/release-docs 8.2.1 → 8.2.3

package/api/@wtf/semantic-release-trains/variables/publish.md

@@ -8,6 +8,6 @@
 
 > `const` **publish**: `Step` = `plugin.publish`
 
-Defined in: [packages/semantic-release-trains/src/index.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/index.ts#L67)
+Defined in: [packages/semantic-release-trains/src/index.ts:67](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-trains/src/index.ts#L67)
 
 The wrapped plugin's `publish`, of the train's commits: `false` of an entry of none.

package/api/@wtf/semantic-release-trains/variables/success.md

@@ -8,6 +8,6 @@
 
 > `const` **success**: `Step` = `plugin.success`
 
-Defined in: [packages/semantic-release-trains/src/index.ts:71](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/index.ts#L71)
+Defined in: [packages/semantic-release-trains/src/index.ts:71](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-trains/src/index.ts#L71)
 
 The wrapped plugin's `success`, of the train's commits.

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

@@ -8,6 +8,6 @@
 
 > `const` **verifyConditions**: `Step` = `plugin.verifyConditions`
 
-Defined in: [packages/semantic-release-trains/src/index.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/index.ts#L57)
+Defined in: [packages/semantic-release-trains/src/index.ts:57](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-trains/src/index.ts#L57)
 
 Each entry's check of the trains, and the wrapped plugin's `verifyConditions`.

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

@@ -8,6 +8,6 @@
 
 > `const` **verifyRelease**: `Step` = `plugin.verifyRelease`
 
-Defined in: [packages/semantic-release-trains/src/index.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-trains/src/index.ts#L61)
+Defined in: [packages/semantic-release-trains/src/index.ts:61](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-trains/src/index.ts#L61)
 
 The wrapped plugin's `verifyRelease`, of the train's commits.

package/api/@wtf/semantic-release-validate/functions/configOf.md

@@ -8,7 +8,7 @@
 
 > **configOf**(`options`): `Record`\<`string`, `unknown`\>
 
-Defined in: [packages/semantic-release-validate/src/index.ts:83](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/index.ts#L83)
+Defined in: [packages/semantic-release-validate/src/index.ts:83](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-validate/src/index.ts#L83)
 
 The config of a run as it was written, of the options semantic-release gives a plugin in
 `context.options`, which are the config, with its defaults, and what semantic-release adds:

package/api/@wtf/semantic-release-validate/functions/loadSchema.md

@@ -8,7 +8,7 @@
 
 > **loadSchema**(`spec`, `cwd`): `Promise`\<`StandardSchemaV1`\<`unknown`, `unknown`\>\>
 
-Defined in: [packages/semantic-release-validate/src/index.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/index.ts#L113)
+Defined in: [packages/semantic-release-validate/src/index.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-validate/src/index.ts#L113)
 
 The schema of `spec`: a Standard Schema itself, or the default export of a module, by its path
 from `cwd` or the name of a package the repo installs. Throws `ESCHEMA` of one that cannot be

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

@@ -8,7 +8,7 @@
 
 > **verifyConditions**(`pluginConfig`, `context`): `Promise`\<`void`\>
 
-Defined in: [packages/semantic-release-validate/src/index.ts:160](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/index.ts#L160)
+Defined in: [packages/semantic-release-validate/src/index.ts:160](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-validate/src/index.ts#L160)
 
 Validates the config of the run, as it was written ([configOf](configOf.md)), `plugins` too, by the
 plugin's `schema`: its own options first (`EOPTIONS` of its `./schema`), then the config, each

package/api/@wtf/semantic-release-validate/interfaces/ValidatePluginOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: ValidatePluginOptions
 
-Defined in: [packages/semantic-release-validate/src/index.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/index.ts#L42)
+Defined in: [packages/semantic-release-validate/src/index.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-validate/src/index.ts#L42)
 
 The options of the plugin.
 
@@ -16,7 +16,7 @@ The options of the plugin.
 
 > `readonly` **schema**: `string` \| `StandardSchemaV1`\<`unknown`, `unknown`\>
 
-Defined in: [packages/semantic-release-validate/src/index.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/index.ts#L47)
+Defined in: [packages/semantic-release-validate/src/index.ts:47](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-validate/src/index.ts#L47)
 
 The schema the config satisfies: a Standard Schema, or a module whose default export is one, by
 its path from the root of the repo or the name of a package.

package/api/@wtf/semantic-release-validate/schema/interfaces/Validator.md

@@ -6,7 +6,7 @@
 
 # Interface: Validator
 
-Defined in: [packages/semantic-release-validate/src/schema.ts:13](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/schema.ts#L13)
+Defined in: [packages/semantic-release-validate/src/schema.ts:13](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-validate/src/schema.ts#L13)
 
 A validator of this package: a Standard Schema, and a Standard JSON Schema of draft 2020-12.
 
@@ -16,6 +16,6 @@ A validator of this package: a Standard Schema, and a Standard JSON Schema of dr
 
 > `readonly` **~standard**: `Props`\<`unknown`, `unknown`\> & `Props`\<`unknown`, `unknown`\>
 
-Defined in: [packages/semantic-release-validate/src/schema.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/schema.ts#L15)
+Defined in: [packages/semantic-release-validate/src/schema.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-validate/src/schema.ts#L15)
 
 The properties of both standards.

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

@@ -8,6 +8,6 @@
 
 > `const` **configSchema**: [`Validator`](../interfaces/Validator.md)
 
-Defined in: [packages/semantic-release-validate/src/schema.ts:118](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/schema.ts#L118)
+Defined in: [packages/semantic-release-validate/src/schema.ts:118](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-validate/src/schema.ts#L118)
 
 The validator of this package's part of a whole config: each entry of `plugins` of the plugin.

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

@@ -8,6 +8,6 @@
 
 > `const` **jsonSchema**: `Readonly`\<`Record`\<`string`, `unknown`\>\>
 
-Defined in: [packages/semantic-release-validate/src/schema.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/schema.ts#L121)
+Defined in: [packages/semantic-release-validate/src/schema.ts:121](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-validate/src/schema.ts#L121)
 
 The JSON Schema of [configSchema](configSchema.md), as the package publishes it, `schema.json`.

package/api/@wtf/semantic-release-validate/schema/variables/validateOptionsSchema.md

@@ -8,6 +8,6 @@
 
 > `const` **validateOptionsSchema**: [`Validator`](../interfaces/Validator.md)
 
-Defined in: [packages/semantic-release-validate/src/schema.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/schema.ts#L113)
+Defined in: [packages/semantic-release-validate/src/schema.ts:113](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-validate/src/schema.ts#L113)
 
 The validator of the options of an entry of the plugin: `schema`, required.

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

@@ -8,7 +8,7 @@
 
 > **default**: `object`
 
-Defined in: [packages/semantic-release-validate/src/index.ts:181](https://gitlab.com/wetryfun/release/release/-/blob/be2016d6f7c6f29592926b2f125da705da6376eb/packages/semantic-release-validate/src/index.ts#L181)
+Defined in: [packages/semantic-release-validate/src/index.ts:181](https://gitlab.com/wetryfun/release/release/-/blob/75f354c045d6f8fc82b18bbd9d6efb8f013a24b3/packages/semantic-release-validate/src/index.ts#L181)
 
 ## Type Declaration
 

package/guides/changelogs.md

@@ -1,11 +1,18 @@
 # Changelogs
 
-Each train has its own changelog, written by `@semantic-release/changelog` from the notes of the
-release. The trains plugin that wraps the release notes generator gives it the train's commits
-alone, so the notes, and the changelog, are of that train. Wrap the changelog plugin too, and the
-train gives it its file and title: the train's `changelog`, or the `CHANGELOG.md` of its first
-path, under `# Changelog`. Wrap `@semantic-release/git`, and the train gives it the assets of its
-release commit, the changelog among them, and a message of its name:
+Each train has its own changelog. `@semantic-release/changelog` writes it from the release notes.
+The trains plugin that wraps the release notes generator gives that generator only the train's
+commits, so the notes and the changelog cover that train alone.
+
+## Let the train set the changelog and the release commit
+
+Wrap the changelog plugin too, and the train gives it its file and its title:
+
+- The file is the train's `changelog`, or else the `CHANGELOG.md` in the train's first path.
+- The title is `# Changelog`.
+
+Wrap `@semantic-release/git` too, and the train gives it the assets of its release commit, the
+changelog among them, and a commit message with the train's name:
 
 ```js train=trains
 // release.config.mjs
@@ -35,40 +42,44 @@ export default {
 }
 ```
 
-A release run again, after a publish that failed part way, writes no section twice: the wrapped
-changelog plugin skips its `prepare` by the rule `section`, when the changelog has a heading of the
-release already, the first heading of the notes of any date. The stock plugin alone writes it
-again. `skip: { prepare: false }` turns it off; see
-[skipping a step](../../semantic-release-trains/README.md#skipping-a-step) for the rule of any step.
+When you run a release again after a publish failed part way, the wrapped changelog plugin does not
+write the section twice. It skips its `prepare` step by the rule `section` when the changelog
+already has a heading for the release: the first heading of the notes, with any date. The stock
+plugin alone would write the section again. `skip: { prepare: false }` turns this off. See
+[skipping a step](../../semantic-release-trains/README.md#skipping-a-step) for the rules that skip
+any step.
 
-An option the config gives a wrapped plugin wins over the train's: `wrap:
-['@semantic-release/changelog', { changelogFile: 'docs/CHANGES.md' }]`. Listed unwrapped, the
-plugins take what the config gives them: `trainChangelog`, `TITLE` and `trainAssets` of
-`@wtf/semantic-release-trains/config` give the same values to pass by hand.
+An option that the config gives a wrapped plugin wins over the train's option:
+`wrap: ['@semantic-release/changelog', { changelogFile: 'docs/CHANGES.md' }]`. If you list the
+plugins unwrapped, they take what the config gives them. `trainChangelog`, `TITLE` and
+`trainAssets` from `@wtf/semantic-release-trains/config` give the same values for you to pass by
+hand.
 
-The changelog plugin reads the notes, not the commits: the entry that wraps it is for its options.
-A preset of the notes generator decides how a section looks: its types, their headings, and the breaking changes
-first. Give each breaking commit a `BREAKING CHANGE:` footer as well as its `!`: see
+The changelog plugin reads the notes, not the commits, so you wrap it only for its options. The
+notes generator's preset decides how a section looks: its types, their headings, and breaking
+changes first. Give each breaking commit a `BREAKING CHANGE:` footer as well as its `!`. See
 [the caveat](configuring-trains.md#a-preset-and-type).
 
 ## The train in the heading
 
-The notes of a release are headed by its version alone: `## [4.0.0](…) (2026-11-02)`, as the
-release notes generator writes them. Give the entry of the trains plugin that wraps the notes
-generator `heading: 'train'`, and the first heading of the notes names the train before the rest of
-its line, its link and its date:
+The release notes generator heads the notes of a release with its version alone:
+`## [4.0.0](…) (2026-11-02)`. Give the entry that wraps the notes generator `heading: 'train'`, and
+the first heading of the notes names the train before the rest of its line, its link and its date:
 
 ```md
 ## trains [4.0.0](https://gitlab.com/wetryfun/release/release/compare/trains-v3.0.0...trains-v4.0.0) (2026-11-02)
 ```
 
-It rewrites the first heading of Markdown of the notes, of any generator, of any level: a major of
-the angular preset, `# [4.0.0](…)`, becomes `# trains [4.0.0](…)`. Notes of no heading are headed
-`## <train> <version>` first. With no `heading`, the notes are as the generator writes them; an
-entry of `generated`, or of no `wrap`, fails with `EOPTIONS` of a `heading`.
+It rewrites the first Markdown heading of the notes, from any generator, at any level. A major in
+the angular preset, `# [4.0.0](…)`, becomes `# trains [4.0.0](…)`. Notes with no heading get
+`## <train> <version>` first.
+
+Without `heading`, the notes stay as the generator writes them. A `heading` on a `generated` entry,
+or on an entry with no `wrap`, fails with `EOPTIONS`.
 
-So one changelog can hold the releases of every train, each under a heading that says which, after
-each train's own: a second `@semantic-release/changelog` writes the same notes at the top of it.
+With the train in each heading, one changelog can hold the releases of every train. Each release
+goes under a heading that names its train, in addition to the train's own changelog. A second
+`@semantic-release/changelog` writes the same notes at the top of the shared file:
 
 ```js train=trains
 // release.config.mjs