unit tests are deprecated and skipped at workflows - update README.md #987
Workflow file for this run
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: Test and Release | |
| # Run this job on all pushes and pull requests | |
| # as well as tags with a semantic version | |
| on: | |
| push: | |
| branches: | |
| - "*" | |
| tags: | |
| # normal versions | |
| - "v[0-9]+.[0-9]+.[0-9]+" | |
| # pre-releases | |
| - "v[0-9]+.[0-9]+.[0-9]+-**" | |
| pull_request: {} | |
| jobs: | |
| # Performs quick checks before the expensive test runs | |
| check-and-lint: | |
| if: contains(github.event.head_commit.message, '[skip ci]') == false | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [20.x] # This should be LTS | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Use 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: Perform a type check | |
| run: npm run check | |
| env: | |
| CI: true | |
| - name: Lint TypeScript code | |
| run: npm run lint | |
| # =================== | |
| # Runs unit tests on all supported node versions and OSes | |
| unit-tests: | |
| if: contains(github.event.head_commit.message, '[skip ci]') == false | |
| needs: [check-and-lint] | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| node-version: [18.x, 20.x, 22.x] | |
| os: [ubuntu-latest] | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Use 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 component tests | |
| run: npm run test | |
| env: | |
| CI: true | |
| # =================== | |
| # Deploys the final package to NPM | |
| deploy: | |
| # Trigger this step only when a commit on master is tagged with a version number | |
| if: | | |
| contains(github.event.head_commit.message, '[skip ci]') == false && | |
| github.event_name == 'push' && | |
| startsWith(github.ref, 'refs/tags/v') | |
| needs: [unit-tests] | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [20.x] # This should be LTS | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Use 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: Create a clean build | |
| run: npm run build | |
| - name: Publish package to npm | |
| run: | | |
| npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }} | |
| npm whoami | |
| npm publish |