|
| 1 | +--- |
| 2 | +name: CI & Release |
| 3 | + |
| 4 | +# Workflow name based on selected inputs. Fallback to default Github naming when expression evaluates to empty string |
| 5 | +run-name: >- |
| 6 | + ${{ |
| 7 | + inputs.release && inputs.test && format('Build {0} ➤ Test ➤ Publish to NPM', github.ref_name) || |
| 8 | + inputs.release && !inputs.test && format('Build {0} ➤ Skip Tests ➤ Publish to NPM', github.ref_name) || |
| 9 | + github.event_name == 'workflow_dispatch' && inputs.test && format('Build {0} ➤ Test', github.ref_name) || |
| 10 | + github.event_name == 'workflow_dispatch' && !inputs.test && format('Build {0} ➤ Skip Tests', github.ref_name) || |
| 11 | + '' |
| 12 | + }} |
| 13 | +
|
| 14 | +on: |
| 15 | + # Build on pushes branches that have a PR (including drafts) |
| 16 | + pull_request: |
| 17 | + # Build on commits pushed to branches without a PR if it's in the allowlist |
| 18 | + push: |
| 19 | + branches: [main] |
| 20 | + # https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow |
| 21 | + workflow_dispatch: |
| 22 | + inputs: |
| 23 | + test: |
| 24 | + description: Run tests |
| 25 | + required: true |
| 26 | + default: true |
| 27 | + type: boolean |
| 28 | + release: |
| 29 | + description: Release new version |
| 30 | + required: true |
| 31 | + default: false |
| 32 | + type: boolean |
| 33 | + |
| 34 | +concurrency: |
| 35 | + # On PRs builds will cancel if new pushes happen before the CI completes, as it defines `github.head_ref` and gives it the name of the branch the PR wants to merge into |
| 36 | + # Otherwise `github.run_id` ensures that you can quickly merge a queue of PRs without causing tests to auto cancel on any of the commits pushed to main. |
| 37 | + group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} |
| 38 | + cancel-in-progress: true |
| 39 | + |
| 40 | +permissions: |
| 41 | + contents: read # for checkout |
| 42 | + |
| 43 | +jobs: |
| 44 | + build: |
| 45 | + runs-on: ubuntu-latest |
| 46 | + name: Lint & Build |
| 47 | + steps: |
| 48 | + - uses: actions/checkout@v4 |
| 49 | + - uses: actions/setup-node@v4 |
| 50 | + with: |
| 51 | + cache: npm |
| 52 | + node-version: lts/* |
| 53 | + - run: npm clean-install |
| 54 | + # Linting can be skipped |
| 55 | + - run: npm run lint --if-present |
| 56 | + if: github.event.inputs.test != 'false' |
| 57 | + # But not the build script, as semantic-release will crash if this command fails so it makes sense to test it early |
| 58 | + - run: npm run prepublishOnly --if-present |
| 59 | + |
| 60 | + test: |
| 61 | + needs: build |
| 62 | + # The test matrix can be skipped, in case a new release needs to be fast-tracked and tests are already passing on main |
| 63 | + if: github.event.inputs.test != 'false' |
| 64 | + runs-on: ${{ matrix.os }} |
| 65 | + name: Node.js ${{ matrix.node }} / ${{ matrix.os }} |
| 66 | + strategy: |
| 67 | + # A test failing on windows doesn't mean it'll fail on macos. It's useful to let all tests run to its completion to get the full picture |
| 68 | + fail-fast: false |
| 69 | + matrix: |
| 70 | + # Run the testing suite on each major OS with the latest LTS release of Node.js |
| 71 | + os: [macos-latest, ubuntu-latest, windows-latest] |
| 72 | + node: [lts/*] |
| 73 | + # It makes sense to also test the oldest, and latest, versions of Node.js, on ubuntu-only since it's the fastest CI runner |
| 74 | + include: |
| 75 | + - os: ubuntu-latest |
| 76 | + # Test the oldest LTS release of Node that's still receiving bugfixes and security patches, versions older than that have reached End-of-Life |
| 77 | + node: lts/-1 |
| 78 | + - os: ubuntu-latest |
| 79 | + # Test the actively developed version that will become the latest LTS release next October |
| 80 | + node: current |
| 81 | + steps: |
| 82 | + # It's only necessary to do this for windows, as mac and ubuntu are sane OS's that already use LF |
| 83 | + - name: Set git to use LF |
| 84 | + if: matrix.os == 'windows-latest' |
| 85 | + run: | |
| 86 | + git config --global core.autocrlf false |
| 87 | + git config --global core.eol lf |
| 88 | + - uses: actions/checkout@v4 |
| 89 | + - uses: actions/setup-node@v4 |
| 90 | + with: |
| 91 | + cache: npm |
| 92 | + node-version: ${{ matrix.node }} |
| 93 | + - run: npm install |
| 94 | + - run: npm test --if-present |
| 95 | + |
| 96 | + release: |
| 97 | + permissions: |
| 98 | + contents: write # to be able to publish a GitHub release |
| 99 | + issues: write # to be able to comment on released issues |
| 100 | + pull-requests: write # to be able to comment on released pull requests |
| 101 | + id-token: write # to enable use of OIDC for npm provenance |
| 102 | + needs: [build, test] |
| 103 | + # only run if opt-in during workflow_dispatch |
| 104 | + if: always() && github.event.inputs.release == 'true' && needs.build.result != 'failure' && needs.test.result != 'failure' && needs.test.result != 'cancelled' |
| 105 | + runs-on: ubuntu-latest |
| 106 | + name: Semantic release |
| 107 | + steps: |
| 108 | + - uses: actions/checkout@v4 |
| 109 | + with: |
| 110 | + # Need to fetch entire commit history to |
| 111 | + # analyze every commit since last release |
| 112 | + fetch-depth: 0 |
| 113 | + - uses: actions/setup-node@v4 |
| 114 | + with: |
| 115 | + cache: npm |
| 116 | + node-version: lts/* |
| 117 | + - run: npm clean-install |
| 118 | + - run: npm audit signatures |
| 119 | + # Branches that will release new versions are defined in .releaserc.json |
| 120 | + # @TODO remove --dry-run after verifying everything is good to go |
| 121 | + - run: npx semantic-release --dry-run |
| 122 | + # Don't allow interrupting the release step if the job is cancelled, as it can lead to an inconsistent state |
| 123 | + # e.g. git tags were pushed but it exited before `npm publish` |
| 124 | + if: always() |
| 125 | + env: |
| 126 | + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
| 127 | + NPM_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }} |
0 commit comments