@changesets/get-release-plan

Reads changesets and adds information on dependents that need bumping

  • Types
  • ESM
  • CJS
License
MIT
Install Size
29.9 kB(3.3 MB)
Vulns
0
Published

Get started

$npm install @changesets/get-release-plan
$pnpm add @changesets/get-release-plan
$yarn add @changesets/get-release-plan
$bun add @changesets/get-release-plan
$deno add npm:@changesets/get-release-plan
$vlt install @changesets/get-release-plan
$vp add @changesets/get-release-plan

Readme

@changesets/get-release-plan

npm package View changelog

A function that reads information about the current repository

import getReleasePlan from "@changesets/get-release-plan";

const releasePlan = await getReleasePlan(cwd, since, passedConfig);

cwd: string

The directory to run getReleasePlan in - most often process.cwd()

since: string

Sets whether to use all changesets present, or only those changesets that are new since the branch diverged from another one.

passedConfig?: Config

The changeset config options as defined in @changesets/types. This is optional, and can be used to overwrite any written config options.