👷 CI: add pyright checking workflow (#185)

yanyongyu · Jan 24, 2025 · 689cc1e · 689cc1e
1 parent c7154c6
commit 689cc1e
Show file tree

Hide file tree

Showing 9 changed files with 260 additions and 82 deletions.
diff --git a/.github/workflows/pyright.yml b/.github/workflows/pyright.yml
@@ -0,0 +1,71 @@
+name: Pyright Lint
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    paths:
+      - "envs/**"
+      - "githubkit/**"
+      - "tests/**"
+      - "codegen/**"
+      - ".github/actions/setup-python/**"
+      - ".github/workflows/pyright.yml"
+      - "**/pyproject.toml"
+      - "**/poetry.lock"
+
+jobs:
+  lint-githubkit:
+    name: GitHubKit Lint
+    runs-on: ubuntu-latest
+    concurrency:
+      group: pyright-${{ github.ref }}-${{ matrix.env }}
+      cancel-in-progress: true
+    strategy:
+      matrix:
+        env: [pydantic-v1, pydantic-v2]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python environment
+        uses: ./.github/actions/setup-python
+        with:
+          env-dir: ./envs/${{ matrix.env }}
+          no-root: true
+
+      - run: |
+          (cd ./envs/${{ matrix.env }} && echo "$(poetry env info --path)/bin" >> $GITHUB_PATH)
+          if [ "${{ matrix.env }}" = "pydantic-v1" ]; then
+            sed -i 's/PYDANTIC_V2 = true/PYDANTIC_V2 = false/g' ./pyproject.toml
+          fi
+        shell: bash
+
+      - name: Run Pyright
+        uses: jakebailey/pyright-action@v2
+        with:
+          pylance-version: latest-release
+
+  lint-codegen:
+    name: Codegen Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python environment
+        uses: ./.github/actions/setup-python
+        with:
+          env-dir: .
+
+      - run: |
+          echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
+        shell: bash
+
+      - name: Run Pyright
+        uses: jakebailey/pyright-action@v2
+        with:
+          working-directory: ./codegen
+          pylance-version: latest-release
diff --git a/codegen/pyproject.toml b/codegen/pyproject.toml
@@ -5,3 +5,13 @@ target-version = "py310"
 
 [tool.ruff.lint]
 ignore = ["TID"]
+
+[tool.pyright]
+typeCheckingMode = "standard"
+reportPrivateImportUsage = false
+reportShadowedImports = false
+disableBytesTypePromotions = true
+
+pythonVersion = "3.10"
+pythonPlatform = "All"
+defineConstant = { PYDANTIC_V2 = true }
diff --git a/envs/pydantic-v1/poetry.lock b/envs/pydantic-v1/poetry.lock
diff --git a/envs/pydantic-v2/poetry.lock b/envs/pydantic-v2/poetry.lock
diff --git a/envs/test/poetry.lock b/envs/test/poetry.lock
diff --git a/envs/test/pyproject.toml b/envs/test/pyproject.toml
@@ -9,6 +9,7 @@ packages = [{ include = "githubkit-test.py" }]
 [tool.poetry.dependencies]
 python = "^3.9"
 anyio = "*"
+redis = "^5.2.0"
 pytest = "^8.1.0"
 pytest-cov = "^6.0.0"
 pytest-xdist = "^3.5.0"