wrangler-action/node_modules/@changesets/write/README.md
2023-08-07 15:11:15 -05:00

834 B

@changesets/write

Writes a changeset to a file.

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:

{
  "summary": "A description of a minor change",
  "releases": [
    { "name": "@changesets/something", "type": "minor" },
    { "name": "@changesets/something-else", "type": "patch" }
  ]
}

to

---
"@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.