From f3eb490bf9c993b8276e0b7688b8c887b09c2e3e Mon Sep 17 00:00:00 2001 From: Can Sahin Date: Sat, 5 Sep 2020 16:01:20 +0300 Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9A=EF=B8=8F=20added=20release?= =?UTF-8?q?=20process=20steps?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- RELEASE_PROCESS.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 RELEASE_PROCESS.md diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md new file mode 100644 index 00000000..296ed4f8 --- /dev/null +++ b/RELEASE_PROCESS.md @@ -0,0 +1,15 @@ +# RELEASE PROCESS + +The release process is **semi-automated**. The generated changelog requires editing to keep it visually appealing and clear for everyone. + +## Step by step + +1. All the development goes into `dev` branch. There are only squash merges allowed there so that its not flooded with everyones commits. +2. Make a PR to `master` from `dev` and if all checks are good then merge with the title `chore: 🔧 releasing x.x.x`. +3. Generate the changelog + - `npm run changelog` +4. Take a look at the previous changelogs and modify the generated changelog accordingly. Delete and organize the commits and move them under internals section if needed. +5. Create the release + - `npm run release` +6. Publish to npm + - `npm run publish:npm`