npm.io
1.0.1 • Published 1 week ago

@changesets/write

Licence
MIT
Version
1.0.1
Deps
3
Size
4 kB
Vulns
0
Weekly
0
Stars
12.3K

@changesets/write

Writes a changeset to a file.

import { writeChangeset } 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 writeChangeset(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.