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

diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
index bfdd451845267b7190d6e6384b54326f92d48a4f..31637f5aa01925d36fb6a5c1a2a2dc4110fa5b26 100644 (file)
--- 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 8440301ad807305328c51e1650975c651f898d61..f21c23186b00806dbb8041a2bac323059a6c3a8d 100644 (file)
--- 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