@wtf/release-docs 8.1.0 → 8.2.0

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

@@ -1,24 +0,0 @@
-[**Release trains**](../../../README.md)
-
-***
-
-[Release trains](../../../README.md) / @wtf/semantic-release-trains-changelog/schema
-
-# @wtf/semantic-release-trains-changelog/schema
-
-The schema of the options of the plugin, as validators of `@wtf/release-system/validator`: each a
-Standard Schema, and a Standard JSON Schema of the JSON Schema of what it checks.
-
-- [changelogSchema](variables/changelogSchema.md): the options the plugin is given, of the root of the config and of its
-  entry, as it checks them;
-- [changelogOptionsSchema](variables/changelogOptionsSchema.md): the options of its entry, 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`.
-
-## Variables
-
-- [changelogOptionsSchema](variables/changelogOptionsSchema.md)
-- [changelogSchema](variables/changelogSchema.md)
-- [configSchema](variables/configSchema.md)
-- [jsonSchema](variables/jsonSchema.md)

package/api/@wtf/semantic-release-trains-changelog/schema/variables/changelogOptionsSchema.md

@@ -1,13 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/semantic-release-trains-changelog/schema](../README.md) / changelogOptionsSchema
-
-# Variable: changelogOptionsSchema
-
-> `const` **changelogOptionsSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`ChangelogOptions`](../../../release-trains-changelog/write/interfaces/ChangelogOptions.md)\>
-
-Defined in: [packages/semantic-release-trains-changelog/src/schema.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains-changelog/src/schema.ts#L31)
-
-The validator of the options of an entry of the plugin, its own.

package/api/@wtf/semantic-release-trains-changelog/schema/variables/changelogSchema.md

@@ -1,13 +0,0 @@
-[**Release trains**](../../../../README.md)
-
-***
-
-[Release trains](../../../../README.md) / [@wtf/semantic-release-trains-changelog/schema](../README.md) / changelogSchema
-
-# Variable: changelogSchema
-
-> `const` **changelogSchema**: [`Validator`](../../../release-system/validator/interfaces/Validator.md)\<[`RootOptions`](../../../release-trains/schema/interfaces/RootOptions.md) & [`ChangelogOptions`](../../../release-trains-changelog/write/interfaces/ChangelogOptions.md)\>
-
-Defined in: [packages/semantic-release-trains-changelog/src/schema.ts:49](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains-changelog/src/schema.ts#L49)
-
-The validator of the options the plugin is given: the root's, and its own.

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

@@ -1,68 +0,0 @@
-[**Release trains**](../../../README.md)
-
-***
-
-[Release trains](../../../README.md) / [@wtf/semantic-release-trains-changelog](../README.md) / default
-
-# Variable: default
-
-> **default**: `object`
-
-Defined in: [packages/semantic-release-trains-changelog/src/index.ts:176](https://gitlab.com/wetryfun/release/release/-/blob/e8884f72193f59f831b5f9a2797121152ce6f3cb/packages/semantic-release-trains-changelog/src/index.ts#L176)
-
-## Type Declaration
-
-### prepare
-
-> **prepare**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
-
-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`\>
-
-### verifyConditions
-
-> **verifyConditions**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
-
-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`\>