faststack/.github/workflows/lint.yml at main · manavgup/faststack · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# ===============================================================
# 🔍 Lint & Static Analysis — Code Quality Gate
# ===============================================================
#
# This workflow:
#   - Runs ruff for linting and import sorting
#   - Runs black for code formatting checks
#   - Runs mypy for static type analysis
#
# Triggers on push to main and PRs. Skips draft PRs.
# Cancels stale runs on the same branch.
#
# References
# ──────────
#   - Ruff:   https://docs.astral.sh/ruff/
#   - Black:  https://black.readthedocs.io/
#   - Mypy:   https://mypy.readthedocs.io/
#
# Author:  Manav Gupta <manavg@gmail.com>
# ===============================================================

name: Lint & Static Analysis

on:
  push:
    branches: [main]
    paths:
      - "**.py"
      - "pyproject.toml"
      - ".github/workflows/lint.yml"
  pull_request:
    types: [opened, synchronize, ready_for_review]
    branches: [main]
    paths:
      - "**.py"
      - "pyproject.toml"
      - ".github/workflows/lint.yml"

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

# -----------------------------------------------------------------
# Minimal permissions — principle of least privilege
# -----------------------------------------------------------------
permissions:
  contents: read

jobs:

  # =========================================================================
  # 🔍 Ruff + Black
  # =========================================================================
  python-lint:
    name: Ruff & Black
    runs-on: ubuntu-latest
    timeout-minutes: 5
    if: github.event_name != 'pull_request' || !github.event.pull_request.draft

    steps:
      # ─────────── Setup ───────────
      - name: ⬇️  Checkout code
        uses: actions/checkout@v4
        with:
          persist-credentials: false

      - name: 🐍  Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: 📦  Install Poetry
        run: pipx install poetry

      - name: 💾  Cache Poetry dependencies
        uses: actions/cache@v4
        with:
          path: ~/.cache/pypoetry
          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
          restore-keys: ${{ runner.os }}-poetry-

      - name: 📦  Install dependencies
        run: poetry install --no-interaction

      # ─────────── Checks ───────────
      - name: 🔍  Ruff lint
        run: poetry run ruff check .

      - name: 🎨  Black format check
        run: poetry run black --check .

  # =========================================================================
  # 🔎 Type Check
  # =========================================================================
  typecheck:
    name: Mypy
    runs-on: ubuntu-latest
    timeout-minutes: 5
    if: github.event_name != 'pull_request' || !github.event.pull_request.draft

    steps:
      # ─────────── Setup ───────────
      - name: ⬇️  Checkout code
        uses: actions/checkout@v4
        with:
          persist-credentials: false

      - name: 🐍  Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: 📦  Install Poetry
        run: pipx install poetry

      - name: 💾  Cache Poetry dependencies
        uses: actions/cache@v4
        with:
          path: ~/.cache/pypoetry
          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
          restore-keys: ${{ runner.os }}-poetry-

      - name: 📦  Install dependencies
        run: poetry install --no-interaction

      # ─────────── Check ───────────
      - name: 🔎  Mypy type check
        run: poetry run mypy faststack_core/ cli/