feat: update readme #162
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CI | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: {} | |
| release: | |
| types: | |
| - created | |
| jobs: | |
| lint: | |
| name: Lint | |
| runs-on: ubuntu-latest | |
| env: | |
| FORCE_COLOR: 1 | |
| steps: | |
| - name: Setup Code | |
| uses: actions/checkout@v4 | |
| - name: Setup Environment | |
| uses: ./.github/actions/setup | |
| - name: Run Linter | |
| run: npm run lint | |
| test: | |
| name: Test | |
| runs-on: ubuntu-latest | |
| env: | |
| FORCE_COLOR: 1 | |
| steps: | |
| - name: Setup Code | |
| uses: actions/checkout@v4 | |
| - name: Setup Environment | |
| uses: ./.github/actions/setup | |
| - name: Run Test | |
| run: npm test | |
| - name: Check Linearisation | |
| run: npm run check:inheritance | |
| coverage: | |
| name: Coverage | |
| runs-on: ubuntu-latest | |
| env: | |
| FORCE_COLOR: 1 | |
| steps: | |
| - name: Setup Code | |
| uses: actions/checkout@v4 | |
| - name: Setup Environment | |
| uses: ./.github/actions/setup | |
| - name: Run Coverage | |
| run: npm run coverage | |
| - name: Post to Codecov | |
| uses: codecov/codecov-action@v3 | |
| slither: | |
| name: Slither | |
| runs-on: ubuntu-latest | |
| env: | |
| FORCE_COLOR: 1 | |
| steps: | |
| - name: Setup Code | |
| uses: actions/checkout@v4 | |
| - name: Setup Environment | |
| uses: ./.github/actions/setup | |
| - name: Run Slither | |
| uses: crytic/[email protected] | |
| with: | |
| node-version: 18 | |
| codespell: | |
| name: Codespell | |
| runs-on: ubuntu-latest | |
| env: | |
| FORCE_COLOR: 1 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Run CodeSpell | |
| uses: codespell-project/[email protected] | |
| with: | |
| check_hidden: true | |
| check_filenames: true | |
| skip: .git,package-lock.json |