From d268afed3f82af7178d77f8f2e3cac07d4a5603d Mon Sep 17 00:00:00 2001 From: Himesh Ladva Date: Fri, 16 Feb 2024 13:24:13 +0000 Subject: [PATCH] chore: add documentation for releasing packages (#4) --- .changeset/loud-planets-bathe.md | 2 ++ docs/RELEASE.md | 19 +++++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 .changeset/loud-planets-bathe.md create mode 100644 docs/RELEASE.md diff --git a/.changeset/loud-planets-bathe.md b/.changeset/loud-planets-bathe.md new file mode 100644 index 0000000..a845151 --- /dev/null +++ b/.changeset/loud-planets-bathe.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/docs/RELEASE.md b/docs/RELEASE.md new file mode 100644 index 0000000..2d57ef0 --- /dev/null +++ b/docs/RELEASE.md @@ -0,0 +1,19 @@ +# How to release packages + +Ensure that the pull request contains a created changeset using the command: + +```shell +yarn changeset +``` + +If the changes do not require a release, you can run the following to generate an empty changeset: + +```shell +yarn changeset --empty +``` + +Once this PR is merged, the Publish workflow will run and create a new PR titled `Version Packages`. This will be kept up to date by the workflow for every new changeset merged to the `main` branch. + +To create a new release and publish a new version of any packages, you must merge this PR into `main`. + +Once the Publish workflow has run again, the new version will be available on NPM.