github actions workflow

Author: rathboma

.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: Run Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+        # See supported Node.js versions at https://nodejs.org/en/about/releases/
+    
+    services:
+      # We don't actually need this service since we use testcontainers
+      # but having it here ensures Docker is available for testcontainers
+      registry:
+        image: registry:2
+        ports:
+          - 5000:5000
+    
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    
+    - name: Install dependencies
+      run: npm ci
+    
+    - name: Run tests
+      run: npm test
+      env:
+        # This ensures testcontainers can find Docker
+        TESTCONTAINERS_HOST_OVERRIDE: "localhost"
+      
+    - name: TypeCheck
+      run: npm run typecheck
+      
+    - name: Build package
+      run: npm run build

README.md

@@ -117,6 +117,21 @@ These tests will:
 4. Verify the results
 5. Clean up the container when done
 
+### Continuous Integration
+
+This project uses GitHub Actions for continuous integration. The CI workflow automatically runs on:
+- All pushes to the `main` branch
+- All pull requests targeting the `main` branch
+
+The CI workflow:
+1. Sets up Node.js (versions 16.x, 18.x, and 20.x)
+2. Installs dependencies
+3. Runs all tests (including integration tests with MongoDB in a Docker container)
+4. Performs type checking
+5. Builds the package
+
+You can see the workflow configuration in `.github/workflows/test.yml`.
+
 ## License
 
 AGPL-3.0

package.json

@@ -9,6 +9,7 @@
     "build": "npm run clean && tsc",
     "test": "jest",
     "test:integration": "jest src/__tests__/integration.integration.test.ts --runInBand",
+    "typecheck": "tsc --noEmit",
     "dev": "ts-node src/index.ts",
     "example": "ts-node src/examples/basic-usage.ts"
   },