DX: lint PRs with @compwa/commitlint-config (#186)

* FEAT: automatically update `pr-linting.yml`
* FIX: update `release_drafter` module description

.github/workflows/pr-linting.yml

@@ -1,5 +1,3 @@
-# cspell:ignore agilepathway commitlint kode
-
 name: PR linting
 on:
   pull_request:
@@ -16,7 +14,7 @@ jobs:
     name: Check labels
     runs-on: ubuntu-20.04
     steps:
-      - uses: docker://agilepathway/pull-request-label-checker:latest
+      - uses: docker://agilepathway/pull-request-label-checker:latest # cspell:ignore agilepathway
         with:
           any_of: >-
             🐛 Bug,✨ Feature,⚙️ Enhancement,⚠️ Interface,❗ Behavior,📝 Docs,🔨 Maintenance,🖱️ DX
@@ -28,5 +26,8 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v3
-      - run: npm install @commitlint/config-conventional
-      - uses: JulienKode/[email protected]
+      - run: npm install @compwa/commitlint-config
+      - name: Create commitlint config
+        run: |
+          echo "module.exports = {extends: ['@compwa/commitlint-config']}" > commitlint.config.js
+      - uses: JulienKode/[email protected] # cspell:ignore kode

.gitignore

@@ -10,6 +10,7 @@
 *.xml
 *.yaml
 *.yml
+commitlint.config.js
 
 # Build files
 *.egg-info/

.vscode/settings.json

@@ -62,8 +62,7 @@
     "src/repoma/.template/.cspell.json": true,
     "src/repoma/.template/.gitpod.yml": true,
     "src/repoma/.template/.prettierrc": true,
-    "src/repoma/.template/.taplo.toml": true,
-    "src/repoma/.template/commitlint.config.js": true
+    "src/repoma/.template/.taplo.toml": true
   },
   "yaml.schemas": {
     "https://citation-file-format.github.io/1.2.0/schema.json": "CITATION.cff",

src/repoma/.github/workflows/pr-linting.yml

@@ -0,0 +1 @@
+../../../../.github/workflows/pr-linting.yml

src/repoma/check_dev_files/commitlint.py

@@ -1,6 +1,16 @@
-"""Check :file:`commitlint.config.js` config file."""
-from repoma.utilities import CONFIG_PATH, update_file
+"""Remove :file:`commitlint.config.js` config file.
+
+See https://github.com/ComPWA/repo-maintenance/issues/177.
+"""
+import os
+
+from repoma.errors import PrecommitError
 
 
 def main() -> None:
-    update_file(CONFIG_PATH.commitlint, in_template_folder=True)
+    path = "commitlint.config.js"
+    if not os.path.exists(path):
+        return
+    os.remove(path)
+    msg = f"Remove outdated {path}"
+    raise PrecommitError(msg)

src/repoma/check_dev_files/github_workflows.py

@@ -1,6 +1,7 @@
 """Check :file:`.github/workflows` folder content."""
 import os
 import re
+import shutil
 from pathlib import Path
 from typing import List, Tuple
 
@@ -9,7 +10,7 @@
 from ruamel.yaml.scalarstring import DoubleQuotedScalarString
 
 from repoma.errors import PrecommitError
-from repoma.utilities import CONFIG_PATH, REPOMA_DIR, write
+from repoma.utilities import CONFIG_PATH, REPOMA_DIR, hash_file, write
 from repoma.utilities.executor import Executor
 from repoma.utilities.precommit import PrecommitConfig
 from repoma.utilities.project_info import get_pypi_name
@@ -42,6 +43,7 @@ def main(
         skip_tests,
         test_extras,
     )
+    executor(_update_pr_linting)
     executor(_recommend_vscode_extension)
     executor.finalize()
 
@@ -70,6 +72,17 @@ def update() -> None:
     executor.finalize()
 
 
+def _update_pr_linting() -> None:
+    filename = "pr-linting.yml"
+    input_path = REPOMA_DIR / CONFIG_PATH.github_workflow_dir / filename
+    output_path = CONFIG_PATH.github_workflow_dir / filename
+    output_path.parent.mkdir(exist_ok=True)
+    if not output_path.exists() or hash_file(input_path) != hash_file(output_path):
+        shutil.copyfile(input_path, output_path)
+        msg = f'Updated "{output_path}" workflow'
+        raise PrecommitError(msg)
+
+
 def _update_ci_workflow(
     allow_deprecated: bool,
     doc_apt_packages: List[str],

src/repoma/check_dev_files/release_drafter.py

@@ -1,4 +1,4 @@
-"""Check :file:`commitlint.config.js` config file."""
+"""Update Release Drafter Action."""
 import os
 from typing import Any, Dict
 

src/repoma/utilities/__init__.py

@@ -1,5 +1,6 @@
 """Collection of helper functions that are shared by all sub-hooks."""
 
+import hashlib
 import io
 import os
 import re
@@ -14,7 +15,6 @@
 class _ConfigFilePaths(NamedTuple):
     citation: Path = Path("CITATION.cff")
     codecov: Path = Path("codecov.yml")
-    commitlint: Path = Path("commitlint.config.js")
     cspell: Path = Path(".cspell.json")
     editorconfig: Path = Path(".editorconfig")
     github_workflow_dir: Path = Path(".github/workflows")
@@ -40,6 +40,19 @@ class _ConfigFilePaths(NamedTuple):
 REPOMA_DIR = Path(repoma.__file__).parent.absolute()
 
 
+def hash_file(path: Union[Path, str]) -> str:
+    # https://stackoverflow.com/a/22058673
+    buffer_size = 65_536
+    sha256 = hashlib.sha256()
+    with open(path, "rb") as f:
+        while True:
+            data = f.read(buffer_size)
+            if not data:
+                break
+            sha256.update(data)
+    return sha256.hexdigest()
+
+
 def read(input: Union[Path, io.TextIOBase, str]) -> str:  # noqa: A002
     if isinstance(input, (Path, str)):
         with open(input) as input_stream: