chore: modernize the package (#450) #21
This file contains hidden or 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
| # This is a composition of lint and test scripts | |
| name: Test and Release | |
| # Run this job on all pushes and pull requests | |
| # as well as tags with a semantic version | |
| on: | |
| push: | |
| branches: | |
| - master | |
| tags: | |
| # normal versions | |
| - "v[0-9]+.[0-9]+.[0-9]+" | |
| # pre-releases | |
| - "v[0-9]+.[0-9]+.[0-9]+-**" | |
| pull_request: {} | |
| permissions: | |
| id-token: write # Required for publishing with OIDC | |
| contents: write # Required for creating releases | |
| jobs: | |
| # Performs quick checks before the expensive test runs | |
| check-and-lint: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [24] | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Use Node.js ${{ matrix.node-version }} | |
| uses: actions/setup-node@v6 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: 'npm' | |
| - name: Install dependencies | |
| run: npm ci | |
| - name: Lint TypeScript code | |
| run: npm run lint | |
| - name: Compile TypeScript code | |
| run: npm run build | |
| # =================== | |
| # Runs unit tests on all supported node versions and OSes | |
| unit-tests: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [22, 24] | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Use Node.js ${{ matrix.node-version }} | |
| uses: actions/setup-node@v6 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: 'npm' | |
| - name: Install dependencies | |
| run: npm ci | |
| - name: Run component tests | |
| # Some tests are flaky, try them 3 times if necessary | |
| run: npm run test:ts || npm run test:ts || npm run test:ts | |
| 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: | | |
| github.event_name == 'push' && | |
| startsWith(github.ref, 'refs/tags/v') | |
| needs: [check-and-lint, unit-tests] | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [24] | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v6 | |
| - name: Use Node.js ${{ matrix.node-version }} | |
| uses: actions/setup-node@v6 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: 'npm' | |
| - name: Extract the version and commit body from the tag | |
| id: extract_release | |
| # The body may be multiline, therefore we need to escape some characters | |
| run: | | |
| VERSION="${{ github.ref }}" | |
| VERSION=${VERSION##*/v} | |
| echo "VERSION=$VERSION" >> $GITHUB_OUTPUT | |
| EOF=$(od -An -N6 -x /dev/urandom | tr -d ' ') | |
| BODY=$(git show -s --format=%b) | |
| echo "BODY<<$EOF" >> $GITHUB_OUTPUT | |
| echo "$BODY" >> $GITHUB_OUTPUT | |
| echo "$EOF" >> $GITHUB_OUTPUT | |
| if [[ $VERSION == *"-"* ]] ; then | |
| echo "TAG=--tag next" >> $GITHUB_OUTPUT | |
| fi | |
| - name: Install dependencies | |
| run: npm ci | |
| - name: Create a clean build | |
| run: npm run build | |
| - name: Publish package to npm | |
| run: npm publish ${{ steps.extract_release.outputs.TAG }} | |
| - name: Create Github Release | |
| uses: softprops/action-gh-release@v2 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| tag_name: ${{ github.ref }} | |
| name: Release v${{ steps.extract_release.outputs.VERSION }} | |
| draft: false | |
| # Prerelease versions create prereleases on Github | |
| prerelease: ${{ contains(steps.extract_release.outputs.VERSION, '-') }} | |
| body: ${{ steps.extract_release.outputs.BODY }} |