Skip to content

chore: add readme

chore: add readme #9

Workflow file for this run

name: CI Workflow
on:
push:
branches:
- "develop/*"
- "version/*"
pull_request:
branches:
- "develop/*"
- "version/*"
types:
- opened
- synchronize
jobs:
build-and-test:
name: Build and Test
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18.x, 20.x, 22.x]
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- name: Install dependencies
run: npm install
- name: Build project
run: npm run build
- name: Lint code
run: npm run lint
- name: Run tests
run: npm run test
env:
CI: true
- name: Upload coverage report
if: always()
uses: actions/upload-artifact@v4
with:
name: coverage-report-${{ matrix.node-version }}
path: coverage
analyze:
name: Analyze code with CodeQL
runs-on: ubuntu-latest
needs: build-and-test
permissions:
actions: read
contents: read
security-events: write
strategy:
matrix:
language: [typescript]
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
- name: Autobuild
uses: github/codeql-action/autobuild@v3
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3