wrangler-action/node_modules/@changesets/get-release-plan/README.md

25 lines
783 B
Markdown
Raw Normal View History

2023-08-07 22:11:15 +02:00
# @changesets/get-release-plan
[![View changelog](https://img.shields.io/badge/changelogs.xyz-Explore%20Changelog-brightgreen)](https://changelogs.xyz/@changesets/get-release-plan)
A function that reads information about the current repository
```js
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.