@wtf/release-docs 9.0.2 → 10.0.0

package/api/@wtf/release-npm/prepare/interfaces/PreparedManifest.md

@@ -6,7 +6,7 @@
 
 # Interface: PreparedManifest
 
-Defined in: [packages/release-npm/src/prepare.ts:94](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/prepare.ts#L94)
+Defined in: [packages/release-npm/src/prepare.ts:94](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L94)
 
 What [prepareManifest](../functions/prepareManifest.md) made of a manifest, and what it changed.
 
@@ -16,7 +16,7 @@ What [prepareManifest](../functions/prepareManifest.md) made of a manifest, and
 
 > `readonly` **dropped**: `number`
 
-Defined in: [packages/release-npm/src/prepare.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/prepare.ts#L101)
+Defined in: [packages/release-npm/src/prepare.ts:101](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L101)
 
 The devDependencies of the workspace by a `workspace:` range of no version dropped.
 
@@ -26,7 +26,7 @@ The devDependencies of the workspace by a `workspace:` range of no version dropp
 
 > `readonly` **manifest**: `Record`\<`string`, `unknown`\>
 
-Defined in: [packages/release-npm/src/prepare.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/prepare.ts#L95)
+Defined in: [packages/release-npm/src/prepare.ts:95](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L95)
 
 ***
 
@@ -34,7 +34,7 @@ Defined in: [packages/release-npm/src/prepare.ts:95](https://gitlab.com/wetryfun
 
 > `readonly` **resolved**: `number`
 
-Defined in: [packages/release-npm/src/prepare.ts:99](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/prepare.ts#L99)
+Defined in: [packages/release-npm/src/prepare.ts:99](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L99)
 
 The `workspace:` ranges resolved.
 
@@ -44,7 +44,7 @@ The `workspace:` ranges resolved.
 
 > `readonly` **stripped**: `number`
 
-Defined in: [packages/release-npm/src/prepare.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/prepare.ts#L103)
+Defined in: [packages/release-npm/src/prepare.ts:103](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L103)
 
 The exports of the source stripped.
 
@@ -54,6 +54,6 @@ The exports of the source stripped.
 
 > `readonly` **versioned**: `boolean`
 
-Defined in: [packages/release-npm/src/prepare.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/prepare.ts#L97)
+Defined in: [packages/release-npm/src/prepare.ts:97](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L97)
 
 Whether its version was another.

package/api/@wtf/release-npm/prepare/variables/SOURCE_CONDITIONS.md

@@ -8,6 +8,6 @@
 
 > `const` **SOURCE\_CONDITIONS**: readonly `string`[]
 
-Defined in: [packages/release-npm/src/prepare.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/prepare.ts#L15)
+Defined in: [packages/release-npm/src/prepare.ts:15](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/prepare.ts#L15)
 
 The export conditions of the source by default, which no tarball ships.

package/api/@wtf/release-npm/publishers/README.md

@@ -6,7 +6,7 @@
 
 # @wtf/release-npm/publishers
 
-The publishers built in, each by the processes of the system it is given: `npm`, the default
+The publishers built in, each by the processes of the platform it is given: `npm`, the default
 ([npmPublisher](variables/npmPublisher.md)), which runs the `npm` bin, and so publishes with provenance and by the
 trusted publishing of npm's registry as npm itself does; and `pnpm` ([pnpmPublisher](variables/pnpmPublisher.md)),
 which publishes by `pnpm publish` and asks the registry by npm. Another is an object of your own

package/api/@wtf/release-npm/publishers/functions/builtInPublisher.md

@@ -8,7 +8,7 @@
 
 > **builtInPublisher**(`name`): [`Publisher`](../../interfaces/Publisher.md)
 
-Defined in: [packages/release-npm/src/publishers.ts:385](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/publishers.ts#L385)
+Defined in: [packages/release-npm/src/publishers.ts:390](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/publishers.ts#L390)
 
 The publisher built in of `name` ([PUBLISHERS](../variables/PUBLISHERS.md)). Throws `EPUBLISHER` of a name none is
 built in of.

package/api/@wtf/release-npm/publishers/functions/isPublisher.md

@@ -8,7 +8,7 @@
 
 > **isPublisher**(`value`): `value is Publisher`
 
-Defined in: [packages/release-npm/src/publishers.ts:368](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/publishers.ts#L368)
+Defined in: [packages/release-npm/src/publishers.ts:373](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/publishers.ts#L373)
 
 Whether `value` is a [Publisher](../../interfaces/Publisher.md): a `name`, and `lookup` and `publish` functions, and
 `pack`, `tag` and `page`, where it has them, functions too.

package/api/@wtf/release-npm/publishers/functions/registryOf.md

@@ -8,7 +8,7 @@
 
 > **registryOf**(`pkg`, `registry`): `string` \| `undefined`
 
-Defined in: [packages/release-npm/src/publishers.ts:34](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/publishers.ts#L34)
+Defined in: [packages/release-npm/src/publishers.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/publishers.ts#L36)
 
 The registry a package is published to, where a release names one: the option's, else the
 package's `publishConfig.registry`; `undefined` of neither, of the publisher's own.

package/api/@wtf/release-npm/publishers/variables/NPM_REGISTRY.md

@@ -8,6 +8,6 @@
 
 > `const` **NPM\_REGISTRY**: `"https://registry.npmjs.org/"` = `'https://registry.npmjs.org/'`
 
-Defined in: [packages/release-npm/src/publishers.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/publishers.ts#L24)
+Defined in: [packages/release-npm/src/publishers.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/publishers.ts#L26)
 
 npm's registry, whose pages [npmPublisher](npmPublisher.md) links.

package/api/@wtf/release-npm/publishers/variables/PUBLISHERS.md

@@ -8,6 +8,6 @@
 
 > `const` **PUBLISHERS**: `Readonly`\<`Record`\<`string`, [`Publisher`](../../interfaces/Publisher.md)\>\>
 
-Defined in: [packages/release-npm/src/publishers.ts:356](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/publishers.ts#L356)
+Defined in: [packages/release-npm/src/publishers.ts:361](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/publishers.ts#L361)
 
 The publishers built in, by name.

package/api/@wtf/release-npm/publishers/variables/npmPublisher.md

@@ -8,7 +8,7 @@
 
 > `const` **npmPublisher**: [`Publisher`](../../interfaces/Publisher.md)
 
-Defined in: [packages/release-npm/src/publishers.ts:284](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/publishers.ts#L284)
+Defined in: [packages/release-npm/src/publishers.ts:287](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/publishers.ts#L287)
 
 The publisher of the `npm` bin: whether a version is published, and where a dist-tag points, by
 `npm view`; each package packed by `npm pack`, of no lifecycle script, as the build ran before

package/api/@wtf/release-npm/publishers/variables/pnpmPublisher.md

@@ -8,7 +8,7 @@
 
 > `const` **pnpmPublisher**: [`Publisher`](../../interfaces/Publisher.md)
 
-Defined in: [packages/release-npm/src/publishers.ts:331](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/publishers.ts#L331)
+Defined in: [packages/release-npm/src/publishers.ts:336](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/publishers.ts#L336)
 
 The publisher of the `pnpm` bin: whether a version is published, and where a dist-tag points, by
 `npm view`, as pnpm asks npm's registry the same way; each package published from its folder by

package/api/@wtf/release-npm/release/README.md

@@ -6,61 +6,83 @@
 
 # @wtf/release-npm/release
 
-A release of a train published, in three steps, each by the system it is given, none of which
-writes a file of the repo: the version of the release is the tag's, and each package.json in git
-keeps the version it has, a placeholder, as `0.0.0-development`.
-
-1. [resolveManifests](functions/resolveManifests.md): the packages of the train that publish, every one under its paths
-   that is not private, in the order to publish them in, each manifest as it publishes: of the
-   version of the release, each `workspace:` range resolved, of a package of the train to the
-   release's version and of another train's to the last release of that train, by its tags, and
-   each export of the source stripped; each checked. It writes nothing.
-2. [packTrain](functions/packTrain.md): each package copied into a folder of the system's temporary files, its
-   manifest as it publishes written into the copy, and packed there by a publisher that packs,
-   all before the first publish, so a fault stops the run before anything is on the registry.
-3. [publishTrain](functions/publishTrain.md): each published in order, under the dist-tag of the channel, or of the
-   version of none ([distTagOf](functions/distTagOf.md)), `release-1.x` of a channel npm takes for a range, with
-   the provenance of the build where the CI gives an ID token, and each the registry has at the
-   version already skipped, so a publish run again publishes what is missing. `cleanup` of what
-   [packTrain](functions/packTrain.md) gave removes the copies, and the tarballs but of a `tarballDir` named.
-
-[releaseTrain](functions/releaseTrain.md) runs the three in one call, as the job of the pipeline of a tag publishes
-its release. [tagTrain](functions/tagTrain.md) moves a release published already to another channel: the dist-tag
-of each package of the train pointed at its version.
+The npm packages of a release published, of the plan its caller gives it, as `Plan` of
+`@wtf/release/contract` has it: the packages that publish, in the order to publish them in, and
+the version of each package of the repo a range of theirs resolves to. It knows no train and no
+release tool, and writes no file of the repo: the version of the release is given, and each
+package.json in git keeps the version it has, a placeholder, as `0.0.0-development`. Each step of
+the contract is a function of this module, which the ecosystem of `./ecosystem` runs:
+
+- [verifyRelease](functions/verifyRelease.md): the version of semver, the options ([npmOptionsSchema](variables/npmOptionsSchema.md)), and the
+  packages as they are in the repo ([checkPlan](functions/checkPlan.md));
+- [prepareRelease](functions/prepareRelease.md): each manifest as it publishes, of the version of the release, each
+  `workspace:` range resolved to the version of the plan, each export of the source stripped, and
+  checked ([resolvePlan](functions/resolvePlan.md)); each package packed from a copy in a temporary folder of the
+  platform ([packRelease](functions/packRelease.md)); and the registry asked, so a release that would move a dist-tag
+  back fails before anything is published ([publishedOf](functions/publishedOf.md)). It writes no file of the repo,
+  and gives none;
+- [smokeRelease](functions/smokeRelease.md): each package packed tried as a consumer installs it, by `smokePacked` of
+  `./smoke`;
+- [publishRelease](functions/publishRelease.md): each package published in order, under the first dist-tag of `moving`,
+  each other pointed at it, with the provenance of the build where the CI gives an ID token, and
+  each the registry has at the version already skipped, so a publish run again publishes what is
+  missing ([publishPacked](functions/publishPacked.md));
+- [moveRelease](functions/moveRelease.md): each dist-tag of `moving` pointed at a version published already.
+
+What `prepare` packed, `smoke` and `publish` take in the same process, of the same folder,
+version and packages; a step that finds nothing packed packs again, as the same tree packs the
+same tarballs, and [discardPacked](functions/discardPacked.md) removes what is packed of a release that goes no
+further.
+
+```ts
+import type { Release } from '@wtf/release/contract'
+import npm from '@wtf/release-npm'
+import type { NpmPackage } from '@wtf/release-npm/manifests'
+
+declare const release: Release
+declare const own: readonly NpmPackage[]
+
+const plan = { own, versions: new Map(own.map(({ name }) => [name, release.version])) }
+const options = { moving: ['latest'] } as const
+await npm.verify(release, plan, options)
+await npm.prepare(release, plan, options)
+const released = await npm.publish(release, plan, options)
+```
 
 ## Interfaces
 
-- [CheckRelease](interfaces/CheckRelease.md)
-- [PackedTrain](interfaces/PackedTrain.md)
+- [MovedPackage](interfaces/MovedPackage.md)
+- [MovedRelease](interfaces/MovedRelease.md)
+- [NpmPlan](interfaces/NpmPlan.md)
+- [PackedRelease](interfaces/PackedRelease.md)
 - [PackOptions](interfaces/PackOptions.md)
 - [PublishedOf](interfaces/PublishedOf.md)
 - [PublishedPackage](interfaces/PublishedPackage.md)
-- [PublishedTrain](interfaces/PublishedTrain.md)
+- [PublishedRelease](interfaces/PublishedRelease.md)
 - [PublishRun](interfaces/PublishRun.md)
 - [ResolvedPackage](interfaces/ResolvedPackage.md)
-- [ResolvedTrain](interfaces/ResolvedTrain.md)
-- [ResolveRelease](interfaces/ResolveRelease.md)
-- [TagRelease](interfaces/TagRelease.md)
+- [ResolvedRelease](interfaces/ResolvedRelease.md)
 
 ## Type Aliases
 
-- [LookedUpTrain](type-aliases/LookedUpTrain.md)
-- [ReleaseRun](type-aliases/ReleaseRun.md)
+- [LookedUpRelease](type-aliases/LookedUpRelease.md)
 
 ## Variables
 
 - [ID\_TOKENS](variables/ID_TOKENS.md)
+- [npmOptionsSchema](variables/npmOptionsSchema.md)
 - [RUNNER\_ENVIRONMENTS](variables/RUNNER_ENVIRONMENTS.md)
 
 ## Functions
 
-- [checkTrain](functions/checkTrain.md)
-- [distTagOf](functions/distTagOf.md)
-- [packTrain](functions/packTrain.md)
+- [checkPlan](functions/checkPlan.md)
+- [discardPacked](functions/discardPacked.md)
+- [moveRelease](functions/moveRelease.md)
+- [packRelease](functions/packRelease.md)
+- [prepareRelease](functions/prepareRelease.md)
 - [publishedOf](functions/publishedOf.md)
-- [publishedOfResolved](functions/publishedOfResolved.md)
 - [publishPacked](functions/publishPacked.md)
-- [publishTrain](functions/publishTrain.md)
-- [releaseTrain](functions/releaseTrain.md)
-- [resolveManifests](functions/resolveManifests.md)
-- [tagTrain](functions/tagTrain.md)
+- [publishRelease](functions/publishRelease.md)
+- [resolvePlan](functions/resolvePlan.md)
+- [smokeRelease](functions/smokeRelease.md)
+- [verifyRelease](functions/verifyRelease.md)

package/api/@wtf/release-npm/release/functions/checkPlan.md

@@ -0,0 +1,44 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-npm/release](../README.md) / checkPlan
+
+# Function: checkPlan()
+
+> **checkPlan**(`root`, `plan`, `options?`): `Promise`\<`string`[]\>
+
+Defined in: [packages/release-npm/src/release.ts:229](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L229)
+
+Checks the packages of a plan as they are in the repo, before a release makes them ready: each
+scoped one public, of a license and a repository, none running with a private package, and an
+order of publishing that holds, unless `check` is `false`; and each name of `aside` of a package
+of the workspace. It reads the workspace of the folder of the repo, and writes nothing. Gives the
+name of each package that publishes, in order; throws `EPUBLISHCHECK` of what is wrong.
+
+## Parameters
+
+### root
+
+`FileSystemDirectoryHandle`
+
+The folder of the repo, a handle of the File System standard.
+
+### plan
+
+[`NpmPlan`](../interfaces/NpmPlan.md)
+
+The packages that publish, in order, and what is wrong with their order.
+
+### options?
+
+`Pick`\<[`NpmOptions`](../../interfaces/NpmOptions.md), `"access"` \| `"check"` \| `"aside"`\> = `{}`
+
+Whether the packages are checked, the access of each, and the packages of
+`aside`.
+
+## Returns
+
+`Promise`\<`string`[]\>
+
+The name of each package that publishes, in the order of publishing.

package/api/@wtf/release-npm/release/functions/discardPacked.md

@@ -0,0 +1,32 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-npm/release](../README.md) / discardPacked
+
+# Function: discardPacked()
+
+> **discardPacked**(`release`, `plan`): `Promise`\<`void`\>
+
+Defined in: [packages/release-npm/src/release.ts:1195](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L1195)
+
+Removes what `prepare` packed of a release and its plan in this process, the copies and every
+tarball, of a `tarballDir` too, as of a release that goes no further: none of none.
+
+## Parameters
+
+### release
+
+`Pick`\<[`Release`](../../../release/contract/interfaces/Release.md), `"platform"` \| `"version"`\>
+
+The version of the release and the platform, of the folder of the repo.
+
+### plan
+
+[`Plan`](../../../release/contract/interfaces/Plan.md)
+
+The packages that publish.
+
+## Returns
+
+`Promise`\<`void`\>

package/api/@wtf/release-npm/release/functions/moveRelease.md

@@ -0,0 +1,47 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-npm/release](../README.md) / moveRelease
+
+# Function: moveRelease()
+
+> **moveRelease**(`release`, `plan`, `options`): `Promise`\<[`MovedRelease`](../interfaces/MovedRelease.md)\>
+
+Defined in: [packages/release-npm/src/release.ts:1001](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L1001)
+
+Moves a release published already to the dist-tags of `moving`: each pointed at the version, of
+each package of the plan, in the order of publishing, by the publisher's [Publisher.tag](../../interfaces/Publisher.md#tag);
+each the registry does not have at the version, as a package that joined the release after it was
+published, skipped, and each whose dist-tag points above the version, of a publisher that reads
+dist-tags, as of an older release moved after a newer one, which would move it back; one whose
+dist-tag points at the version already is there, and not moved again. The registry is asked of
+every package, a few at a time, by the publisher's [Publisher.lookup](../../interfaces/Publisher.md#lookup), before the first
+dist-tag moves. A publisher that moves no dist-tag moves none, and says so: the release stays
+where it was published.
+
+## Parameters
+
+### release
+
+[`Release`](../../../release/contract/interfaces/Release.md)
+
+The version of the release, the folder of the repo, the platform and the log.
+
+### plan
+
+[`NpmPlan`](../interfaces/NpmPlan.md)
+
+The packages that publish, in order.
+
+### options
+
+`Pick`\<[`NpmOptions`](../../interfaces/NpmOptions.md), `"moving"` \| `"publisher"` \| `"registry"`\>
+
+The dist-tags, the publisher and the registry.
+
+## Returns
+
+`Promise`\<[`MovedRelease`](../interfaces/MovedRelease.md)\>
+
+What was moved, and what was skipped, of each package and each dist-tag.

package/api/@wtf/release-npm/release/functions/packRelease.md

@@ -0,0 +1,39 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-npm/release](../README.md) / packRelease
+
+# Function: packRelease()
+
+> **packRelease**(`resolved`, `options`): `Promise`\<[`PackedRelease`](../interfaces/PackedRelease.md)\>
+
+Defined in: [packages/release-npm/src/release.ts:450](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L450)
+
+Packs the packages of a release, of the manifests [resolvePlan](resolvePlan.md) gave: each package's folder
+copied, but its `node_modules`, into a temporary folder of the platform, its manifest as it
+publishes written into the copy, and each packed there by a publisher that packs, all before the
+first publish. The repo is left as it is. The copies and the tarballs stay until `cleanup`, and
+the tarballs of a `tarballDir` the caller names after it too; of a pack that fails, they are
+removed.
+
+## Parameters
+
+### resolved
+
+[`ResolvedRelease`](../interfaces/ResolvedRelease.md)
+
+The packages of the release, of [resolvePlan](resolvePlan.md).
+
+### options
+
+[`PackOptions`](../interfaces/PackOptions.md)
+
+The publisher, the folder of the repo, the platform, the folder of the
+tarballs, and the log.
+
+## Returns
+
+`Promise`\<[`PackedRelease`](../interfaces/PackedRelease.md)\>
+
+The packages packed, their copies and their tarballs, and how each goes.

package/api/@wtf/release-npm/release/functions/prepareRelease.md

@@ -0,0 +1,46 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-npm/release](../README.md) / prepareRelease
+
+# Function: prepareRelease()
+
+> **prepareRelease**(`release`, `plan`, `options`): `Promise`\<readonly `string`[]\>
+
+Defined in: [packages/release-npm/src/release.ts:1087](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L1087)
+
+Prepares a release: each manifest of its plan resolved as it publishes and checked
+([resolvePlan](resolvePlan.md)), each package packed from a copy in a temporary folder of the platform
+([packRelease](packRelease.md)), and the registry asked ([publishedOf](publishedOf.md)), so a range of no version, a
+package that cannot be packed, or a release below the version its dist-tag points at on the
+registry (`EPUBLISHBEHIND`) fails before anything is published. What it packed is kept, of the
+folder of the repo, the version and the packages, for `smoke` and `publish` of the same process;
+of a step that fails, it is removed. Nothing of npm is committed: it writes no file of the repo,
+and gives none.
+
+## Parameters
+
+### release
+
+[`Release`](../../../release/contract/interfaces/Release.md)
+
+The version of the release, the folder of the repo, the platform and the log.
+
+### plan
+
+[`NpmPlan`](../interfaces/NpmPlan.md)
+
+The packages that publish, in order, and the versions of the repo.
+
+### options
+
+[`NpmOptions`](../../interfaces/NpmOptions.md)
+
+The options of the release.
+
+## Returns
+
+`Promise`\<readonly `string`[]\>
+
+No file: none of npm is committed, as the version is the release's alone.

package/api/@wtf/release-npm/release/functions/publishPacked.md

@@ -6,13 +6,18 @@
 
 # Function: publishPacked()
 
-> **publishPacked**(`packed`, `run`): `Promise`\<[`PublishedTrain`](../interfaces/PublishedTrain.md)\>
-
-Defined in: [packages/release-npm/src/release.ts:838](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/release.ts#L838)
-
-Publishes a release [packTrain](packTrain.md) packed, by [publishTrain](publishTrain.md), and removes what it packed:
-every tarball, of a `tarballDir` named too, of a publish that fails, whose error is the one
-thrown, as a release that failed has no assets; the copies, and the tarballs but of a
+> **publishPacked**(`packed`, `run`): `Promise`\<[`PublishedRelease`](../interfaces/PublishedRelease.md)\>
+
+Defined in: [packages/release-npm/src/release.ts:707](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L707)
+
+Publishes the packages [packRelease](packRelease.md) packed, each in order, under the first dist-tag of
+`moving`, with the provenance of the build where the CI gives an ID token, and skips each the
+registry has at the version already; then points each other dist-tag of `moving` at the version,
+of each package, as [moveRelease](moveRelease.md) does, and of a package aside each other of
+`aside.moving`. Before the first, it asks the registry by [publishedOf](publishedOf.md): `EPUBLISHBEHIND`
+of a release that would move a dist-tag back, and nothing published. It removes what it packed
+after: every tarball, of a `tarballDir` named too, of a publish that fails, whose error is the
+one thrown, as a release that failed has no assets; the copies, and the tarballs but of a
 `tarballDir` named, of one that passes. A copy that cannot be removed then fails nothing: the log
 says where it stays.
 
@@ -20,18 +25,19 @@ says where it stays.
 
 ### packed
 
-[`PackedTrain`](../interfaces/PackedTrain.md)
+[`PackedRelease`](../interfaces/PackedRelease.md)
 
-The packages of the release, of [packTrain](packTrain.md).
+The packages of the release, of [packRelease](packRelease.md).
 
 ### run
 
 [`PublishRun`](../interfaces/PublishRun.md)
 
-The access, the provenance, the registry, the system and the log of the publish.
+The dist-tags, the access, the provenance, the registry, the packages of `aside`,
+the platform and the log of the publish.
 
 ## Returns
 
-`Promise`\<[`PublishedTrain`](../interfaces/PublishedTrain.md)\>
+`Promise`\<[`PublishedRelease`](../interfaces/PublishedRelease.md)\>
 
 What was published, and what was skipped, of each package.

package/api/@wtf/release-npm/release/functions/publishRelease.md

@@ -0,0 +1,44 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release-npm/release](../README.md) / publishRelease
+
+# Function: publishRelease()
+
+> **publishRelease**(`release`, `plan`, `options`): `Promise`\<readonly [`Released`](../../../release/forge/interfaces/Released.md)[]\>
+
+Defined in: [packages/release-npm/src/release.ts:1177](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L1177)
+
+Publishes a release: what `prepare` packed of it in this process, or its plan resolved and packed
+anew ([resolvePlan](resolvePlan.md), [packRelease](packRelease.md)), each package published in order by
+[publishPacked](publishPacked.md), each the registry has already skipped, so a publish run again finishes a
+release; and what it packed removed, the tarballs of a `tarballDir` kept. Of a dry run, the
+publisher says what it would publish, and publishes nothing.
+
+## Parameters
+
+### release
+
+[`Release`](../../../release/contract/interfaces/Release.md)
+
+The version of the release, the folder of the repo, the platform and the log.
+
+### plan
+
+[`NpmPlan`](../interfaces/NpmPlan.md)
+
+The packages that publish, in order, and the versions of the repo.
+
+### options
+
+[`NpmOptions`](../../interfaces/NpmOptions.md)
+
+The options of the release.
+
+## Returns
+
+`Promise`\<readonly [`Released`](../../../release/forge/interfaces/Released.md)[]\>
+
+Each package published, or found published, and each of `pack`: its page, its registry
+and, of a `tarballDir`, its tarball.

package/api/@wtf/release-npm/release/functions/publishedOf.md

@@ -8,30 +8,31 @@
 
 > **publishedOf**(`packed`, `run`): `Promise`\<[`PublishedOf`](../interfaces/PublishedOf.md)\>
 
-Defined in: [packages/release-npm/src/release.ts:510](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-npm/src/release.ts#L510)
+Defined in: [packages/release-npm/src/release.ts:562](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release-npm/src/release.ts#L562)
 
 The packages of a packed release that the registry has at its version already, by name, asked by
-the publisher's [Publisher.lookup](../../interfaces/Publisher.md#lookup), a few at a time; and, of a publisher that reads
-dist-tags, `EPUBLISHBEHIND` of a package it has not whose dist-tag points above the release, as
-of an older release published after a newer one, which would move the dist-tag back, but of a
-package of `aside`, which goes under the dist-tag of its line, unless that points above it too. A
-package it has is no fault: an older release run again, all of it on the registry, publishes
-nothing. The plugin asks it in `prepare`, before the tag, and [publishTrain](publishTrain.md) before the
-first publish.
+the publisher's [Publisher.lookup](../../interfaces/Publisher.md#lookup), a few at a time, of the first dist-tag of `moving`;
+and, of a publisher that reads dist-tags, `EPUBLISHBEHIND` of a package it has not whose dist-tag
+points above the release, as of an older release published after a newer one, which would move
+the dist-tag back, but of a package of `aside`, which goes under the dist-tags of `aside.moving`,
+unless the first of them points above it too. A package it has is no fault: an older release run
+again, all of it on the registry, publishes nothing. [prepareRelease](prepareRelease.md) asks it, before
+anything is published, and [publishPacked](publishPacked.md) before the first publish.
 
 ## Parameters
 
 ### packed
 
-[`LookedUpTrain`](../type-aliases/LookedUpTrain.md)
+[`LookedUpRelease`](../type-aliases/LookedUpRelease.md)
 
-The release asked of: its packages, its version, its dist-tag and its publisher.
+The release asked of: its packages, its version and its publisher.
 
 ### run
 
 [`PublishRun`](../interfaces/PublishRun.md)
 
-The registry, the packages of `aside`, the system and the log the run asks by.
+The dist-tags, the registry, the packages of `aside`, the platform and the log the
+run asks by.
 
 ## Returns