mirror of
https://github.com/cloudflare/wrangler-action.git
synced 2024-10-07 13:03:24 +02:00
44 lines
834 B
Markdown
44 lines
834 B
Markdown
|
# @changesets/write
|
||
|
|
||
|
Writes a changeset to a file.
|
||
|
|
||
|
```js
|
||
|
import write from "@changesets/write";
|
||
|
|
||
|
const changeset = {
|
||
|
summary: "A description of a minor change",
|
||
|
releases: [
|
||
|
{ name: "@changesets/something", type: "minor" },
|
||
|
{ name: "@changesets/something-else", type: "patch" },
|
||
|
],
|
||
|
};
|
||
|
|
||
|
const uniqueId = await write(changeset, cwd);
|
||
|
console.log(uniqueId); // orange-foxes-waggle
|
||
|
```
|
||
|
|
||
|
For example, it can convert:
|
||
|
|
||
|
```json
|
||
|
{
|
||
|
"summary": "A description of a minor change",
|
||
|
"releases": [
|
||
|
{ "name": "@changesets/something", "type": "minor" },
|
||
|
{ "name": "@changesets/something-else", "type": "patch" }
|
||
|
]
|
||
|
}
|
||
|
```
|
||
|
|
||
|
to
|
||
|
|
||
|
```markdown
|
||
|
---
|
||
|
"@changesets/something": minor
|
||
|
"@changesets/something-else": patch
|
||
|
---
|
||
|
|
||
|
A description of a minor change
|
||
|
```
|
||
|
|
||
|
This package will take care of generating a unique id for the changeset.
|