chore: setup @sanity/semantic-release-preset

.github/workflows/main.yml

@@ -0,0 +1,113 @@
+---
+name: CI & Release
+
+on:
+  # Build on pushes branches that have a PR (including drafts)
+  pull_request:
+  # Build on commits pushed to branches without a PR if it's in the allowlist
+  push:
+    branches: [main, alpha]
+  # https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow
+  workflow_dispatch:
+    inputs:
+      test:
+        description: Run tests
+        required: true
+        default: true
+        type: boolean
+      release:
+        description: Release new version
+        required: true
+        default: false
+        type: boolean
+
+concurrency:
+  # 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
+  # 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.
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Lint & Build
+    steps:
+      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # tag=v3
+      - uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # tag=v3
+        with:
+          cache: npm
+          node-version: lts/*
+      - run: npm ci
+        # Linting can be skipped
+      - run: npm run lint
+        if: github.event.inputs.test != 'false'
+        # But not the build script, as semantic-release will crash if this command fails so it makes sense to test it early
+      - run: npm run prepublishOnly
+
+  test:
+    needs: build
+    # The test matrix can be skipped, in case a new release needs to be fast-tracked and tests are already passing on main
+    if: github.event.inputs.test != 'false'
+    runs-on: ${{ matrix.os }}
+    name: Node.js ${{ matrix.node }} / ${{ matrix.os }}
+    strategy:
+      # 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
+      fail-fast: false
+      matrix:
+        # Run the testing suite on each major OS with the latest LTS release of Node.js
+        os: [macos-latest, ubuntu-latest, windows-latest]
+        node: [lts/*]
+        # It makes sense to also test the oldest, and latest, versions of Node.js, on ubuntu-only since it's the fastest CI runner
+        include:
+          - os: ubuntu-latest
+            # Test the oldest LTS release of Node that's still receiving bugfixes and security patches, versions older than that have reached End-of-Life
+            node: lts/-2
+          - os: ubuntu-latest
+            # Test the actively developed version that will become the latest LTS release next October
+            node: current
+    steps:
+      # It's only necessary to do this for windows, as mac and ubuntu are sane OS's that already use LF
+      - 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@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # tag=v3
+      - uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # tag=v3
+        with:
+          cache: npm
+          node-version: ${{ matrix.node }}
+      - run: npm ci
+      - run: npm test
+
+  release:
+    needs: test
+    # only run if opt-in during workflow_dispatch, and run if tests are skipped using the toggle, but not if they have failed
+    if: always() && github.event.inputs.release == 'true' && needs.test.result != 'failure' && needs.test.result != 'cancelled'
+    runs-on: ubuntu-latest
+    name: Semantic release
+    steps:
+      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # tag=v3
+        with:
+          # Need to fetch entire commit history to
+          # analyze every commit since last release
+          fetch-depth: 0
+      - uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # tag=v3
+        with:
+          cache: npm
+          node-version: lts/*
+      - 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 }}
+        # Re-run semantic release with rich logs if it failed to publish for easier debugging
+      - run: npx semantic-release --dry-run --debug
+        if: failure()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

.releaserc.json

@@ -1,3 +1,4 @@
 {
+  "extends": "@sanity/semantic-release-preset",
   "branches": ["main", { "name": "alpha", "prerelease": true }]
 }

README.md

@@ -39,3 +39,11 @@ Add the following to `.eslintrc`
 \*Note: This package utilizes [`@rushstack/eslint-patch`](https://github.com/microsoft/rushstack/tree/ebee58403b1595027da7ef00a4d817d83ecbd737/eslint/eslint-patch#what-it-does) to include plugins as dependencies. This making installation easier and allows us to manage those dependencies for you.
 
 Since this package includes dependencies to plugins, it will never have more than one preset.
+
+## Release new version
+
+Run ["CI & Release" workflow](https://github.com/sanity-io/eslint-config-studio/actions).
+Make sure to select the main branch and check "Release new version".
+
+Semantic release will only release on configured branches, so it is safe to run release on any branch.
+

package.json

@@ -36,6 +36,7 @@
     "eslint-plugin-react-hooks": "^4.3.0"
   },
   "devDependencies": {
+    "@sanity/semantic-release-preset": "^2.0.2",
     "eslint": "8.6.0",
     "jest": "27.5.1",
     "react": "17.0.2",