From ee1d4e1e14146b1c48ea265a8e54081ce7f0101b Mon Sep 17 00:00:00 2001 From: csett86 Date: Tue, 16 Nov 2021 21:43:01 +0100 Subject: [PATCH] README: add publishing docs (#667) --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 7088dfe..61374ff 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,18 @@ npm install @jitsi/electron-sdk --force NOTE: Also check the [jitsi-meet-electron-sdk README] to see how to configure your environment. +#### Publishing + +1. Create release branch: `git checkout -b release-1-2-3`, replacing 1-2-3 with the desired release version +2. Increment the version: `npm version patch`, replacing `patch` with `minor` or `major` as required +3. Push release branch to github: `git push -u origin release-1-2-3` +4. Create PR: `gh pr create` +5. Once PR is reviewed and ready to merge, create draft Github release: `gh release create v1.2.3 --draft --title 1.2.3`, replacing v1.2.3 and 1.2.3 with the desired release version +6. Merge PR +7. Github action will build binaries and attach to the draft release +8. Test binaries from draft release +9. If all tests are fine, publish draft release + ## Known issues