Feat: Replace flake8, black and husky with ruff + pre-commit (#1846)

* feat: move from black and flake8 to ruff

Not formatting yet, just configs

* feat: replace husky with pre-commit

Replaces husky as a hook manager with pre-commit manager as per new contributing guidelines. This also improves the readability of the hooks as everything is in a single file.

* docs: update lint, format and hook docs

Closes #1845

* feat: add ignore-revs file

This file will ignore the refformating PR when using git-blame, so that we don't lose track of previous changes

Author: MarceloRobert

.git-blame-ignore-revs

@@ -0,0 +1 @@
+05e2a3ae5e878aa90e6d6e0ac20179a00f6652e4  # Ruff auto-formatting

.github/workflows/ci.yaml

@@ -114,12 +114,12 @@ jobs:
       - name: Setup Backend
         uses: ./.github/actions/setup-backend
 
-      - name: Lint
-        run: poetry run flake8
+      - name: Check Lint
+        run: poetry run ruff check .
         working-directory: ./backend
 
       - name: Check Format
-        run: poetry run black --check .
+        run: poetry run ruff format --check .
         working-directory: ./backend
 
       - name: Run unit tests with coverage

.pre-commit-config.yaml

@@ -0,0 +1,51 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.9
+    hooks:
+      - id: ruff-format
+        files: ^backend/
+        args: [--check]
+      - id: ruff-check
+        files: ^backend/
+
+  - repo: local
+    hooks:
+      - id: frontend-lint-staged
+        name: frontend lint-staged
+        entry: bash -lc 'cd dashboard && pnpm lint-staged'
+        language: system
+        pass_filenames: false
+        stages: [pre-commit]
+
+      - id: frontend-typecheck
+        name: frontend typecheck
+        entry: bash -lc 'cd dashboard && pnpm typecheck'
+        language: system
+        pass_filenames: false
+        stages: [pre-commit]
+
+      - id: frontend-pre-push
+        name: frontend pre-push
+        entry: bash
+        args:
+          - -lc
+          - |
+            REMOTE="$1"
+            if [ -z "$MASTER_REF" ]; then
+              MASTER_REF="$REMOTE/main"
+            fi
+
+            if ! read LOCAL_REF LOCAL_SHA REMOTE_REF REMOTE_SHA; then
+              echo "NOTE: nothing to push, nothing to check"
+              exit 0
+            fi
+
+            if [ "$LOCAL_REF" = "(delete)" ]; then
+              echo "NOTE: deleting branch, nothing to check"
+              exit 0
+            fi
+
+            exit 0
+        language: system
+        pass_filenames: false
+        stages: [pre-push]

CONTRIBUTING.md

@@ -8,7 +8,7 @@ KernelCI Dashboard is an open-source project and contributions of all kinds are
 - We recommend following the [Onboarding guide](./docs/Onboarding.md) to set up your environment and learn the project workflow. **Start here** if this is your first setup.
 - New to the project? Pick an issue labeled ["good first issue"](https://github.com/kernelci/dashboard/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
 - There are a couple of extensions that may help you with linting and formatting your code. Consider installing [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) for your preferred code editor.
-- There are some of these to help with your Python development: [Black](https://black.readthedocs.io/en/stable/), [Flake8](https://flake8.pycqa.org/en/latest/), and [isort](https://pycqa.github.io/isort/).
+- For Python development, this repository uses [Ruff](https://docs.astral.sh/ruff/) for linting and formatting, and [pre-commit](https://pre-commit.com/) for Git hooks.
 
 ## Useful links
 
@@ -97,10 +97,14 @@ You can find more details on the Conventional Commits specification site.
 
 - Backend
   - See [backend/README.md](backend/README.md) for environment and commands
-  - Run linting: `poetry run flake8`
+  - Run linting: `poetry run ruff check .`
+  - Run formatting check: `poetry run ruff format --check .`
+  - Apply formatting: `poetry run ruff format .`
+  - Auto-fix lint issues: `poetry run ruff check . --fix`
   - Run type checks (optional but recommended): `poetry run mypy`
   - Run tests: `poetry run pytest`
-  - Apply formatting with `poetry run black .` before committing; the `backend/pre-commit` and `backend/pre-push` hooks can help automate this — see [backend/README.md](backend/README.md) for installation instructions
+  - Install Git hooks once per clone: from the repository root run `poetry -C backend run pre-commit install --hook-type pre-commit --hook-type pre-push --install-hooks`
+  - Run all hooks manually: `poetry -C backend run pre-commit run --all-files`
 - Frontend
   - See [dashboard/README.md](dashboard/README.md) for scripts and commands
   - Run linting: `pnpm lint`

backend/.flake8

@@ -100,6 +100,27 @@ It is important to note that Django automatically creates migrations based on ch
 * [copy_db_data.sh](./scripts/copy_db_data.sh) will copy 7 days of data from you `DB_DEFAULT` to your `DASH_DB`. You can also modify the script for a custom interval, and you can check the [update_db](./kernelCI_app/management/commands/update_db.py) command for other arguments such as `--table` and `--origins`.
 * [generate-schema.sh](./generate-schema.sh) will automatically generate the OpenAPI schema for the endpoints. Please use it whenever the ins and outs of endpoints change.
 
+## Linting, formatting, and hooks
+
+The backend uses Ruff for linting and formatting.
+
+- Check lint issues: `poetry run ruff check .`
+- Auto-fix lint issues: `poetry run ruff check . --fix`
+- Check formatting: `poetry run ruff format --check .`
+- Auto-fix formatting: `poetry run ruff format .`
+
+This repository uses pre-commit for Git hooks (`pre-commit` and `pre-push`). Install hooks once per clone from the repository root:
+
+```sh
+poetry -C backend run pre-commit install --hook-type pre-commit --hook-type pre-push --install-hooks
+```
+
+To run all configured hooks manually:
+
+```sh
+poetry -C backend run pre-commit run --all-files
+```
+
 
 ## Running tests