Build ➤ Test ➤ Publish to NPM #415
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 & Release | |
| # Workflow name based on selected inputs. Fallback to default Github naming when expression evaluates to empty string | |
| run-name: >- | |
| ${{ | |
| inputs.release && inputs.test && 'Build ➤ Test ➤ Publish to NPM' || | |
| inputs.release && !inputs.test && 'Build ➤ Skip Tests ➤ Publish to NPM' || | |
| github.event_name == 'workflow_dispatch' && inputs.test && 'Build ➤ Test' || | |
| github.event_name == 'workflow_dispatch' && !inputs.test && 'Build ➤ Skip Tests' || | |
| '' | |
| }} | |
| on: | |
| # Build on pushes to release branches | |
| push: | |
| branches: [main] | |
| pull_request: | |
| workflow_dispatch: | |
| inputs: | |
| test: | |
| description: 'Run tests' | |
| required: true | |
| default: true | |
| type: boolean | |
| release: | |
| description: 'Publish new release' | |
| required: true | |
| default: false | |
| type: boolean | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read # for checkout | |
| jobs: | |
| build: | |
| name: Lint & Build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: lts/* | |
| cache: npm | |
| - run: npm ci | |
| - run: npm run lint | |
| if: github.event.inputs.test != 'false' | |
| - run: npx ls-engines | |
| if: github.event.inputs.test != 'false' | |
| - run: npm run prepublishOnly | |
| if: github.event.inputs.test != 'false' | |
| - run: npm test -- --coverage --no-threads | |
| env: | |
| GROQ_STORE_TEST_TOKEN: ${{ secrets.GROQ_STORE_TEST_TOKEN }} | |
| test: | |
| name: Test | |
| needs: build | |
| if: github.event.inputs.test != 'false' | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [macos-latest, ubuntu-latest, windows-latest] | |
| node: [lts/*] | |
| include: | |
| - os: ubuntu-latest | |
| node: 14 | |
| - os: ubuntu-latest | |
| node: current | |
| exclude: | |
| - os: ubuntu-latest | |
| node: lts/* | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Set git to use LF | |
| if: matrix.os == 'windows-latest' | |
| run: | | |
| git config --global core.autocrlf false | |
| git config --global core.eol lf | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ matrix.node }} | |
| cache: npm | |
| - run: npm install | |
| - run: npm test -- --coverage | |
| release: | |
| permissions: | |
| contents: write # to be able to publish a GitHub release | |
| issues: write # to be able to comment on released issues | |
| pull-requests: write # to be able to comment on released pull requests | |
| id-token: write # to enable use of OIDC for npm provenance | |
| name: Semantic release | |
| needs: [build, test] | |
| # only run if opt-in during workflow_dispatch | |
| if: always() && github.event.inputs.release == 'true' && needs.build.result != 'failure' && needs.test.result != 'failure' && needs.test.result != 'cancelled' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| # Need to fetch entire commit history to | |
| # analyze every commit since last release | |
| fetch-depth: 0 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: lts/* | |
| cache: npm | |
| - run: npm ci | |
| # Branches that will release new versions are defined in .releaserc.json | |
| - run: npx semantic-release | |
| # Don't allow interrupting the release step if the job is cancelled, as it can lead to an inconsistent state | |
| # e.g. git tags were pushed but it exited before `npm publish` | |
| if: always() | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| NPM_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }} |