ci(workflows): [ci] add commitlint job

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

Author: unicornware

.github/workflows/ci.yml

@@ -38,6 +38,7 @@ env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   HUSKY: 0
   REF: ${{ github.head_ref || github.ref_name }}
+  SHA: ${{ github.event.pull_request.head.sha || github.sha }}
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
@@ -82,9 +83,38 @@ jobs:
       - id: version-typescript
         name: Get TypeScript version
         run: echo "result=$(jq .devDependencies.typescript package.json -r)" >> $GITHUB_OUTPUT
-  gitguardian:
+  commitlint:
     needs: metadata
     runs-on: ubuntu-latest
+    steps:
+      - id: checkout
+        name: Checkout ${{ env.REF }}
+        uses: actions/checkout@v3.3.0
+        with:
+          fetch-depth: 0
+          ref: ${{ env.REF }}
+      - id: node
+        name: Setup Node.js
+        uses: actions/setup-node@v3.6.0
+        with:
+          cache: yarn
+          cache-dependency-path: yarn.lock
+          node-version-file: .nvmrc
+      - id: cache
+        name: Restore dependencies cache
+        uses: actions/cache@v3.2.6
+        with:
+          key: ${{ runner.os }}-${{ github.run_id }}
+          path: ${{ env.CACHE_PATH }}
+      - id: build
+        name: Build project
+        run: yarn build
+      - id: lint
+        name: Check commitlint status
+        run: yarn commitlint --from $SHA~${{ github.event.pull_request.commits || 1 }} --to $SHA
+  gitguardian:
+    needs: commitlint
+    runs-on: ubuntu-latest
     steps:
       - id: checkout
         name: Checkout ${{ env.REF }}
@@ -104,7 +134,7 @@ jobs:
           GITHUB_PUSH_BASE_SHA: ${{ github.event.base }}
           GITHUB_PUSH_BEFORE_SHA: ${{ github.event.before }}
   format:
-    needs: metadata
+    needs: commitlint
     runs-on: ubuntu-latest
     steps:
       - id: checkout
@@ -129,7 +159,7 @@ jobs:
         name: Check code formatting
         run: yarn check:format
   lint:
-    needs: metadata
+    needs: commitlint
     runs-on: ubuntu-latest
     steps:
       - id: checkout
@@ -157,7 +187,7 @@ jobs:
         name: Check lint status
         run: yarn check:lint
   spelling:
-    needs: metadata
+    needs: commitlint
     runs-on: ubuntu-latest
     steps:
       - id: checkout
@@ -182,7 +212,9 @@ jobs:
         name: Check spelling
         run: yarn check:spelling
   typescript:
-    needs: metadata
+    needs:
+      - commitlint
+      - metadata
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -229,7 +261,7 @@ jobs:
         name: Run typecheck
         run: yarn typecheck
   test:
-    needs: metadata
+    needs: commitlint
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -271,18 +303,20 @@ jobs:
           flags: ${{ format('node{0}', matrix.node-version) }}
           override_branch: ${{ env.REF }}
           override_build: ${{ github.run_id }}
-          override_commit: ${{ env.GITHUB_SHA }}
+          override_commit: ${{ env.SHA }}
           token: ${{ secrets.CODECOV_TOKEN }}
           verbose: true
         env:
           GITHUB_JOB: ${{ github.job }}
           GITHUB_REF: ${{ github.ref }}
           GITHUB_REF_TYPE: ${{ github.ref_type }}
           GITHUB_RUN_ID: ${{ github.run_id }}
-          GITHUB_SHA: ${{ github.event.pull_request.head.sha || github.sha }}
+          GITHUB_SHA: ${{ env.SHA }}
           GITHUB_WORKSPACE: ${{ github.workspace }}
   build:
-    needs: metadata
+    needs:
+      - commitlint
+      - metadata
     runs-on: ubuntu-latest
     steps:
       - id: checkout

package.json

@@ -57,6 +57,7 @@
     "clean:test": "yarn clean:coverage && trash ./__tests__/report.json",
     "codecov": "yarn test:cov && yarn test:cov:upload",
     "codecov:validate": "cat .codecov.yml | curl --data-binary @- https://codecov.io/validate",
+    "commitlint": "commitlint --strict --verbose",
     "fix:cg": "yarn fix:format && yarn fix:lint",
     "fix:dedupe": "yarn dedupe --strategy=highest",
     "fix:format": "prettier --cache --write .",