Merge pull request #490 from bandada-infra/chore/automatic-releases

Update release workflow to publish packages automatically

.github/workflows/release.yml

@@ -6,7 +6,7 @@ permissions:
 on:
     push:
         tags:
-            - "v*"
+            - "*"
 
 jobs:
     release:
@@ -24,9 +24,20 @@ jobs:
                   cache: yarn
                   registry-url: "https://registry.npmjs.org"
 
+            - name: Authentication
+              run: |
+                  echo npmAuthToken: "$NODE_AUTH_TOKEN" >> ./.yarnrc.yml
+                  env:
+                      NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
             - name: Install dependencies
               run: yarn
 
+            - name: Publish packages
+              run: yarn version:publish
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
             - run: yarn version:release
               env:
                   GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

README.md

@@ -325,3 +325,31 @@ yarn commit
 ```
 
 The command will automatically verify that the modified files adhere to the rules of ESLint and Prettier.
+
+### Releases
+
+Steps:
+
+1. Bump a new version with:
+
+```bash
+yarn version:bump <version>
+# e.g. yarn version:bump 2.0.0
+```
+
+This step creates a commit and a git tag.
+
+2. Push the changes to main:
+
+```bash
+git push origin main
+```
+
+3. Push the new git tag:
+
+```bash
+git push origin <version>
+# e.g. git push origin 2.0.0
+```
+
+After pushing the new git tag, a workflow will be triggered and will publish the Bandada packages on [npm](https://www.npmjs.com/) and release a new version on Github with its changelogs automatically.