npm - @wtf/release-docs - Versions diffs - 9.0.2 → 10.0.0 - Mend

@wtf/release-docs 9.0.2 → 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (882) hide show

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

@@ -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/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-validate/src/index.ts#L113)
+Defined in: [packages/semantic-release-validate/src/index.ts:114](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-validate/src/index.ts#L114)
 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/interfaces/ValidatePluginOptions.md CHANGED Viewed

@@ -6,7 +6,7 @@
 # Interface: ValidatePluginOptions
-Defined in: [packages/semantic-release-validate/src/index.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-validate/src/index.ts#L42)
+Defined in: [packages/semantic-release-validate/src/index.ts:43](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-validate/src/index.ts#L43)
 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/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-validate/src/index.ts#L47)
+Defined in: [packages/semantic-release-validate/src/index.ts:48](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-validate/src/index.ts#L48)
 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 CHANGED Viewed

@@ -6,7 +6,7 @@
 # Interface: Validator
-Defined in: [packages/semantic-release-validate/src/schema.ts:13](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/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/27c0c9bead8eea4a721e18a0cbd2724080f82e69/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/3b0e2c3c91b521977d05b801e2297d0df9e52834/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/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-validate/src/schema.ts#L15)
 The properties of both standards.

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

@@ -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/3b0e2c3c91b521977d05b801e2297d0df9e52834/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/27c0c9bead8eea4a721e18a0cbd2724080f82e69/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 CHANGED Viewed

@@ -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/3b0e2c3c91b521977d05b801e2297d0df9e52834/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/27c0c9bead8eea4a721e18a0cbd2724080f82e69/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 CHANGED Viewed

@@ -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/3b0e2c3c91b521977d05b801e2297d0df9e52834/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/27c0c9bead8eea4a721e18a0cbd2724080f82e69/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 CHANGED Viewed

@@ -8,7 +8,7 @@
 > **default**: `object`
-Defined in: [packages/semantic-release-validate/src/index.ts:181](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-validate/src/index.ts#L181)
+Defined in: [packages/semantic-release-validate/src/index.ts:182](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-validate/src/index.ts#L182)
 ## Type Declaration
@@ -18,7 +18,7 @@ Defined in: [packages/semantic-release-validate/src/index.ts:181](https://gitlab
 Validates the config of the run, as it was written ([configOf](../functions/configOf.md)), `plugins` too, by the
 plugin's `schema`: its own options first (`EOPTIONS` of its `./schema`), then the config, each
-issue an error `ECONFIG` of where it is, all at once.
+issue an error `ECONFIG` of where it is, all at once, each marked as semantic-release prints it.
 #### Parameters

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

@@ -4,15 +4,15 @@
 [Release trains](../../../README.md) / [@wtf/semantic-release-validate](../README.md) / verifyConditions
-# Function: verifyConditions()
+# Variable: verifyConditions
-> **verifyConditions**(`pluginConfig`, `context`): `Promise`\<`void`\>
+> `const` **verifyConditions**: (`pluginConfig`, `context`) => `Promise`\<`void`\>
-Defined in: [packages/semantic-release-validate/src/index.ts:160](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/semantic-release-validate/src/index.ts#L160)
+Defined in: [packages/semantic-release-validate/src/index.ts:161](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/semantic-release-validate/src/index.ts#L161)
-Validates the config of the run, as it was written ([configOf](configOf.md)), `plugins` too, by the
+Validates the config of the run, as it was written ([configOf](../functions/configOf.md)), `plugins` too, by the
 plugin's `schema`: its own options first (`EOPTIONS` of its `./schema`), then the config, each
-issue an error `ECONFIG` of where it is, all at once.
+issue an error `ECONFIG` of where it is, all at once, each marked as semantic-release prints it.
 ## Parameters

package/api/README.md CHANGED Viewed

@@ -6,6 +6,7 @@
 ## Modules
+- [@wtf/release](@wtf/release/README.md)
 - [@wtf/release-cargo](@wtf/release-cargo/README.md)
 - [@wtf/release-cargo/auth](@wtf/release-cargo/auth/README.md)
 - [@wtf/release-cargo/crates](@wtf/release-cargo/crates/README.md)
@@ -13,12 +14,14 @@
 - [@wtf/release-cargo/errors](@wtf/release-cargo/errors/README.md)
 - [@wtf/release-cargo/publish](@wtf/release-cargo/publish/README.md)
 - [@wtf/release-cargo/registry](@wtf/release-cargo/registry/README.md)
+- [@wtf/release-cargo/release](@wtf/release-cargo/release/README.md)
 - [@wtf/release-cargo/stamp](@wtf/release-cargo/stamp/README.md)
 - [@wtf/release-go](@wtf/release-go/README.md)
 - [@wtf/release-go/ecosystem](@wtf/release-go/ecosystem/README.md)
 - [@wtf/release-go/errors](@wtf/release-go/errors/README.md)
 - [@wtf/release-go/gomod](@wtf/release-go/gomod/README.md)
 - [@wtf/release-go/modules](@wtf/release-go/modules/README.md)
+- [@wtf/release-go/release](@wtf/release-go/release/README.md)
 - [@wtf/release-go/stamp](@wtf/release-go/stamp/README.md)
 - [@wtf/release-go/tags](@wtf/release-go/tags/README.md)
 - [@wtf/release-maven](@wtf/release-maven/README.md)
@@ -38,30 +41,28 @@
 - [@wtf/release-npm/publishers](@wtf/release-npm/publishers/README.md)
 - [@wtf/release-npm/release](@wtf/release-npm/release/README.md)
 - [@wtf/release-npm/workspace](@wtf/release-npm/workspace/README.md)
+- [@wtf/release-oci](@wtf/release-oci/README.md)
+- [@wtf/release-oci/ecosystem](@wtf/release-oci/ecosystem/README.md)
+- [@wtf/release-oci/errors](@wtf/release-oci/errors/README.md)
+- [@wtf/release-oci/images](@wtf/release-oci/images/README.md)
+- [@wtf/release-oci/publish](@wtf/release-oci/publish/README.md)
+- [@wtf/release-oci/registry](@wtf/release-oci/registry/README.md)
+- [@wtf/release-oci/tags](@wtf/release-oci/tags/README.md)
 - [@wtf/release-replace](@wtf/release-replace/README.md)
 - [@wtf/release-replace/errors](@wtf/release-replace/errors/README.md)
 - [@wtf/release-replace/files](@wtf/release-replace/files/README.md)
 - [@wtf/release-replace/replace](@wtf/release-replace/replace/README.md)
 - [@wtf/release-replace/templates](@wtf/release-replace/templates/README.md)
 - [@wtf/release-replace/values](@wtf/release-replace/values/README.md)
-- [@wtf/release-system](@wtf/release-system/README.md)
-- [@wtf/release-system/errors](@wtf/release-system/errors/README.md)
-- [@wtf/release-system/git](@wtf/release-system/git/README.md)
-- [@wtf/release-system/node](@wtf/release-system/node/README.md)
-- [@wtf/release-system/paths](@wtf/release-system/paths/README.md)
-- [@wtf/release-system/posix](@wtf/release-system/posix/README.md)
-- [@wtf/release-system/system](@wtf/release-system/system/README.md)
-- [@wtf/release-system/validator](@wtf/release-system/validator/README.md)
 - [@wtf/release-trains](@wtf/release-trains/README.md)
 - [@wtf/release-trains/cascade](@wtf/release-trains/cascade/README.md)
-- [@wtf/release-trains/ecosystem](@wtf/release-trains/ecosystem/README.md)
 - [@wtf/release-trains/errors](@wtf/release-trains/errors/README.md)
-- [@wtf/release-trains/generated](@wtf/release-trains/generated/README.md)
 - [@wtf/release-trains/git](@wtf/release-trains/git/README.md)
 - [@wtf/release-trains/gitlab](@wtf/release-trains/gitlab/README.md)
 - [@wtf/release-trains/links](@wtf/release-trains/links/README.md)
 - [@wtf/release-trains/packages](@wtf/release-trains/packages/README.md)
 - [@wtf/release-trains/paths](@wtf/release-trains/paths/README.md)
+- [@wtf/release-trains/plan](@wtf/release-trains/plan/README.md)
 - [@wtf/release-trains/schema](@wtf/release-trains/schema/README.md)
 - [@wtf/release-trains/trains](@wtf/release-trains/trains/README.md)
 - [@wtf/release-trains/verify](@wtf/release-trains/verify/README.md)
@@ -69,6 +70,20 @@
 - [@wtf/release-validate/errors](@wtf/release-validate/errors/README.md)
 - [@wtf/release-validate/json-schema](@wtf/release-validate/json-schema/README.md)
 - [@wtf/release-validate/validate](@wtf/release-validate/validate/README.md)
+- [@wtf/release/contract](@wtf/release/contract/README.md)
+- [@wtf/release/driver](@wtf/release/driver/README.md)
+- [@wtf/release/ecosystem](@wtf/release/ecosystem/README.md)
+- [@wtf/release/errors](@wtf/release/errors/README.md)
+- [@wtf/release/files](@wtf/release/files/README.md)
+- [@wtf/release/forge](@wtf/release/forge/README.md)
+- [@wtf/release/generated](@wtf/release/generated/README.md)
+- [@wtf/release/git](@wtf/release/git/README.md)
+- [@wtf/release/order](@wtf/release/order/README.md)
+- [@wtf/release/paths](@wtf/release/paths/README.md)
+- [@wtf/release/posix](@wtf/release/posix/README.md)
+- [@wtf/release/process](@wtf/release/process/README.md)
+- [@wtf/release/validator](@wtf/release/validator/README.md)
+- [@wtf/semantic-release](@wtf/semantic-release/README.md)
 - [@wtf/semantic-release-cargo](@wtf/semantic-release-cargo/README.md)
 - [@wtf/semantic-release-cargo/schema](@wtf/semantic-release-cargo/schema/README.md)
 - [@wtf/semantic-release-go](@wtf/semantic-release-go/README.md)
@@ -77,6 +92,8 @@
 - [@wtf/semantic-release-maven/schema](@wtf/semantic-release-maven/schema/README.md)
 - [@wtf/semantic-release-npm](@wtf/semantic-release-npm/README.md)
 - [@wtf/semantic-release-npm/schema](@wtf/semantic-release-npm/schema/README.md)
+- [@wtf/semantic-release-oci](@wtf/semantic-release-oci/README.md)
+- [@wtf/semantic-release-oci/schema](@wtf/semantic-release-oci/schema/README.md)
 - [@wtf/semantic-release-replace](@wtf/semantic-release-replace/README.md)
 - [@wtf/semantic-release-replace/schema](@wtf/semantic-release-replace/schema/README.md)
 - [@wtf/semantic-release-trains](@wtf/semantic-release-trains/README.md)
@@ -87,3 +104,7 @@
 - [@wtf/semantic-release-trains/schema](@wtf/semantic-release-trains/schema/README.md)
 - [@wtf/semantic-release-validate](@wtf/semantic-release-validate/README.md)
 - [@wtf/semantic-release-validate/schema](@wtf/semantic-release-validate/schema/README.md)
+- [@wtf/semantic-release/errors](@wtf/semantic-release/errors/README.md)
+- [@wtf/semantic-release/links](@wtf/semantic-release/links/README.md)
+- [@wtf/semantic-release/release](@wtf/semantic-release/release/README.md)
+- [@wtf/semantic-release/schema](@wtf/semantic-release/schema/README.md)

package/api/trains.json CHANGED Viewed

@@ -1,36 +1,59 @@
 {
   "trains": {
-    "system": [
-      "@wtf/release-system"
+    "release": [
+      "@wtf/release"
+    ],
+    "semantic-release": [
+      "@wtf/semantic-release"
     ],
     "trains": [
-      "@wtf/release-trains",
+      "@wtf/release-trains"
+    ],
+    "semantic-release-trains": [
       "@wtf/semantic-release-trains"
     ],
     "npm": [
-      "@wtf/release-npm",
+      "@wtf/release-npm"
+    ],
+    "semantic-release-npm": [
       "@wtf/semantic-release-npm"
     ],
     "replace": [
-      "@wtf/release-replace",
+      "@wtf/release-replace"
+    ],
+    "semantic-release-replace": [
       "@wtf/semantic-release-replace"
     ],
     "validate": [
-      "@wtf/release-validate",
+      "@wtf/release-validate"
+    ],
+    "semantic-release-validate": [
       "@wtf/semantic-release-validate"
     ],
     "cargo": [
-      "@wtf/release-cargo",
+      "@wtf/release-cargo"
+    ],
+    "semantic-release-cargo": [
       "@wtf/semantic-release-cargo"
     ],
     "go": [
-      "@wtf/release-go",
+      "@wtf/release-go"
+    ],
+    "semantic-release-go": [
       "@wtf/semantic-release-go"
     ],
     "maven": [
-      "@wtf/release-maven",
+      "@wtf/release-maven"
+    ],
+    "semantic-release-maven": [
       "@wtf/semantic-release-maven"
     ],
+    "oci": [
+      "@wtf/release-oci"
+    ],
+    "semantic-release-oci": [
+      "@wtf/semantic-release-oci"
+    ],
     "docs": [
       "@wtf/release-docs"
     ]

package/guides/ci-recipes.md CHANGED Viewed

@@ -20,7 +20,7 @@ same rules:
 Some builds generate a folder that the release commits, such as an API reference. Such a build
 lists what it wrote in the folder's `.generated` file, with `listGenerated` from
-`@wtf/release-trains/generated`. The release then stages the folder exactly as it was built,
+`@wtf/release/generated`. The release then stages the folder exactly as it was built,
 deletions included.
 ## GitLab CI
@@ -57,8 +57,8 @@ release:
   resource_group: release
   parallel:
     matrix:
-      # The order of the dependencies: system before trains and replace, and each before docs.
-      - RELEASE_TRAIN: [system, trains, replace, validate, docs]
+      # The order of the dependencies: release before the others, and each before docs.
+      - RELEASE_TRAIN: [release, trains, replace, validate, docs]
   # What the build job built: each dist, and the generated folders with their lists.
   needs: [build]
   before_script:
@@ -222,7 +222,7 @@ What the bin does:
   npm already has is skipped.
 - When semantic-release later adds a release to another channel, for example when you merge one
   branch into another, it pushes a note and no tag. No pipeline starts. On such branches, move the
-  dist-tag with `tagTrain`, or by hand.
+  dist-tag with `moveRelease` from `@wtf/release-npm/release`, or by hand.
 - The bin runs modules of semantic-release 25 that are not semantic-release's API. Check an upgrade
   of semantic-release with a `--dry-run` of a tag.
@@ -297,7 +297,7 @@ One job of the component releases the trains. It runs semantic-release once for
 A train that has no commit to release releases nothing and passes, and the next train runs. So when
 you retry the job after a failed run, it passes the trains that it released already, and goes on
-from the train that failed. For the trains of these guides, the job releases `system`, `trains`,
+from the train that failed. For the trains of these guides, the job releases `release`, `trains`,
 `replace`, `validate` and `docs`:
 ```yaml
@@ -309,8 +309,8 @@ spec:
     release-trains:
       description: The trains the semantic-release job releases.
       type: array
-      default: [system, trains, replace, validate, docs]
-      options: [system, trains, replace, validate, docs]
+      default: [release, trains, replace, validate, docs]
+      options: [release, trains, replace, validate, docs]
 ---
 include:
   - component: $CI_SERVER_FQDN/to-be-continuous/semantic-release/gitlab-ci-semrel@4.3.0
@@ -321,7 +321,7 @@ include:
 variables:
   # The input `release-trains`, as a component of to-be-continuous maps each input: a variable of
   # the CI/CD settings, of "Run pipeline", or of the start of the manual job overrides it. The space
-  # after the input makes GitLab write the array as text, `["system", "trains"] `, which a variable
+  # after the input makes GitLab write the array as text, `["release", "trains"] `, which a variable
   # takes: the input alone stays an array, which no variable holds.
   RELEASE_TRAINS: '$[[ inputs.release-trains ]] '
@@ -401,15 +401,15 @@ Each part of the YAML does one thing:
    trains, and in whatever order, the job releases them in the order of the config's trains, each
    after the trains it depends on. It fails on a name that is not a train.
-The config keeps the order safe. With `dependencies: 'fail'` at the root, a run of `trains` or
-`replace` fails while `system` has commits that it has not released. A run of `docs` fails, through
-its `dependsOn`, while any train it names has unreleased commits. So a set out of order, or a train
-chosen alone, fails instead of releasing against what is not released. Release the train it names
-first.
+The config keeps the order safe. With `dependencies: 'fail'` at the root, a run of `trains`,
+`replace` or `validate` fails while `release` has commits that it has not released. A run of `docs`
+fails, through its `dependsOn`, while any train it names has unreleased commits. So a set out of
+order, or a train chosen alone, fails instead of releasing against what is not released. Release
+the train it names first.
 A train also releases with no commit of its own when a dependency train released a version outside
-a range that the train's last release published (`cascade`). For example, a major of `system`
-releases `trains` and `replace` after it, in the same click. See
+a range that the train's last release published (`cascade`). For example, a major of `release`
+releases `trains`, `replace` and `validate` after it, in the same click. See
 [Dependency rules](dependency-rules.md).
 ```js train=docs
@@ -417,7 +417,7 @@ releases `trains` and `replace` after it, in the same click. See
 import { trainChangelog } from '@wtf/semantic-release-trains/config'
 const trains = {
-  system: { paths: ['packages/release-system'] },
+  release: { paths: ['packages/release', 'packages/semantic-release'] },
   trains: { paths: ['packages/release-trains', 'packages/semantic-release-trains'] },
   replace: { paths: ['packages/release-replace', 'packages/semantic-release-replace'] },
   validate: { paths: ['packages/release-validate', 'packages/semantic-release-validate'] },
@@ -425,7 +425,7 @@ const trains = {
     paths: ['packages/docs'],
     generated: ['packages/docs/api'],
     // Say the docs package lists none of the packages it documents: it releases after them.
-    dependsOn: ['system', 'trains', 'replace', 'validate']
+    dependsOn: ['release', 'trains', 'replace', 'validate']
   }
 }
 const train = process.env.RELEASE_TRAIN
@@ -466,7 +466,7 @@ cannot. The variable must reach every ref that the job releases, and a protected
 only protected refs. So protect:
 - each branch in `branches`;
-- the trains' tags, whose pipelines publish, by their patterns: `system-v*`, `trains-v*`,
+- the trains' tags, whose pipelines publish, by their patterns: `release-v*`, `trains-v*`,
   `replace-v*`, `validate-v*` and `docs-v*`.
 Here `GITLAB_TOKEN` is a protected variable of the group. A train's tag that you leave unprotected
@@ -577,7 +577,7 @@ node-build:
     paths:
       - packages/*/dist/
   rules:
-    - if: $CI_COMMIT_TAG =~ /^(system|trains|replace|validate|docs)-v\d+\.\d+\.\d+/
+    - if: $CI_COMMIT_TAG =~ /^(release|trains|replace|validate|docs)-v\d+\.\d+\.\d+/
     - if: $CI_COMMIT_TAG
       when: never
     # The component's own.
@@ -596,7 +596,7 @@ release-pack-smoke:
     - job: node-build
       artifacts: true
   rules:
-    - if: $CI_COMMIT_TAG =~ /^(system|trains|replace|validate|docs)-v\d+\.\d+\.\d+/
+    - if: $CI_COMMIT_TAG =~ /^(release|trains|replace|validate|docs)-v\d+\.\d+\.\d+/
     - if: $CI_COMMIT_TAG
       when: never
     - if: $CI_PIPELINE_SOURCE == "merge_request_event"
@@ -616,7 +616,7 @@ publish-release:
     - job: release-pack-smoke
       artifacts: false
   rules:
-    - if: $CI_COMMIT_TAG =~ /^(system|trains|replace|validate|docs)-v\d+\.\d+\.\d+/
+    - if: $CI_COMMIT_TAG =~ /^(release|trains|replace|validate|docs)-v\d+\.\d+\.\d+/
   # Never cancel a publish in flight; one release at a time.
   interruptible: false
   resource_group: release
@@ -739,8 +739,10 @@ export default {
 ### How this repo's pipeline differs
-This repo releases its packages in the trains of these guides: `system`, `trains`, `replace`,
-`validate` and `docs`. Its pipeline is the [Release component](https://gitlab.com/wetryfun/devops/components/release)
+This repo releases its packages in trains like those of these guides, each library on one, as
+`trains`, `replace` and `validate`, and each plugin on one of its own, named after its package, as
+`semantic-release-trains`, between `release` and `semantic-release`, first, and `docs`, last. Its
+pipeline is the [Release component](https://gitlab.com/wetryfun/devops/components/release)
 of wetryfun's components, which packs the recipes above, the `semantic-release` job of every train
 of one click, `release-smoke` and `release-publish` of a tag's pipeline, on the
 [Node.js workspace component](https://gitlab.com/wetryfun/devops/components/node). It differs from
@@ -768,8 +770,8 @@ Its other parts:
   it. See [Predict the next release of each train](#predict-the-next-release-of-each-train).
 - The tag's `release-publish` job runs the workspace's `semantic-release-trains-tag`, of the build
   of the tag's pipeline, which it publishes. Its config finds the tag's train with `trainOfTag`.
-- The tags of every train, `system-v*`, `trains-v*`, `replace-v*`, `validate-v*` and `docs-v*`, are
-  protected, because `GITLAB_TOKEN` is a protected variable of the group.
+- The tags of every train, as `release-v*`, `trains-v*`, `semantic-release-trains-v*` and `docs-v*`,
+  are protected, because `GITLAB_TOKEN` is a protected variable of the group.
 ## GitHub Actions
@@ -799,8 +801,8 @@ jobs:
       max-parallel: 1
       fail-fast: true
       matrix:
-        # The order of the dependencies: system before trains and replace, and each before docs.
-        train: [system, trains, replace, validate, docs]
+        # The order of the dependencies: release before the others, and each before docs.
+        train: [release, trains, replace, validate, docs]
     steps:
       - uses: actions/checkout@v4
         with:

package/guides/configuring-trains.md CHANGED Viewed

@@ -13,8 +13,11 @@ the train's tags:
 import type { Trains } from '@wtf/release-trains'
 export const trains: Trains = {
-  // The base of the libraries, which trains and replace list.
-  system: { paths: ['packages/release-system'], shared: ['pnpm-lock.yaml', 'packages/shared'] },
+  // The base of the libraries, and what every plugin shares, which the other trains list.
+  release: {
+    paths: ['packages/release', 'packages/semantic-release'],
+    shared: ['pnpm-lock.yaml', 'packages/shared']
+  },
   trains: {
     // The folders of the train, from the root of the repo, or globs of them.
     paths: [
@@ -41,7 +44,7 @@ export const trains: Trains = {
     generated: ['packages/docs/api'],
     // Trains that this train releases after, though no package of it lists theirs: say the docs
     // package lists none of the packages it documents.
-    dependsOn: ['system', 'trains', 'replace', 'validate']
+    dependsOn: ['release', 'trains', 'replace', 'validate']
   }
 }
 ```
@@ -129,11 +132,11 @@ So the build lists what it wrote, in the folder's `.generated` file. Call `listG
 of the build, after the build has written the folder in full:
 ```ts
-import { nodeSystem } from '@wtf/release-system/node'
-import { listGenerated } from '@wtf/release-trains/generated'
+import { listGenerated } from '@wtf/release/generated'
+import { nodeDirectory } from '@wtf/platform-fs-node/handles'
-const system = nodeSystem()
-await listGenerated(system.cwd, 'packages/docs/api', { system })
+const root = await nodeDirectory(process.cwd())
+await listGenerated('packages/docs/api', { root })
 ```
 In `prepare`, an entry of `@wtf/semantic-release-trains` with `generated: true` stages the folder
@@ -586,20 +589,21 @@ the config. It sets the parser's `breakingHeaderPattern` at the root, so that ev
 ## Use the libraries directly
 `@wtf/release-trains` holds what the trains plugin runs, and it does not depend on semantic-release.
-Each function takes the `system` it runs on, so a CLI can pass its own. The parts that know nothing
-about trains (the system, paths and globs, git, validators and `ReleaseError`) live in
-`@wtf/release-system`, which `@wtf/release-trains` builds on.
+Each function takes the folder of the repo, `root`, and the platform it runs on, so a CLI can pass
+its own. See [The platform](platform.md). The parts that know nothing about trains (the platform's
+types, files, programs, paths and globs, git, validators and `ReleaseError`) live in
+`@wtf/release`, which `@wtf/release-trains` builds on.
 `@wtf/release-trains` reads no manifest itself. The repo's packages are the ones its ecosystems
 give. For example, the default export of `@wtf/release-npm` gives the packages of each
 `package.json`:
 ```ts
+import type { ReleasePlatform, RepoContext } from '@wtf/release'
+import { publishOrder } from '@wtf/release/order'
+import { pathMatcher } from '@wtf/release/paths'
 import npm from '@wtf/release-npm'
-import { pathMatcher } from '@wtf/release-system/paths'
-import type { System } from '@wtf/release-system/system'
 import type { Trains } from '@wtf/release-trains'
-import { publishOrder } from '@wtf/release-trains/packages'
 import { filterCommits, gitFilesOf, trainOfPath } from '@wtf/release-trains/paths'
 import { unreleasedDependencies, verifyTrain } from '@wtf/release-trains/verify'
@@ -613,25 +617,25 @@ pathMatcher(['packages/release-trains'])('packages/release-trains/package.json')
 // The commits of a train, by the files git reads for each commit. It needs every train, to know
 // which files are a train's own.
-export async function commitsOfTrains(hashes: readonly string[], system: System) {
+export async function commitsOfTrains(hashes: readonly string[], repo: RepoContext) {
   const commits = hashes.map((hash) => ({ hash }))
-  return filterCommits(commits, trains, 'trains', gitFilesOf({ system }))
+  return filterCommits(commits, trains, 'trains', gitFilesOf(repo))
 }
 // The packages of the repo in the order to publish them in.
-export async function order(system: System) {
-  return publishOrder(await npm.packages({ system })).order.map(({ name }) => name)
+export async function order(repo: RepoContext<ReleasePlatform>) {
+  return publishOrder(await npm.packages(repo)).order.map(({ name }) => name)
 }
 // The train checked before a release, and its dependency trains, any commit of one a patch.
-export async function check(system: System) {
-  await verifyTrain({ trains, train: 'replace', ecosystems: [npm], system })
+export async function check(repo: RepoContext<ReleasePlatform>) {
+  await verifyTrain({ ...repo, trains, train: 'replace', ecosystems: [npm] })
   await unreleasedDependencies({
+    ...repo,
     trains,
     train: 'replace',
     rule: 'fail',
     ecosystems: [npm],
-    system,
     analyze: async (commits) => (commits.length > 0 ? 'patch' : null)
   })
 }

package/guides/dependency-rules.md CHANGED Viewed

@@ -6,9 +6,9 @@ your releases and to understand the errors the checks give.
 ## When a train depends on another
-Train `trains` depends on train `system` when a package in `trains` depends on a package in
-`system`, by any kind of dependency except `dev`. For example, `@wtf/release-trains` lists
-`@wtf/release-system`. A package is in a train when its folder is under the train's paths.
+Train `trains` depends on train `release` when a package in `trains` depends on a package in
+`release`, by any kind of dependency except `dev`. For example, `@wtf/release-trains` lists
+`@wtf/release`. A package is in a train when its folder is under the train's paths.
 The packages come from the ecosystems that the root option `ecosystems` names. The same rules apply
 to each ecosystem:
@@ -79,28 +79,28 @@ wraps.
 ## When a required version has no release
 Some checks fail the run whatever the `dependencies` option says. They apply when a package of
-`trains` that publishes requires a version range of a package of `system` that publishes. A release
-of `system` must then satisfy that range.
+`trains` that publishes requires a version range of a package of `release` that publishes. A
+release of the train `release` must then satisfy that range.
 This holds for any range that reaches the registry. For npm, that is every field except
 `devDependencies`. No consumer installs a devDependency, and the publish drops one whose version no
 release has.
-| Error                    | When                                                                        |
-| ------------------------ | --------------------------------------------------------------------------- |
-| `EDEPENDENCYNOTRAIN`     | The range is on a package that is in no train.                              |
-| `EDEPENDENCYNORELEASE`   | The package's train has no release, so no release gives it a version.       |
-| `EDEPENDENCYUNSATISFIED` | No tag of `system` names a version in the range. The run of `trains` fails. |
+| Error                    | When                                                                         |
+| ------------------------ | ---------------------------------------------------------------------------- |
+| `EDEPENDENCYNOTRAIN`     | The range is on a package that is in no train.                               |
+| `EDEPENDENCYNORELEASE`   | The package's train has no release, so no release gives it a version.        |
+| `EDEPENDENCYUNSATISFIED` | No tag of `release` names a version in the range. The run of `trains` fails. |
-In this config, `dependencies: 'fail'` also fails the run of `trains` when `system` has commits that
-it has not released:
+In this config, `dependencies: 'fail'` also fails the run of `trains` when `release` has commits
+that it has not released:
 ```js train=trains
 // release.config.mjs
 import { trainTagFormat } from '@wtf/semantic-release-trains/config'
 const trains = {
-  system: { paths: ['packages/release-system'] },
+  release: { paths: ['packages/release', 'packages/semantic-release'] },
   trains: { paths: ['packages/release-trains', 'packages/semantic-release-trains'] }
 }
 const train = process.env.RELEASE_TRAIN
@@ -185,7 +185,7 @@ after its own notes, whatever those notes are:
 ```md
 ### Dependencies
-- @wtf/release-trains: dependency @wtf/release-system ^1.0.0 → ^2.0.0 (system 2.0.0)
+- @wtf/release-trains: dependency @wtf/release ^1.0.0 → ^2.0.0 (release 2.0.0)
 ```
 Nothing else cascades:
@@ -216,7 +216,7 @@ released fails the run before any cascade is read. `cascade: false` turns cascad
 import { trainTagFormat } from '@wtf/semantic-release-trains/config'
 const trains = {
-  system: { paths: ['packages/release-system'] },
+  release: { paths: ['packages/release', 'packages/semantic-release'] },
   trains: { paths: ['packages/release-trains', 'packages/semantic-release-trains'] }
 }
 const train = process.env.RELEASE_TRAIN
@@ -241,8 +241,8 @@ analyzer.
 Release the trains in dependency order, by their packages and by `dependsOn`: each train before
 every train that depends on it. `trainOrder` in `@wtf/release-trains/packages` gives that order.
-For the trains in these guides, it releases `system` before `trains` and `replace`, and each of them
-before `docs`.
+For the trains in these guides, it releases `release` before `trains`, `replace` and `validate`, and
+each of them before `docs`.
 In CI, release the trains in that order, one at a time. Use one job that runs semantic-release once
 for each train, or a matrix whose jobs cannot run at the same time. See