From de6acbe7fe53598ecf60766461e7585e5976f7b8 Mon Sep 17 00:00:00 2001 From: Nathan Vasse Date: Thu, 30 Mar 2023 11:26:09 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D(doc)=20add=20release=20documentati?= =?UTF-8?q?on?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit As I forgot each time at least one task when doing a release, I will no longer have any excuse. And this could be useful to everyone. --- CONTRIBUTING.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc0fea1..735b4c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,4 +77,20 @@ Generally, changes related to these topics can be omitted: - Dev dependencies upgrades - Chores (infrastructure, release process…) -This part of the documentation is 99% inspired by [Polaris](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#adding-a-changeset) \ No newline at end of file +This part of the documentation is 99% inspired by [Polaris](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#adding-a-changeset) + +## Release + +1. Create a new branch from main specific to the release. + +`git checkout -b release/version-packages` + +2. Now run the following command at the root of the repo to bump the version of the packages. + +`yarn changeset version` + +3. Update the upgraded CHANGELOG.md files of the packages to add link to the diff between the previous version and the new one. + +4. Commit the changes and create a PR named "🔖(release) version packages". + +Once this PR is merged, the CI will automatically publish the new version of the packages on npm. It will also create and push release tags.