feat(ci): configure automated releases with semantic-release

Author: arabold

.clinerules

@@ -1,13 +1,14 @@
 # Cline Custom Instructions
 
-- Always refer to the `README.md` for the latest information on the project.
-- Always refer to `ARCHITECTURE.md` for the latest information on the architecture of the project.
-- Follow programming principles such as DRY, KISS, YAGNI, and SOLID
-- Always use the latest version of the programming language and libraries.
-- Always prefer the simplest solution.
+- ALWAYS refer to the `README.md` for the latest information on the project.
+- ALWAYS refer to `ARCHITECTURE.md` for the latest information on the architecture of the project.
+- ALWAYS Follow programming principles such as DRY, KISS, YAGNI, and SOLID
+- ALWAYS use the latest version of the programming language and libraries.
+- ALWAYS prefer the simplest solution.
 - When importing a relative path, avoid using file extensions like ".js" and ".ts".
-- Always add and update TSDoc for all classes, methods and functions. Focus on functionality and reasoning. Avoid documenting individual parameters or return values if their use can easily be derived from their name.
-- Always format Git commit messages as markdown
+- ALWAYS add and update TSDoc for all classes, methods and functions. Focus on functionality and reasoning. Avoid documenting individual parameters or return values if their use can easily be derived from their name.
+- ALWAYS format Git commit messages as markdown.
+- ALWAYS adhere to the Conventional Commits specification for all Git commit messages
 
 ## Architecture Documentation Guidelines
 

.github/workflows/ci.yml

@@ -0,0 +1,67 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '>=20.0.0' # Match engines requirement in package.json
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run linter
+        run: npm run lint
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    needs: lint # Run after linting passes
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '>=20.0.0'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm run test
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    needs: test # Run after tests pass
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '>=20.0.0'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run build
+        run: npm run build

.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main # Trigger on pushes to the main branch
+
+jobs:
+  release:
+    name: Release to npm and GitHub
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # Needed to push commits/tags back to the repo
+      issues: write # Needed to comment on issues/PRs
+      pull-requests: write # Needed to comment on issues/PRs
+      # id-token: write # Needed for OIDC trusted publishing (if not using NPM_TOKEN)
+    steps:
+      - name: Checkout code
+        # Need fetch-depth: 0 for semantic-release to analyze all relevant commits
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '>=20.0.0' # Match engines requirement in package.json
+          registry-url: 'https://registry.npmjs.org' # Specify npm registry
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run build
+        run: npm run build
+
+      - name: Run semantic-release
+        run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Provided by Actions automatically
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }} # Use a secret stored in GitHub repository settings

.releaserc.json

@@ -0,0 +1,33 @@
+{
+  "branches": ["main"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/changelog",
+      {
+        "changelogFile": "CHANGELOG.md"
+      }
+    ],
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": true,
+        "pkgRoot": "."
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": ["package.json", "CHANGELOG.md"],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ],
+    [
+      "@semantic-release/github",
+      {
+        "assets": []
+      }
+    ]
+  ]
+}