ChainSafe / engineering-handbook

ChainSafe Engineering Handbook
https://handbook.chainsafe.io
Apache License 2.0
6 stars 2 forks source link

feat: npm release flow #14

Closed mpetrunic closed 2 years ago

mpetrunic commented 2 years ago

Tldr. Github action configuration to make releasing npm packages more streamlined and hassle-free while also keeping it consistent.

Flow:

  1. open PR with semantic title
  2. squash and merge that PR will trigger "release PR" (version is determined by semantic commits on default branch created automatically from semantic PR titles)
  3. merging "release PR" will create Github release and publish on npm

It's is greatly inspired by protocol labs releases with few modifications:

Github action will maintain release PR with version bumps and changelog updates and once team merges it will cut release.

Also works on monorepos: https://github.com/ChainSafe/filsnap/pull/137

render[bot] commented 2 years ago

Your Render PR Server URL is https://engineering-handbook-pr-14.onrender.com.

Follow its progress at https://dashboard.render.com/static/srv-c92pkj3ru51r15umq8mg.

mpetrunic commented 2 years ago

You can see how the npm release process look like here: https://github.com/mpetrunic/npm-automatic-release