lint-fix-if-needed.yml

---
name: ESLint --fix

on:
  push:
    branches: [next]
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref_name }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  run:
    name: Should the linter fix? 🤔
    runs-on: ubuntu-latest
    # workflow_dispatch always lets you select the branch ref, even though in this case we only ever want to run the action on `main` thus we need an if check
    if: ${{ github.ref_name == 'next' }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: lts/*

      - uses: pnpm/action-setup@v2
        name: Install pnpm
        id: pnpm-install
        with:
          version: 8
          run_install: false

      - name: Get pnpm store directory
        id: pnpm-cache
        shell: bash
        run: |
          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT

      - name: Cache node modules
        id: cache-node-modules
        uses: actions/cache@v4
        env:
          cache-name: cache-node-modules
        with:
          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
          key: ${{ runner.os }}-pnpm-store-${{ env.cache-name }}-${{ hashFiles('**/pnpm-lock.yaml') }}
          restore-keys: |
            v1-${{ runner.os }}-pnpm-store-${{ env.cache-name }}-
            v1-${{ runner.os }}-pnpm-store-
            v1-${{ runner.os }}-

      - name: Install project dependencies
        run: pnpm install

      - name: Cache ESLint cache
        uses: actions/cache@v4
        with:
          path: .eslintcache
          key: eslint-v1-${{ hashFiles('.eslintrc.cjs') }}
      - run: "pnpm lint:fix -- --rule 'prettier/prettier: [off]'"
      - uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a # v2
        # Run even if `pnpm lint:fix` fails
        if: always()
        id: generate-token
        with:
          app_id: ${{ secrets.ECOSPARK_APP_ID }}
          private_key: ${{ secrets.ECOSPARK_APP_PRIVATE_KEY }}
      - uses: peter-evans/create-pull-request@70a41aba780001da0a30141984ae2a0c95d8704e # v6
        # Run even if `lint:fix` fails
        if: always()
        with:
          body: "I ran `pnpm lint:fix --rule 'prettier/prettier: [off]'` 🧑‍💻"
          branch: actions/lint-fix-if-needed
          commit-message: 'chore(lint): fix linter issues 🤖 ✨'
          labels: 🤖 bot
          title: 'chore(lint): fix linter issues 🤖 ✨'
          token: ${{ steps.generate-token.outputs.token }}