ci.yml

name: CI

on:
  push:
    branches:
      - main
      - v5
  pull_request:
    branches:
      - '**'

env:
  PRIMARY_NODE_VERSION: 12
  NX_BRANCH: ${{ github.event.number }}
  NX_RUN_GROUP: ${{ github.run_id }}
  # Added the - at the end to function as a separator to improve readability in the PR comment from the Nx cloud app
  NX_CLOUD_ENV_NAME: 'Node 12.x -'

jobs:
  typecheck:
    name: Typecheck
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: echo github.ref
        run: echo ${{ github.ref }}

      - name: Use Node.js ${{ env.PRIMARY_NODE_VERSION }}
        uses: actions/setup-node@v3
        with:
          node-version: ${{ env.PRIMARY_NODE_VERSION }}

      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"

      - uses: actions/cache@v3
        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-

      - name: Install dependencies
        run: |
          yarn --ignore-engines --frozen-lockfile --ignore-scripts
          yarn check-clean-workspace-after-install

      - name: Build
        run: |
          # Website will be built by the Netlify GitHub App
          yarn build --exclude website

      # Note that this command *also* type checks tests/tools,
      # whereas the build only checks src files
      - name: Typecheck all packages
        run: yarn typecheck

  unit_test_on_primary_node_version:
    name: Unit tests
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 2

      - name: echo github.ref
        run: echo ${{ github.ref }}

      - name: Use Node.js ${{ env.PRIMARY_NODE_VERSION }}
        uses: actions/setup-node@v3
        with:
          node-version: ${{ env.PRIMARY_NODE_VERSION }}

      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"

      - uses: actions/cache@v3
        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-

      - name: Install dependencies
        run: |
          yarn --ignore-engines --frozen-lockfile --ignore-scripts
          yarn check-clean-workspace-after-install

      - name: Build
        run: |
          # Website will be built by the Netlify GitHub App
          yarn build --exclude website

      - name: Run unit tests for typescript-estree
        run: npx nx test @typescript-eslint/typescript-estree
        env:
          CI: true

      - name: Run unit tests for visitor-keys
        run: npx nx test @typescript-eslint/visitor-keys
        env:
          CI: true

      - name: Run unit tests for scope-manager
        run: npx nx test @typescript-eslint/scope-manager --code-coverage
        env:
          CI: true

      - name: Run unit tests for utils
        run: npx nx test @typescript-eslint/utils
        env:
          CI: true

      - name: Run unit tests for type-utils
        run: npx nx test @typescript-eslint/type-utils
        env:
          CI: true

      - name: Run unit tests for parser
        run: npx nx test @typescript-eslint/parser
        env:
          CI: true

      - name: Run unit tests for eslint-plugin
        run: npx nx test @typescript-eslint/eslint-plugin
        env:
          CI: true

      - name: Run unit tests for eslint-plugin-tslint
        run: npx nx test @typescript-eslint/eslint-plugin-tslint
        env:
          CI: true

      - name: Run unit tests for eslint-plugin-internal
        run: npx nx test @typescript-eslint/eslint-plugin-internal
        env:
          CI: true

      - name: Publish code coverage report
        uses: codecov/codecov-action@v3
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          files: packages/**/coverage/lcov.info
          flags: unittest
          name: codecov

  linting_and_style:
    name: Code style and lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Use Node.js ${{ env.PRIMARY_NODE_VERSION }}
        uses: actions/setup-node@v3
        with:
          node-version: ${{ env.PRIMARY_NODE_VERSION }}

      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"

      - uses: actions/cache@v3
        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-

      - name: Install dependencies
        run: |
          yarn --ignore-engines --frozen-lockfile --ignore-scripts
          yarn check-clean-workspace-after-install

      - name: Build
        run: |
          # Website will be built by the Netlify GitHub App
          yarn build --exclude website

      - name: Check code formatting
        run: yarn check-format

      - name: Lint code
        run: yarn lint

      - name: Lint markdown
        run: yarn lint-markdown

      - name: Check spelling
        run: yarn check-spelling

  integration_tests:
    name: Run integration tests on primary Node.js version
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Use Node.js ${{ env.PRIMARY_NODE_VERSION }}
        uses: actions/setup-node@v3
        with:
          node-version: ${{ env.PRIMARY_NODE_VERSION }}

      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"

      - uses: actions/cache@v3
        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-

      - name: Install dependencies
        run: |
          yarn --ignore-engines --frozen-lockfile --ignore-scripts
          yarn check-clean-workspace-after-install

      - name: Build
        run: |
          # Website will be built by the Netlify GitHub App
          yarn build --exclude website

      - name: Run integrations tests
        run: yarn test-integration
        env:
          CI: true

  unit_tests_on_other_node_versions:
    name: Run unit tests on other Node.js versions
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [12.x, 14.x, 16.x]
    env:
      # Added the - at the end to function as a separator to improve readability in the PR comment from the Nx cloud app
      NX_CLOUD_ENV_NAME: 'Node ${{ matrix.node-version }} -'
    steps:
      - uses: actions/checkout@v3
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v3
        with:
          node-version: ${{ matrix.node-version }}

      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"

      - uses: actions/cache@v3
        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-

      - name: Install dependencies
        run: |
          yarn --ignore-engines --frozen-lockfile --ignore-scripts
          yarn check-clean-workspace-after-install

      - name: Build
        run: |
          # Website will be built by the Netlify GitHub App
          yarn build --exclude website

      - name: Run unit tests for typescript-estree
        run: npx nx test @typescript-eslint/typescript-estree
        env:
          CI: true

      - name: Run unit tests for visitor-keys
        run: npx nx test @typescript-eslint/visitor-keys
        env:
          CI: true

      - name: Run unit tests for scope-manager
        run: npx nx test @typescript-eslint/scope-manager
        env:
          CI: true

      - name: Run unit tests for utils
        run: npx nx test @typescript-eslint/utils
        env:
          CI: true

      - name: Run unit tests for type-utils
        run: npx nx test @typescript-eslint/type-utils
        env:
          CI: true

      - name: Run unit tests for parser
        run: npx nx test @typescript-eslint/parser
        env:
          CI: true

      - name: Run unit tests for eslint-plugin
        run: npx nx test @typescript-eslint/eslint-plugin
        env:
          CI: true

      - name: Run unit tests for eslint-plugin-tslint
        run: npx nx test @typescript-eslint/eslint-plugin-tslint
        env:
          CI: true

      # eslint-plugin-internal is internal only - so don't care about compat on other versions

  website_tests:
    name: Website tests
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 2

      - name: echo github.ref
        run: echo ${{ github.ref }}

      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"

      - uses: actions/cache@v3
        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-

      - name: Install dependencies
        run: yarn --ignore-engines --frozen-lockfile

      - name: Cypress run
        uses: cypress-io/github-action@v2
        with:
          project: ./packages/website
          start: yarn start

      - uses: actions/upload-artifact@v3
        if: always()
        with:
          name: screenshots
          path: |
            packages/website/cypress/screenshots/
            packages/website/cypress/videos/


  publish_canary_version:
    name: Publish the latest code as a canary version
    runs-on: ubuntu-latest
    needs:
      [
        typecheck,
        unit_test_on_primary_node_version,
        unit_tests_on_other_node_versions,
        linting_and_style,
        integration_tests,
      ]
    if: github.repository == 'typescript-eslint/typescript-eslint' && github.ref == 'refs/heads/main'
    steps:
      - uses: actions/checkout@v3
      # Fetch all history for all tags and branches in this job because lerna needs it
      - run: |
          git fetch --prune --unshallow

      - name: Use Node.js ${{ env.PRIMARY_NODE_VERSION }}
        uses: actions/setup-node@v3
        with:
          node-version: ${{ env.PRIMARY_NODE_VERSION }}
          registry-url: https://registry.npmjs.org/

      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"

      - uses: actions/cache@v3
        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-

      - name: Install dependencies
        run: |
          yarn --ignore-engines --frozen-lockfile --ignore-scripts
          yarn check-clean-workspace-after-install

      - name: Build
        run: |
          # Website will be built by the Netlify GitHub App
          yarn build --exclude website

      - name: Publish all packages to npm
        run: npx lerna publish --loglevel=verbose --canary --exact --force-publish --yes
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}