search

gr2m / primer-changesets-cli

The Primer flavored changesets CLI
MIT License
2 stars 0 forks source link

readme

primer-changesets-cli

The Primer flavored changesets CLI

This CLI is a think wrapper around the changesets CLI which adds one additional question:

Which modules have been changed?

Depending on in which repository the CLI is run, it will either suggest a module from primer/react or primer/view_components.

As a result the generated changeset will include a footer. An example changeset file might look like this:

---
"@primer/react": patch
---

SSR-compatibibility fixes.

Changed components: MarkdownEditor, ActionList

Setup for primer/* repository

Install primer-changesets-cli as a dev dependency in your project. Remove @changesets/cli if it is already installed.

npm uninstall @changesets/cli
npm install primer-changesets-cli --save-dev

Usage

The usage remains the same as with @changesets/cli, the binary name is the same:

npx changeset

Updating the patch

For the initial setup, run

npm install
npm run apply-patch

Then

  1. Make your changes directly in node_modules/@changesets/cli/dist/cli.cjs.dev.js
  2. Run npm run update-patch

In order to test the change locally, replace the version of primer-changesets-cli in the primer/* folder's package.json file with a local path

-    "primer-changesets-cli": "2.0.0",
+    "primer-changesets-cli": "file:../../gr2m/primer-changesets-cli",

Then run npx changeset as usual.

Important: if you updated @changesets/cli to a new version, remove the old patch file and update the dependencies in package.json. Replace "dependencies" with all of @changesets/cli's dependencies plus "patch-package": "^7.0.0".

How it works

Unfortunately the the @changeset/cli package is not decomposable, we cannot easily import selected modules from it, inject our additional question, and then compose it together again before running it.

So instead we use patch-package to patch the @changeset/cli package directly in a maintainable way. The changed lines can be seen in the patch/ folder. They get applied using the postinstall script in this package when installing locally.

In order for it to work when running the command with npx primer-changesets-cli later, we copy the patched file from node_modules/@changesets/cli/dist/cli.cjs.dev.js into the local bin.js directly, using the prepublishOnly script.

License

MIT