🔧GitHub Actions workflow to update requirements after Dependabot merges

Author: github-actions[bot]

.github/workflows/update-requirements-after-dependabot.yml

@@ -0,0 +1,48 @@
+name: Update Requirements after Dependabot Merge
+
+# ワークフローの処理の流れ:
+# 1. トリガー条件:
+#    - プルリクエストマージ時
+#    - Dependabotによる実行であること
+# 2. 環境のセットアップ（Ubuntu、Python、Poetry）
+# 3. poetry.lockファイルの更新
+# 4. 依存関係のインストール（更新されたlockファイルを使用）
+# 5. requirements.txtとrequirements-dev.txtの生成
+# 6. 変更のコミットとプッシュ（poetry.lockを含む）
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  update-requirements:
+    if: github.event.pull_request.merged == true && github.event.pull_request.user.login == 'dependabot[bot]'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4.2.2
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.PAT_FOR_PUSHES }}
+      - name: Set up Python
+        uses: actions/setup-python@v5.4.0
+        with:
+          python-version: '3.13'
+      - name: Install Poetry
+        run: pip install poetry
+      - name: Add plugin
+        run: poetry self add poetry-plugin-export
+      - name: Update lock file
+        run: poetry lock
+      - name: Install dependencies
+        run: poetry install
+      - name: Update requirements files
+        run: |
+          poetry export -f requirements.txt -o requirements.txt --without-hashes
+          poetry export -f requirements.txt -o requirements-dev.txt --without-hashes --with dev
+      - name: Commit and push changes
+        run: |
+          git config --local user.email "33836132+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add requirements.txt requirements-dev.txt poetry.lock
+          git commit -m ":wrench:Update requirements files after dependency update [skip ci]" || echo "No changes to commit"
+          git push

.pre-commit-config.yaml

@@ -32,18 +32,19 @@ repos:
       - id: poetry-lock
         verbose: true
 
+  # [Note] poetry export is not done in pre-commit, but in GitHub Actions (update-requirements-after-dependabot.yml)
   # https://github.com/python-poetry/poetry-plugin-export?tab=readme-ov-file#usage
-  - repo: https://github.com/python-poetry/poetry-plugin-export.git
-    rev: 1.9.0
-    hooks:
-      - id: poetry-export
-        args: ["-f", "requirements.txt", "-o", "requirements.txt", "--without-hashes"]
-        verbose: true
-        files: ^pyproject\.toml$
-      - id: poetry-export
-        args: ["--with", "dev", "-f", "requirements.txt", "-o", "requirements-dev.txt", "--without-hashes"]
-        verbose: true
-        files: ^pyproject\.toml$
+  #- repo: https://github.com/python-poetry/poetry-plugin-export.git
+  #  rev: 1.9.0
+  #  hooks:
+  #    - id: poetry-export
+  #      args: ["-f", "requirements.txt", "-o", "requirements.txt", "--without-hashes"]
+  #      verbose: true
+  #      files: ^pyproject\.toml$
+  #    - id: poetry-export
+  #      args: ["--with", "dev", "-f", "requirements.txt", "-o", "requirements-dev.txt", "--without-hashes"]
+  #      verbose: true
+  #      files: ^pyproject\.toml$
 
   # https://github.com/shellcheck-py/shellcheck-py?tab=readme-ov-file#usage
   - repo: https://github.com/shellcheck-py/shellcheck-py

poetry.lock

@@ -1,3 +1,4 @@
+# For poetry versiion(>=2.0.0)
 #[project]
 #name = "mkdocs-macros-utils"
 #version = "0.0.7"
@@ -35,11 +36,7 @@
 #repository = "https://github.com/7rikazhexde/mkdocs-macros-utils"
 #documentation = "https://7rikazhexde.github.io/mkdocs-macros-utils/"
 
-# Build system configuration
-[build-system]
-requires = ["poetry-core>=2.0.0,<3.0.0"]
-build-backend = "poetry.core.masonry.api"
-
+# For poetry versiion(<2.0.0)
 [tool.poetry]
 name = "mkdocs-macros-utils"
 version = "0.0.7"
@@ -72,6 +69,11 @@ pytest-mock = "^3.14.0"
 pytest-xdist = "^3.6.1"
 taskipy = "^1.14.1"
 
+# Build system configuration
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
 # Task runner configuration
 [tool.taskipy.tasks]
 test_coverage_verbose = "pytest -s -vv --cov=mkdocs_macros_utils --cov-branch --cov-report term-missing --cov-report html"
@@ -94,6 +96,7 @@ warn_return_any = true
 warn_unused_ignores = true
 warn_redundant_casts = true
 
+# Overrides mypy ignore import settings
 [[tool.mypy.overrides]]
 module = ["mkdocs.*","mkdocs_macros.*","jinja2.*","ruamel.*","pygments.*"]
 ignore_missing_imports = true

pyproject.toml

@@ -129,10 +129,13 @@ def test_on_files() -> None:
     config = Config(schema=[])
     result = on_files(files, config)
 
+    # Normalize paths to use forward slashes for consistent comparison
+    paths = [f.src_path.replace("\\", "/") for f in result]
+    expected_style_css = f"{MACROS_UTILS_DIR}/style.css".replace("\\", "/")
+
     # Verify files are processed correctly
-    paths = [f.src_path for f in result]
     assert "test.md" in paths
-    assert f"{MACROS_UTILS_DIR}/style.css" in paths
+    assert expected_style_css in paths
     assert "other/file.md" in paths