Skip to content

Update README.md

Update README.md #2

Workflow file for this run

name: CI
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]
jobs:
test:
name: Test (Node ${{ matrix.node-version }})
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18, 20, 22]
fail-fast: false
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Run linter
run: npm run lint --if-present
- name: Build
run: npm run build --if-present
- name: Run tests
run: npm test
- name: Run tests with coverage
if: matrix.node-version == 20
run: npm run test:coverage --if-present || npm test -- --coverage
- name: Upload coverage to Codecov
if: matrix.node-version == 20
uses: codecov/codecov-action@v3
with:
files: ./coverage/lcov.info
fail_ci_if_error: false
typecheck:
name: TypeScript Check
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Type check core package
run: npx tsc --noEmit -p packages/core/tsconfig.json
- name: Type check openai package
run: npx tsc --noEmit -p packages/openai/tsconfig.json
- name: Type check cli package
run: npx tsc --noEmit -p packages/cli/tsconfig.json
security:
name: Security Audit
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Run security audit
run: npm audit --audit-level=moderate
continue-on-error: true
demo:
name: Demo Verification
runs-on: ubuntu-latest
needs: [test, typecheck]
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Run demo
run: npx ts-node examples/demo/index.ts
- name: Verify generated log
run: npx ts-node packages/cli/src/index.ts verify examples/demo/output/audit-log.json