From ad6a35629a539bd4cdab36b70137192e6ee7c5f7 Mon Sep 17 00:00:00 2001 From: Joe Cowton <77005274+joecowton1@users.noreply.github.com> Date: Mon, 22 Jan 2024 16:53:50 +0000 Subject: [PATCH] Update README.md with changesets description (#1094) update readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 688c0e05c..fd86cf9e8 100644 --- a/README.md +++ b/README.md @@ -196,6 +196,14 @@ SKIP_NX_CACHE=true make test To run Chromatic (for visual regression testing) on a PR, add the `run_chromatic` label to the PR in Github. The Chromatic tests are required to pass by CI, so this will _need_ to be done at least once before a PR is merged. We recommend you only add the label once you are happy with any changes made and have checked for visual regressions manually first. +### Releasing a package + +Libs within CSNX are available as NPM packages. We use [Changesets](<[url](https://github.com/changesets/changesets)>) to automate this release process. + +To publish your changes to NPM, run `make changeset`. This will open the Changesets CLI, and you will be offered a list of packages to release. Once you've selected the changed package/s you'll be given the option of `major`, `minor` or `patch` release. Select one of these and add a description. + +This will create a "changeset": a `.md` file containing the release information. When you merge your branch, the changeset will be picked up by the Changests GHA, which will in turn create a release PR. To complete the NPM release merge this second PR. + ## Troubleshooting ### Unable to commit