feat(ci): adds more CI validations, introduces semantic release (#74)

- Adds eslint check on before commit and in CI
- Adds commit lint in CI for main
- Uses semantic release

.eslintrc.json

@@ -12,6 +12,15 @@
   },
   "plugins": ["@typescript-eslint"],
   "rules": {
-    "@typescript-eslint/no-unused-vars": ["error", { "ignoreRestSiblings": true }]
-  }
+    "@typescript-eslint/no-unused-vars": ["error", { "ignoreRestSiblings": true }],
+    "@typescript-eslint/no-explicit-any": "warn"
+  },
+  "overrides": [
+    {
+      "files": ["*.js"],
+      "rules": {
+        "@typescript-eslint/no-var-requires": "off"
+      }
+    }
+  ]
 }

.github/workflows/commit-lint-reusable.yml

@@ -0,0 +1,36 @@
+name: Commit Lint
+
+on:
+  - workflow_call
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  HUSKY: 0
+
+jobs:
+  duplicate-check:
+    name: Duplicate Run Check
+    runs-on: ubuntu-latest
+    outputs:
+      should_skip: ${{ steps.skip_check.outputs.should_skip }}
+    steps:
+      - id: skip_check
+        uses: fkirc/skip-duplicate-actions@v5
+        with:
+          concurrent_skipping: 'never'
+          skip_after_successful_duplicate: 'true'
+
+  commit-lint:
+    name: Validate PR commits with commitlint
+    needs: duplicate-check
+    if: needs.duplicate-check.outputs.should_skip != 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Validate PR commits with commitlint
+        uses: wagoid/commitlint-github-action@v6

.github/workflows/commit-lint.yml

@@ -0,0 +1,10 @@
+name: Commit Lint Feature Check
+
+on:
+  - pull_request
+
+jobs:
+  commit-lint:
+    name: Main
+    uses: ./.github/workflows/commit-lint-reusable.yml
+    secrets: inherit

.github/workflows/lint-reusable.yml

@@ -0,0 +1,59 @@
+name: Lint
+
+on:
+  - workflow_call
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  HUSKY: 0
+
+jobs:
+  duplicate-check:
+    name: Duplicate Run Check
+    runs-on: ubuntu-latest
+    outputs:
+      should_skip: ${{ steps.skip_check.outputs.should_skip }}
+    steps:
+      - id: skip_check
+        uses: fkirc/skip-duplicate-actions@v5
+        with:
+          concurrent_skipping: 'never'
+          skip_after_successful_duplicate: 'true'
+
+  lint:
+    name: Lint
+    needs: duplicate-check
+    if: needs.duplicate-check.outputs.should_skip != 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        id: setup_node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.0.0
+
+      - name: Restore node_modules cache
+        id: deps-cache
+        uses: martijnhols/actions-cache/restore@v3
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-build-ts-deps-cache-${{ hashFiles('ts/package-lock.json') }}
+
+      - name: Install dependencies
+        if: steps.deps-cache.outputs.cache-hit != 'true'
+        run: npm install
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Cache node modules
+        if: steps.deps-cache.outputs.cache-hit != 'true'
+        uses: martijnhols/actions-cache/save@v3
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-build-ts-deps-cache-${{ hashFiles('ts/package-lock.json') }}

.github/workflows/lint.yml

@@ -0,0 +1,9 @@
+name: Lint
+
+on:
+  - pull_request
+
+jobs:
+  test:
+    name: Lint
+    uses: ./.github/workflows/lint-reusable.yml

.github/workflows/release.yml

@@ -0,0 +1,62 @@
+name: Release from Master on Push
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  HUSKY: 0
+
+jobs:
+  commit-lint:
+    name: Main
+    uses: ./.github/workflows/commit-lint-reusable.yml
+    secrets: inherit
+
+  release:
+    name: Build and release npm package
+    needs: commit-lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+        with:
+          ref: main
+
+      - name: Fetch other branches for commitlint
+        run: git fetch --prune --unshallow
+
+      - name: Setup Node.js
+        if: steps.changes.outputs.ts == 'true'
+        uses: actions/setup-node@v4
+        with:
+        node-version: 18.0.0
+        cache: npm
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Validate PR commits with commitlint
+        uses: wagoid/commitlint-github-action@v6
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Test
+        run: npm run test:cov
+
+      - name: Release npm package
+        uses: cycjimmy/semantic-release-action@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Upload Test Coverage
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./ts/coverage
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/test-reusable.yml

@@ -0,0 +1,65 @@
+name: Test
+
+on:
+  - workflow_call
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  HUSKY: 0
+
+jobs:
+  duplicate-check:
+    name: Duplicate Run Check
+    runs-on: ubuntu-latest
+    outputs:
+      should_skip: ${{ steps.skip_check.outputs.should_skip }}
+    steps:
+      - id: skip_check
+        uses: fkirc/skip-duplicate-actions@v5
+        with:
+          concurrent_skipping: 'never'
+          skip_after_successful_duplicate: 'true'
+
+  test:
+    name: Test and report coverage
+    needs: duplicate-check
+    if: needs.duplicate-check.outputs.should_skip != 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        id: setup_node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.0.0
+
+      - name: Restore node_modules cache
+        id: deps-cache
+        uses: martijnhols/actions-cache/restore@v3
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-build-ts-deps-cache-${{ hashFiles('ts/package-lock.json') }}
+
+      - name: Install dependencies
+        if: steps.deps-cache.outputs.cache-hit != 'true'
+        run: npm install
+
+      - name: Test
+        run: npm run test:cov
+
+      - name: Upload Test Coverage
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./ts/coverage
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Cache node modules
+        if: steps.deps-cache.outputs.cache-hit != 'true'
+        uses: martijnhols/actions-cache/save@v3
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-build-ts-deps-cache-${{ hashFiles('ts/package-lock.json') }}

.github/workflows/test.yml

@@ -0,0 +1,9 @@
+name: Test
+
+on:
+  - pull_request
+
+jobs:
+  test:
+    name: Test and report coverage
+    uses: ./.github/workflows/test-reusable.yml

.gitignore

@@ -7,6 +7,7 @@ umd/
 
 # Coverage directory
 .nyc_output/
+coverage
 
 # Log files
 yarn-error.log

.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit $1

.releaserc

@@ -0,0 +1,31 @@
+{
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/changelog",
+      {
+        "changelogFile": "CHANGELOG.md"
+      }
+    ],
+    [
+      "@semantic-release/npm",
+      {
+        "tarballDir": "package"
+      }
+    ],
+    [
+      "@semantic-release/github",
+      {
+        "assets": "package/*.tgz"
+      }
+    ],
+    "@semantic-release/git"
+  ],
+  "branches": [
+    {
+      "name": "main"
+    }
+  ],
+  "preset": "conventionalcommits"
+}