ci: add updated release process for ITS (#286)

Co-authored-by: Milap Sheth <milap@interoplabs.io>

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.0.3/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/actions/nodejs-ci/action.yaml

@@ -0,0 +1,24 @@
+name: Install node.js dependencues
+description: 'Setup node.js and install dependencies'
+
+inputs:
+  node-version:
+    description: 'The version of node.js CLI to install'
+    required: true
+    default: '18'
+
+runs:
+  using: 'composite'
+
+  steps:
+    - name: Setup Node
+      # TODO: consider while migrating the `setup-node` action later the usage of `blacksmith` actions
+      uses: useblacksmith/setup-node@v5
+      with:
+        node-version: '${{ inputs.node-version }}'
+        cache: 'npm'
+        registry-url: 'https://registry.npmjs.org'
+
+    - name: Install dependencies
+      shell: bash
+      run: npm ci

.github/actions/setup-tools/action.yaml

@@ -0,0 +1,20 @@
+name: Setup tools
+description: 'Setup tools for repo workflows'
+
+inputs:
+  install-nodejs:
+    description: "Install nodejs and setup repo's npm package"
+    required: false
+    default: 'false'
+
+runs:
+  using: 'composite'
+  steps:
+    # This Action bundles other reusable actions in case needed.
+
+    # Install Node.js and its dependencies
+    - name: Setup node.js and install dependencies
+      if: inputs.install-nodejs == 'true'
+      uses: ./.github/actions/nodejs-ci
+      with:
+        node-version: '18' # Version is hardcoded across all other steps to ensure stability of the code, although the `package.json` has `>=18` engine version

.github/workflows/codecov.yaml

@@ -1,11 +1,7 @@
-name: Coverage
+name: Code Coverage
 
 on:
   pull_request:
-  push:
-    branches:
-      - main
-      - releases/**
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -16,17 +12,15 @@ jobs:
     runs-on: blacksmith-2vcpu-ubuntu-2204
 
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-      - name: Install Node.js
-        uses: useblacksmith/setup-node@v5
+      - name: Setup tools
+        uses: ./.github/actions/setup-tools
         with:
-          node-version: 18.x
-          cache: 'npm'
-
-      - name: Install Dependencies
-        run: npm ci
+          install-nodejs: 'true'
 
+      # Step to do builds and check for warnings
       - name: Build
         run: npm run build > build.log 2>&1
 

.github/workflows/conventional-commits.yaml

@@ -9,11 +9,11 @@ concurrency:
 
 jobs:
   ensure-CC:
-    runs-on: ubuntu-latest
+    runs-on: blacksmith-2vcpu-ubuntu-2204
 
     steps:
       - name: semantic-pull-request
-        uses: amannn/action-semantic-pull-request@v3.2.6
+        uses: amannn/action-semantic-pull-request@v5
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

.github/workflows/create-release-pr.yaml

@@ -0,0 +1,68 @@
+# This workflow concerns the preparation of the `changeset` PR and keeping it updated by tracking the changes on `main` branch.
+name: Create Release PR
+
+on:
+  workflow_dispatch:
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  create-release-pr:
+    name: Create Release PR
+    runs-on: blacksmith-2vcpu-ubuntu-2204
+    steps:
+      - name: Check if a branch is whitelisted and maintained
+        id: branch-check
+        run: |
+          BRANCH_NAME="${GITHUB_REF#refs/heads/}"
+          WHITELISTED_BRANCHES=("main" "releases/*")
+
+          IS_WHITELISTED=false
+          # Check the branch against the whitelist using wildcard matching
+          for BRANCH in "${WHITELISTED_BRANCHES[@]}"; do
+            if [[ "$BRANCH_NAME" == $BRANCH ]]; then
+              IS_WHITELISTED=true;
+              break;
+            fi
+          done
+
+          if [ "$IS_WHITELISTED" == true ]; then
+            echo "Branch is whitelisted: $BRANCH_NAME"
+          else
+            echo "Branch $BRANCH_NAME is not whitelisted."
+            exit 1
+          fi
+
+          echo "branch_name=${BRANCH_NAME}" >> "$GITHUB_OUTPUT"
+
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+          ref: ${{ steps.branch-check.outputs.branch_name }}
+
+      - name: Check for changeset files
+        run: |
+          if ! ls .changeset/*.md | grep -q '\.changeset\/[a-z-]\+\.md$'; then
+            echo "No changeset files found. Exiting workflow."
+            exit 1
+          fi
+
+          echo "Changeset files found. Continuing with the workflow."
+
+      - name: Setup tools
+        uses: ./.github/actions/setup-tools
+        with:
+          install-nodejs: 'true'
+
+      # Keep the version of the PRs up-to-date
+      - name: Create Release Pull Request
+        id: release-pr
+        uses: changesets/action@aba318e9165b45b7948c60273e0b72fce0a64eb9 # v1.4.7
+        with:
+          # This branch context is ignored in this step: https://github.com/changesets/action/blob/50750fa876cc1e54c7cb972db5e2f7271fc53d99/src/run.ts#L328, therefore the usage of `branch`
+          branch: ${{ steps.branch-check.outputs.branch_name }}
+          title: 'chore(release): bump version and update changelog'
+          commit: 'chore(release): bump version and update changelog'
+        env:
+          GITHUB_TOKEN: ${{ secrets.PAT_TOKEN }}

.github/workflows/lint.yaml

@@ -1,7 +1,7 @@
 name: Linting
 
 on:
-  - pull_request
+  pull_request:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -12,16 +12,13 @@ jobs:
     runs-on: blacksmith-2vcpu-ubuntu-2204
 
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-      - name: Install Node.js
-        uses: useblacksmith/setup-node@v5
+      - name: Setup tools
+        uses: ./.github/actions/setup-tools
         with:
-          node-version: 18.x
-          cache: 'npm'
-
-      - name: Install Dependencies
-        run: npm ci
+          install-nodejs: 'true'
 
       - name: Lint
         run: npm run lint

.github/workflows/release-snapshot.yaml

@@ -0,0 +1,27 @@
+# This workflow publishes snapshot releases as an npm package. These releases aren't supposed to be reusable in `production` environments.
+# It's triggered manually in case a snapshot release would be needed for testing purposes.
+name: Release Snapshot
+
+on:
+  workflow_dispatch:
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  release-snapshot:
+    name: Release Snapshot
+    runs-on: blacksmith-2vcpu-ubuntu-2204
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: Setup tools
+        uses: ./.github/actions/setup-tools
+        with:
+          install-nodejs: 'true'
+
+      - name: Build and Publish a Snapshot to NPM
+        run: |
+          npm run release-snapshot
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}