From a43c31245813c34f00876b2aa5b92650f7ade3ca Mon Sep 17 00:00:00 2001 From: Andy Waite Date: Fri, 4 Sep 2020 11:58:36 -0400 Subject: [PATCH 1/2] Clarify release instructions --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3e0cb622..d4f1d135 100644 --- a/README.md +++ b/README.md @@ -129,10 +129,13 @@ This information is for project maintainers: Instructions -- Use [`npm version`](https://docs.npmjs.com/cli/version) to update the version. -- Commit and push the changes. -- Release to npmjs.com by triggering a Shipit deploy -- Create a release on GitHub (Shipit will tag the release automatically). +- Use [`npm version `](https://docs.npmjs.com/cli/version) to update the version in `package.json` and `package-lock.json`. +- Push the changes and the tag with `git push --follow-tags` +- Open new PR corresponding to the new release. +- Once approved, merge the PR. +- Release to npmjs.com by triggering a Shipit deploy of the master branch. +- Visit https://www.npmjs.com/package/@shopify/themekit to confirm the new version is listed. +- Create a release on GitHub. ## License From 1b03cb61d0e40e77e48847e43768e24b9f367fe1 Mon Sep 17 00:00:00 2001 From: Andy Waite Date: Fri, 4 Sep 2020 12:14:56 -0400 Subject: [PATCH 2/2] Combine steps --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index d4f1d135..b63bfd07 100644 --- a/README.md +++ b/README.md @@ -131,8 +131,7 @@ Instructions - Use [`npm version `](https://docs.npmjs.com/cli/version) to update the version in `package.json` and `package-lock.json`. - Push the changes and the tag with `git push --follow-tags` -- Open new PR corresponding to the new release. -- Once approved, merge the PR. +- Open new PR corresponding to the new release, and merge once approved. - Release to npmjs.com by triggering a Shipit deploy of the master branch. - Visit https://www.npmjs.com/package/@shopify/themekit to confirm the new version is listed. - Create a release on GitHub.