From: Sebastián Ramírez <tiangolo@gmail.com>
Date: Tue, 3 Feb 2026 23:10:47 +0000 (-0800)
Subject: 👷 Add generate-readme to pre-commit (#1741)
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=18f80607941999bddfbfbe28b056f62cf652df17;p=thirdparty%2Ffastapi%2Fsqlmodel.git

👷 Add generate-readme to pre-commit (#1741)
---

diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
index bfdd4518..31637f5a 100644
--- a/.github/workflows/build-docs.yml
+++ b/.github/workflows/build-docs.yml
@@ -64,8 +64,6 @@ jobs:
         with:
           key: mkdocs-cards-${{ github.ref }}
           path: .cache
-      - name: Verify README
-        run: uv run ./scripts/docs.py verify-readme
       - name: Build Docs
         run: uv run ./scripts/docs.py build
       - uses: actions/upload-artifact@v6
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 8440301a..f21c2318 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -40,3 +40,10 @@ repos:
         name: generate-select
         entry: uv run ./scripts/generate_select.py
         files: ^scripts/generate_select\.py|sqlmodel/sql/_expression_select_gen\.py\.jinja2$
+
+      - id: generate-readme
+        language: unsupported
+        name: generate README.md from index.md
+        entry: uv run ./scripts/docs.py generate-readme
+        files: ^docs/index\.md|scripts/docs\.py$
+        pass_filenames: false