Add an option to apply pre-commit and clang-tidy fixes

.github/workflows/build_doc.yaml

@@ -52,12 +52,26 @@ jobs:
       with:
         folder: docs_build
         target-folder: latest
+
+    - name: Find Comment
+      uses: peter-evans/find-comment@v1
+      id: fc
+      with:
+        issue-number: ${{ github.event.pull_request.number }}
+        comment-author: 'github-actions[bot]'
+
     - name: Comment PR
       uses: thollander/actions-comment-pull-request@v2
+      if: steps.fc.outputs.comment-id == ''
       with:
         message: |
-          Deployed test documentation to https://exasim-project.com/NeoFOAM/Build_PR_${{ env.PR_NUMBER }}
+          Thank you for your PR, here are some useful tips:
+          - Use labels to change the workflow behavior. Set `auto-fix` to automatically apply fixes, `full-ci` for a comprehensive set of tests and sanitizer runs, `ready-for-review` to show that you're done and need a review.
+          - I deployed a test documentation to https://exasim-project.com/NeoFOAM/Build_PR_${{ env.PR_NUMBER }}
+          - For `full-ci` builds benchmark results are available at https://github.com/exasim-project/NeoFOAM-BenchmarkData/${{ env.PR_NUMBER }}
+          - If this is your first PR, please add yourself to the AUTHORS.md file
         comment_tag: build_url
+        mode: createIfNotExists
 
     - name: Echo Build PR URL
       run: |

.github/workflows/static_checks.yaml

@@ -1,12 +1,45 @@
 name: Static checks
 run-name: Static checks
-
 on:
     pull_request:
-      types: [opened, synchronize]
+      types: [opened,synchronize,labeled]
+env:
+ BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
+permissions:
+  contents: write
 jobs:
+  pre-commit-run:
+    name: Pre-commit run
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        ref: ${{env.BRANCH_NAME}}
+    - name: Install dependencies
+      run: |
+        sudo apt update
+        sudo apt install \
+           pre-commit
+        pip install identify --upgrade
+        pre-commit install
+    - name: Run pre-commit on all files
+      id: pre-commit
+      run: pre-commit run --all --color always --verbose
+    - name: Commit pre-commit fixes
+      if: ${{contains(github.event.pull_request.labels.*.name, 'auto-fix') && failure() && steps.pre-commit.conclusion == 'failure'}}
+      run: |
+         git config user.name github-actions
+         git config user.email [email protected]
+         git add .
+         git commit -m 'fix format'
+         git push origin ${{env.BRANCH_NAME}}
+    - name: check for todo fixme note
+      run: |
+        NTODOS="$(grep -r 'TODO DONT MERGE' --exclude-dir=.github | wc -l)"
+        echo "Found $NTODOS TODO DONT MERGE notes"
+        ! grep -q -r "TODO DONT MERGE" --exclude-dir=.github
   build-compilation-db:
-    if: ${{!contains(github.event.pull_request.labels.*.name, 'Skip-build')}}
+    if: ${{!contains(github.event.pull_request.labels.*.name, 'Skip-build') }}
     name: Build with IWYU
     runs-on: ubuntu-latest
     steps:
@@ -55,6 +88,8 @@ jobs:
     needs: [build-compilation-db]
     steps:
     - uses: actions/checkout@v4
+      with:
+        ref: ${{env.BRANCH_NAME}}
 
     - name: Add clang repo
       run: |
@@ -88,8 +123,8 @@ jobs:
           | grep -F -f pattern - > files
         # run clang-tidy on all specified files
         clang-tidy-16 --fix --extra-arg=-w -p build/develop $(cat files)
-
     - name: Check for fixes
+      id: tidy-fixes
       run: |
         if [[ $(git ls-files -m | wc -l) -eq 0 ]]; then
           exit 0
@@ -98,25 +133,15 @@ jobs:
         echo "Please use your local clang-tidy or apply the following patch:"
         git diff -p
         exit 1
-  pre-commit-run:
-    name: Pre-commit run
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-    - name: Install dependencies
+    - name: Commit clang-tidy-fixes
+      if: ${{contains(github.event.pull_request.labels.*.name, 'auto-fix') && failure() && steps.tidy-fixes.conclusion == 'failure'}}
       run: |
-        sudo apt update
-        sudo apt install \
-           pre-commit
-        pip install identify --upgrade
-        pre-commit install
-    - name: Run pre-commit on all files
-      run: pre-commit run --all --color always --verbose
-    - name: check for todo fixme note
-      run: |
-        NTODOS="$(grep -r 'TODO DONT MERGE' --exclude-dir=.github | wc -l)"
-        echo "Found $NTODOS TODO DONT MERGE notes"
-        ! grep -q -r "TODO DONT MERGE" --exclude-dir=.github
+         rm pattern files
+         git config user.name github-actions
+         git config user.email [email protected]
+         git add .
+         git commit -m 'fix format'
+         git push origin ${{ github.BRANCH_NAME }}
   changelog:
     if: ${{!contains(github.event.pull_request.labels.*.name, 'Skip-Changelog')}}
     name: Changelog check

.gitignore

@@ -73,3 +73,4 @@ NeoFOAM/*
 _build
 
 .vs/
+*.key

doc/contributing.rst

@@ -67,7 +67,8 @@ The following labels and their meaning are discussed here:
  * ``Skip-Changelog``: Don't check whether the changelog has been updated. Use this label if the changes are not any new features or bug-fixes.
  * ``Skip-build``: Don't run any build steps, including building the compile commands database.
  * ``Skip-cache``: Don't cache the build folders. Forces to rebuild the build folder after every push to GitHub.
- * ``full-ci``: Run tests on AWS.
+ * ``full-ci``: Run tests on AWS and enable sanitizer workflows.
+ * ``auto-fix``: Apply changes from pre-commit and clang-tidy.
 
 A full list of the labels can be found `here <https://github.com/exasim-project/NeoFOAM/labels>`_.