Add automatic README command help update via GitHub Actions (#2574)

* feat: add GitHub Actions workflow to update README command help

* fix: skip README checks in pre-commit configuration

Author: koxudaxi

.github/workflows/readme.yaml

@@ -0,0 +1,44 @@
+name: Update README
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'src/datamodel_code_generator/__main__.py'
+  pull_request:
+    branches: [main]
+    paths:
+      - 'src/datamodel_code_generator/__main__.py'
+
+permissions:
+  contents: write
+
+jobs:
+  update-readme:
+    if: github.event_name == 'push' || !github.event.pull_request.head.repo.fork
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.head_ref || github.ref }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install tox
+        run: uv tool install --python-preference only-managed --python 3.13 tox --with tox-uv
+      - name: Setup environment
+        run: tox run -vv --notest --skip-missing-interpreters false -e readme
+        env:
+          UV_PYTHON_PREFERENCE: "only-managed"
+      - name: Update README
+        run: .tox/readme/bin/python scripts/update_command_help_on_markdown.py
+      - name: Commit and push if changed
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add README.md docs/index.md
+          git diff --staged --quiet || git commit -m "docs: update command help in README
+
+          🤖 Generated by GitHub Actions"
+          git push

.github/workflows/test.yaml

@@ -127,7 +127,6 @@ jobs:
           - dev
           - docs
           - pkg_meta
-          - readme
     steps:
       - uses: actions/checkout@v4
         with:

.pre-commit-config.yaml

@@ -1,3 +1,6 @@
+ci:
+  skip: [readme]
+
 repos:
 - repo: https://github.com/python-jsonschema/check-jsonschema
   rev: 0.35.0
@@ -29,3 +32,11 @@ repos:
     additional_dependencies:
     - tomli
     exclude: "^tests/|^CODE_OF_CONDUCT.md"
+- repo: local
+  hooks:
+  - id: readme
+    name: Update README command help
+    entry: bash -c 'test -x .tox/fix/bin/python || tox run -e fix --notest -qq; .tox/fix/bin/python scripts/update_command_help_on_markdown.py'
+    language: system
+    files: ^(src/datamodel_code_generator/__main__\.py|README\.md|docs/index\.md)$
+    pass_filenames: false

scripts/update_command_help_on_markdown.py

@@ -64,21 +64,22 @@ def main() -> Exit:
     """Update or validate command help in target markdown files."""
     help_text = get_help()
     arg_parser.add_argument(
-        "--validate",
+        "--check",
         action="store_true",
-        help="Validate the file content is up to date",
+        help="Check if the file content is up to date without modifying",
     )
     args = arg_parser.parse_args()
-    validate: bool = args.validate
+    check: bool = args.check
 
     for file_path in TARGET_MARKDOWN_FILES:
         with file_path.open("r") as f:
             markdown_text = f.read()
         new_markdown_text = inject_help(markdown_text, help_text)
-        if validate and new_markdown_text != markdown_text:
-            return Exit.ERROR
-        with file_path.open("w") as f:
-            f.write(new_markdown_text)
+        if new_markdown_text != markdown_text:
+            if check:
+                return Exit.ERROR
+            with file_path.open("w") as f:
+                f.write(new_markdown_text)
     return Exit.OK
 
 

tox.ini

@@ -56,15 +56,14 @@ dependency_groups =
 
 [testenv:fix]
 description = format the code base to adhere to our styles, and complain about what we cannot do automatically
-skip_install = true
 commands =
     pre-commit run --all-files --show-diff-on-failure
 dependency_groups = fix
 
 [testenv:readme]
-description = Update help in readme
+description = Check help in readme is up to date
 commands =
-    python scripts/update_command_help_on_markdown.py {posargs:--validate}
+    python scripts/update_command_help_on_markdown.py {posargs:--check}
 dependency_groups =
 no_default_groups = true