validation.yml

name: 'Validation'

env:
  NODE_VERSION: '18' # Shipped with VS Code.
  PYTHON_VERSION: 3.11

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  typecheck:
    if: github.repository == 'microsoft/pyright'
    runs-on: ubuntu-latest
    name: Typecheck

    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}

      - name: Get npm cache directory
        id: npm-cache
        shell: bash
        run: |
          echo "dir=$(npm config get cache)" >> $GITHUB_OUTPUT
      - uses: actions/cache@v4
        with:
          path: ${{ steps.npm-cache.outputs.dir }}
          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-node-

      - run: npm run install:all

      - run: npx lerna exec --stream --no-bail -- tsc --noEmit

  style:
    if: github.repository == 'microsoft/pyright'
    runs-on: ubuntu-latest
    name: Style

    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}

      - name: Get npm cache directory
        id: npm-cache
        shell: bash
        run: |
          echo "dir=$(npm config get cache)" >> $GITHUB_OUTPUT
      - uses: actions/cache@v4
        with:
          path: ${{ steps.npm-cache.outputs.dir }}
          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-node-

      - run: npm run install:all

      - name: Check diff after npm install
        run: git diff --exit-code --name-only

      - run: npm run check

  test:
    strategy:
      fail-fast: false
      matrix:
        os: [macos-latest, windows-latest, ubuntu-latest]

    name: Test ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    needs: typecheck

    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}

      # Don't cache on Windows; the cache ends up being very large and
      # the Windows implementation of the cache task uses a much slower archiver.
      - name: Get npm cache directory
        if: runner.os != 'Windows'
        id: npm-cache
        shell: bash
        run: |
          echo "dir=$(npm config get cache)" >> $GITHUB_OUTPUT
      - uses: actions/cache@v4
        if: runner.os != 'Windows'
        with:
          path: ${{ steps.npm-cache.outputs.dir }}
          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-node-

      - run: npm run install:all

      - name: npm test (pyright-internal)
        run: npm test
        working-directory: packages/pyright-internal

      # Install python so we can create a VENV for tests
      - name: Use Python ${{env.PYTHON_VERSION}}
        uses: actions/setup-python@v5
        id: install_python
        with:
          python-version: ${{env.PYTHON_VERSION}}

      - name: Create Venv
        run: |
          ${{ steps.install_python.outputs.python-path }} -m venv .venv

      - name: Activate and install pytest (linux)
        if: runner.os != 'Windows'
        run: |
          source .venv/bin/activate
          python -m pip install pytest
          python -c "import sys;print('python_venv_path=' + sys.executable)" >> $GITHUB_ENV

      - name: Activate and install pytest (windows)
        if: runner.os == 'Windows'
        run: |
          .venv\scripts\activate
          python -m pip install pytest
          python -c "import sys;print('python_venv_path=' + sys.executable)" | Out-File -FilePath $env:GITHUB_ENV -Append

      - name: Echo python_venv_path
        run: |
          echo python_venv_path=${{env.python_venv_path}}

      - name: Run import tests with venv
        env:
          CI_IMPORT_TEST_VENVPATH: '../../'
          CI_IMPORT_TEST_VENV: '.venv'
        run: npm run test:imports
        working-directory: packages/pyright-internal

      - name: Run import tests with pythonpath
        env:
          CI_IMPORT_TEST_PYTHONPATH: ${{env.python_venv_path}}
        run: npm run test:imports
        working-directory: packages/pyright-internal

  build:
    runs-on: ubuntu-latest
    name: Build
    needs: typecheck
    permissions:
      id-token: write
      contents: read

    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}

      - uses: ./.github/actions/cfs-npm-cache
      - uses: ./.github/actions/cfs-npm-install

      - run: npm publish --dry-run
        working-directory: packages/pyright

      - run: npm run package
        working-directory: packages/vscode-pyright

  required:
    runs-on: ubuntu-latest
    name: Required
    needs:
      - typecheck
      - style
      - test
      - build

    steps:
      - run: echo All required jobs succeeded.