Use a pre-commit workflow to check style (precice#478)

Author: fsimonis

.github/workflows/check-markdown.yml

@@ -0,0 +1,31 @@
+name: Check style
+on:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+    branches:
+      - master
+      - develop
+jobs:
+  check_style:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout preCICE
+        uses: actions/checkout@v4
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+         python-version: '3.10'
+         check-latest: true
+      - name: Install pre-commit
+        run: pip install pre-commit
+      - name: Run checks
+        run: pre-commit run -a -v
+      - name: Git status
+        if: always()
+        run: git status
+      - name: Full diff
+        if: always()
+        run: git diff

.github/workflows/check-pep8.yml

@@ -8,9 +8,9 @@ repos:
   rev: v0.30.0
   hooks:
     - id: markdownlint
-      files: "^(.*/)?README.md"
+      exclude: changelog-entries
     - id: markdownlint-fix
-      files: "^(.*/)?README.md"
+      exclude: changelog-entries
 - repo: https://github.com/hhatto/autopep8
   rev: v2.0.4
   hooks:
@@ -20,15 +20,25 @@ repos:
   rev: 'v8.0.1'
   hooks:
   - id: clang-format
+- repo: https://github.com/koalaman/shellcheck-precommit
+  rev: v0.10.0
+  hooks:
+    - id: shellcheck
+      args: [ --external-sources, --exclude=SC1091 ]
 - repo: local
   hooks:
     - id: check-image-naming
       name: check image names
       language: python
       entry: tools/check-image-names.py
       files: ".*/images/.*"
-- repo: https://github.com/koalaman/shellcheck-precommit
-  rev: v0.10.0
-  hooks:
-    - id: shellcheck
-      args: [ --external-sources, --exclude=SC1091 ]
+    - id: check-size
+      name: check sizes
+      language: script
+      entry: tools/check-size.sh
+      pass_filenames: false
+    - id: check-names
+      name: check file names
+      language: script
+      entry: tools/check.sh
+      pass_filenames: false

.github/workflows/check-scripts.yaml

@@ -9,7 +9,7 @@ tutorials=$(find . -maxdepth 1 -type d -not -name ".*" | grep -vE $IGNORE | sed
 
 for tutorial in $tutorials; do
   # Check permalinks
-  docs=$(find "./$tutorial" -maxdepth 1 -type f -name "*.md" -print0 | xargs grep -l "permalink:" | sed "s/^.\///")
+  docs=$(find "./$tutorial" -maxdepth 1 -type f -name "*.md" -print0 | xargs -0 grep -l "permalink:" | sed "s/^.\///")
   for doc in $docs; do
     link=$(grep "permalink:" "$doc" | sed "s/permalink: \+//")
     prefix="tutorials-$tutorial"
@@ -40,7 +40,7 @@ for tutorial in $tutorials; do
 done
 
 # Check quickstart
-docs=$(find ./quickstart -maxdepth 1 -type f -name "*.md" -print0 | xargs grep -l "permalink:" | sed "s/^.\///")
+docs=$(find ./quickstart -maxdepth 1 -type f -name "*.md" -print0 | xargs -0 grep -l "permalink:" | sed "s/^.\///")
 for doc in $docs; do
   link=$(grep "permalink:" "$doc" | sed "s/permalink: \+//")
   prefix="quickstart"