Add format suggestions to CI (trixi-framework#2118)

* Start

* Update .github/workflows/FormatCheck.yml

Co-authored-by: Hendrik Ranocha <[email protected]>

* Update .github/workflows/FormatCheck.yml

Co-authored-by: Hendrik Ranocha <[email protected]>

* Update .github/workflows/FormatCheck.yml

Co-authored-by: Hendrik Ranocha <[email protected]>

* Fix

* Sample

* Revert

* Revert

---------

Co-authored-by: Hendrik Ranocha <[email protected]>
Co-authored-by: Huiyu Xie <[email protected]>
Co-authored-by: Michael Schlottke-Lakemper <[email protected]>

Author: 4 people

.github/workflows/FormatCheck.yml

@@ -1,4 +1,4 @@
-name: format-check
+name: Format suggestions
 
 on:
   push:
@@ -8,37 +8,10 @@ on:
   pull_request:
 
 jobs:
-  check-format:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        julia-version: [1]
-        julia-arch: [x86]
-        os: [ubuntu-latest]
+  format-suggestions:
+    runs-on: ubuntu-latest
     steps:
-      - uses: julia-actions/setup-julia@latest
-        with:
-          version: ${{ matrix.julia-version }}
-
       - uses: actions/checkout@v4
-      - name: Install JuliaFormatter and format
-        # This will use the latest version by default but you can set the version like so:
-        #
-        # julia  -e 'using Pkg; Pkg.add(PackageSpec(name = "JuliaFormatter", version = "0.13.0"))'
-        #
-        # TODO: Change the call below to
-        #       format(".")
-        run: |
-          julia  -e 'using Pkg; Pkg.add(PackageSpec(name = "JuliaFormatter", version="1.0.60"))'
-          julia  -e 'using JuliaFormatter; format(["benchmark", "examples", "ext", "src", "test", "utils"])'
-      - name: Format check
-        run: |
-          julia -e '
-          out = Cmd(`git diff --name-only`) |> read |> String
-          if out == ""
-              exit(0)
-          else
-              @error "Some files have not been formatted !!!"
-              write(stdout, out)
-              exit(1)
-          end'
+      - uses: julia-actions/julia-format@v3
+        with:
+          version: "1.0.60"