ci: Please pre-commit hooks

DSD-DBS · Mar 25, 2024 · 564f750 · 564f750
1 parent 88854ab
commit 564f750
Show file tree

Hide file tree

Showing 2 changed files with 99 additions and 108 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -32,16 +32,6 @@ jobs:
               run: make -C docs apidoc
             - name: Create docs
               run: make -C docs html
-            - name: Archive the docs
-              # https://github.com/actions/upload-artifact#too-many-uploads-resulting-in-429-responses
-              run: (cd docs/build/html && zip -Xr ../html.zip .)
-            - name: Upload built docs as artifact
-              uses: actions/upload-artifact@v3
-              with:
-                  name: Documentation
-                  path: docs/build/html.zip
-                  if-no-files-found: error
-                  retention-days: 5
             - name: Deploy
               if: github.ref == 'refs/heads/master'
               uses: peaceiris/actions-gh-pages@v3

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -4,101 +4,102 @@
 default_install_hook_types: [commit-msg, pre-commit]
 default_stages: [commit, merge-commit]
 repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
-    hooks:
-      - id: check-added-large-files
-      - id: check-ast
-      - id: check-builtin-literals
-      - id: check-case-conflict
-      - id: check-executables-have-shebangs
-      - id: check-json
-      - id: check-merge-conflict
-      - id: check-shebang-scripts-are-executable
-      - id: check-symlinks
-      - id: check-toml
-      - id: check-vcs-permalinks
-      - id: check-xml
-      - id: check-yaml
-      - id: debug-statements
-      - id: destroyed-symlinks
-      - id: end-of-file-fixer
-      - id: fix-byte-order-marker
-      - id: trailing-whitespace
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.1.1
-    hooks:
-      - id: black
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.13.2
-    hooks:
-      - id: isort
-  - repo: https://github.com/PyCQA/docformatter
-    rev: v1.7.5
-    hooks:
-      - id: docformatter
-        additional_dependencies:
-          - docformatter[tomli]
-  - repo: https://github.com/PyCQA/pydocstyle
-    rev: 6.3.0
-    hooks:
-      - id: pydocstyle
-        exclude: '^tests/'
-        additional_dependencies:
-          - pydocstyle[toml]
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.8.0
-    hooks:
-      - id: mypy
-  - repo: https://github.com/Lucas-C/pre-commit-hooks
-    rev: v1.5.4
-    hooks:
-      - id: insert-license
-        name: Insert license headers (shell-style comments)
-        files: '(?:^|/)(?:.*\.(?:py|sh|toml|ya?ml)|Dockerfile|Makefile)$'
-        exclude: '(?:^|/)\..+|^docs/Makefile$'
-        args:
-          - --detect-license-in-X-top-lines=15
-          - --license-filepath
-          - LICENSES/.license_header.txt
-          - --comment-style
-          - '#'
-      - id: insert-license
-        name: Insert license headers (XML-style comments)
-        files: '\.(?:html|md|xml)$'
-        exclude: '(?:^|/)\..+'
-        args:
-          - --detect-license-in-X-top-lines=15
-          - --license-filepath
-          - LICENSES/.license_header.txt
-          - --comment-style
-          - '<!--| ~| -->'
-      - id: insert-license
-        name: Insert license headers (C-style comments)
-        files: '\.(?:css|js|ts)$'
-        exclude: '(?:^|/)\..+'
-        args:
-          - --detect-license-in-X-top-lines=15
-          - --license-filepath
-          - LICENSES/.license_header.txt
-          - --comment-style
-          - '/*| *| */'
-      - id: insert-license
-        name: Insert license headers (reST comments)
-        files: '\.rst$'
-        exclude: '(?:^|/)\..+'
-        args:
-          - --detect-license-in-X-top-lines=15
-          - --license-filepath
-          - LICENSES/.license_header.txt
-          - --comment-style
-          - '..|  |'
-  - repo: https://github.com/fsfe/reuse-tool
-    rev: v3.0.1
-    hooks:
-      - id: reuse
-  - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
-    rev: v9.11.0
-    hooks:
-      - id: commitlint
-        stages: [commit-msg]
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v4.5.0
+      hooks:
+          - id: check-added-large-files
+          - id: check-ast
+          - id: check-builtin-literals
+          - id: check-case-conflict
+          - id: check-executables-have-shebangs
+          - id: check-json
+          - id: check-merge-conflict
+          - id: check-shebang-scripts-are-executable
+          - id: check-symlinks
+          - id: check-toml
+          - id: check-vcs-permalinks
+          - id: check-xml
+          - id: check-yaml
+            exclude: '^tests/data/data_model/[^/]+\.ya?ml$'
+          - id: debug-statements
+          - id: destroyed-symlinks
+          - id: end-of-file-fixer
+          - id: fix-byte-order-marker
+          - id: trailing-whitespace
+    - repo: https://github.com/psf/black-pre-commit-mirror
+      rev: 24.1.1
+      hooks:
+          - id: black
+    - repo: https://github.com/PyCQA/isort
+      rev: 5.13.2
+      hooks:
+          - id: isort
+    - repo: https://github.com/PyCQA/docformatter
+      rev: v1.7.5
+      hooks:
+          - id: docformatter
+            additional_dependencies:
+                - docformatter[tomli]
+    - repo: https://github.com/PyCQA/pydocstyle
+      rev: 6.3.0
+      hooks:
+          - id: pydocstyle
+            exclude: "^tests/"
+            additional_dependencies:
+                - pydocstyle[toml]
+    - repo: https://github.com/pre-commit/mirrors-mypy
+      rev: v1.8.0
+      hooks:
+          - id: mypy
+    - repo: https://github.com/Lucas-C/pre-commit-hooks
+      rev: v1.5.4
+      hooks:
+          - id: insert-license
+            name: Insert license headers (shell-style comments)
+            files: '(?:^|/)(?:.*\.(?:py|sh|toml|ya?ml)|Dockerfile|Makefile)$'
+            exclude: '(?:^|/)\..+|^docs/Makefile$'
+            args:
+                - --detect-license-in-X-top-lines=15
+                - --license-filepath
+                - LICENSES/.license_header.txt
+                - --comment-style
+                - "#"
+          - id: insert-license
+            name: Insert license headers (XML-style comments)
+            files: '\.(?:html|md|xml)$'
+            exclude: '(?:^|/)\..+'
+            args:
+                - --detect-license-in-X-top-lines=15
+                - --license-filepath
+                - LICENSES/.license_header.txt
+                - --comment-style
+                - "<!--| ~| -->"
+          - id: insert-license
+            name: Insert license headers (C-style comments)
+            files: '\.(?:css|js|ts)$'
+            exclude: '(?:^|/)\..+'
+            args:
+                - --detect-license-in-X-top-lines=15
+                - --license-filepath
+                - LICENSES/.license_header.txt
+                - --comment-style
+                - "/*| *| */"
+          - id: insert-license
+            name: Insert license headers (reST comments)
+            files: '\.rst$'
+            exclude: '(?:^|/)\..+'
+            args:
+                - --detect-license-in-X-top-lines=15
+                - --license-filepath
+                - LICENSES/.license_header.txt
+                - --comment-style
+                - "..|  |"
+    - repo: https://github.com/fsfe/reuse-tool
+      rev: v3.0.1
+      hooks:
+          - id: reuse
+    - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
+      rev: v9.11.0
+      hooks:
+          - id: commitlint
+            stages: [commit-msg]