docs: update documentation to make it more easy to pickup #28
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-ignore: | |
| - 'dependabot/**' | |
| pull_request: | |
| env: | |
| FORCE_COLOR: 2 | |
| NODE_COV: 16 # The Node.js version to run coveralls on | |
| permissions: | |
| contents: read | |
| jobs: | |
| run: | |
| permissions: | |
| checks: write # for coverallsapp/github-action to create new checks | |
| contents: read # for actions/checkout to fetch code | |
| name: Node ${{ matrix.node }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| node: | |
| - 16 | |
| - 18 | |
| steps: | |
| - name: Clone repository | |
| uses: actions/checkout@v3 | |
| - name: Setup pnpm | |
| uses: pnpm/[email protected] | |
| with: | |
| version: latest | |
| - name: Set up Node.js | |
| uses: actions/[email protected] | |
| with: | |
| node-version: '${{ matrix.node }}' | |
| cache: 'pnpm' | |
| - name: Install npm dependencies | |
| run: pnpm install | |
| - name: Build dist | |
| run: npm run build | |
| - name: Run test | |
| run: npm run test | |
| if: matrix.node != env.NODE_COV | |
| - name: Run test with coverage | |
| run: npm run test:cov | |
| if: matrix.node == env.NODE_COV | |
| - name: Run Coveralls | |
| uses: coverallsapp/[email protected] | |
| if: matrix.node == env.NODE_COV | |
| continue-on-error: true | |
| with: | |
| github-token: '${{ secrets.GITHUB_TOKEN }}' |