Skip to content

Update README.md

Update README.md #15

Workflow file for this run

name: CI
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
setup:
runs-on: ubuntu-latest
outputs:
node-version: ${{ steps.set-node.outputs.node }}
steps:
- name: Define Node version
id: set-node
run: echo "node=20" >> "$GITHUB_OUTPUT"
build:
needs: setup
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Node.js ${{ needs.setup.outputs.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ needs.setup.outputs.node-version }}
- name: Install dependencies
run: npm ci
- name: Build TypeScript project
run: npm run build
lint:
needs: setup
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: ${{ needs.setup.outputs.node-version }}
- name: Install dependencies
run: npm ci
- name: Run ESLint
run: npm run lint
format:
needs: setup
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: ${{ needs.setup.outputs.node-version }}
- name: Install dependencies
run: npm ci
- name: Check Prettier formatting
run: npm run format
test:
needs: setup
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: ${{ needs.setup.outputs.node-version }}
- name: Install dependencies
run: npm ci
- name: Run tests with coverage
run: npm test -- --coverage
- name: Display coverage summary
run: npx jest --coverage --coverageReporters=text-summary
- name: Upload coverage report
uses: actions/upload-artifact@v4
with:
name: coverage-report
path: coverage/