feat: automated release pipeline

.github/workflows/pr.yml

@@ -24,6 +24,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: 18
+          cache: "npm"
       - run: npm ci
 
       - name: Build

.github/workflows/release-please.yml

@@ -0,0 +1,44 @@
+name: Release Package
+
+defaults:
+  run:
+    shell: bash
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release-please.outputs.release_created }}
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        with:
+          release-type: node
+          package-name: code-review-gpt
+  publish-package:
+    runs-on: ubuntu-latest
+    needs: release-please
+    if: ${{ needs.release-please.outputs.release_created  }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+          cache: "npm"
+          registry-url: "https://registry.npmjs.org"
+      - name: 💫 Install dependencies
+        run: npm ci
+      - name: 🏡 Build
+        run: npm run build
+      - name: 🚀 Publish code-review-gpt
+        run: npm publish --access=public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -114,6 +114,14 @@ When used globally you should run `export OPENAI_API_KEY=YOUR_API_KEY` (or simil
 
 See the package.json file for all the npm commands you can run.
 
+5. Make a package release 🎉
+
+We use [release-please](https://github.com/googleapis/release-please) on this project. If you want to create a new release from your PR, please make sure your PR title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format. The release-please bot will automatically create a new release for you when your PR is merged.
+
+- fix: which represents bug fixes, and correlates to a patch version.
+- feat: which represents a new feature, and correlates to a SemVer minor.
+- feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a major version.
+
 ## Roadmap (see projects tab) 🌏
 
 ## Sponsors ❤️