25 lines
783 B
Plaintext
25 lines
783 B
Plaintext
|
# @changesets/get-release-plan
|
||
|
|
|
||
|
|
[](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.
|