Uncrustify PR Check Update (#969)

* Update uncrustify to use version other repos use, clean up the way it runs, formatting changes to needed files
* Moving the lexicon.txt to where it lives in all other repos
* Removing executable permissions from .c files
---------

Author: Skptak

.github/workflows/ci.yml

@@ -61,43 +61,21 @@ jobs:
           PATH=$PATH:main/tools/spell
           # Make sure that the portable directory is not included in the spellcheck.
           sed -i 's/find $DIRNAME/find $DIRNAME -not -path '*portable*'/g' main/tools/spell/find-unknown-comment-words
-          find-unknown-comment-words --directory tcp/ --lexicon tcp/.github/lexicon.txt
+          find-unknown-comment-words --directory tcp/ --lexicon tcp/lexicon.txt
           if [ "$?" = "0" ]; then
             exit 0
           else
             exit 1
           fi
 
   formatting:
-    # Use only 18.04 since we want the uncrustify version to
-    # be 0.66.1_f to ensure proper formatting.
     runs-on: ubuntu-20.04
-    container: ubuntu:18.04
     steps:
-      - uses: actions/checkout@v3
-      - name: Install Uncrustify
-        run: apt-get update && apt-get install uncrustify
-      - name: Run Uncrustify
-        run: |
-          uncrustify --version
-          find . -iname "*.[hc]" -exec uncrustify --check -c tools/uncrustify.cfg {} +
-          if [ "$?" = "0" ]; then
-            exit 0
-          else
-            echo -e "\033[31;1;43mFormatting check (using Uncrustify) failed...\033[0m"
-            echo -e "\033[32;3mTo have the code uncrustified for you, please comment '/bot run uncrustify' (without the quotes) on the Pull Request.\033[0m"
-            exit 1
-          fi
-      - name: Check For Trailing Whitespace
-        run: |
-          set +e
-          grep --exclude="README.md" -rnI -e "[[:blank:]]$" .
-          if [ "$?" = "0" ]; then
-            echo "Files have trailing whitespace."
-            exit 1
-          else
-            exit 0
-          fi
+      - uses: actions/checkout@v2
+      - name: Check formatting
+        uses: FreeRTOS/CI-CD-Github-Actions/formatting@main
+        with:
+          path: ./
 
   doxygen:
     runs-on: ubuntu-latest

.github/workflows/uncrustify.yml

@@ -8,8 +8,7 @@ jobs:
   Uncrustify:
     name: Run_Uncrustify
     if: ${{ github.event.issue.pull_request && github.event.comment.body == '/bot run uncrustify' }}
-    runs-on: ubuntu-20.04
-    container: ubuntu:18.04
+    runs-on: ubuntu-latest
     steps:
       - name: Dump GitHub context
         env:
@@ -41,16 +40,35 @@ jobs:
            repository: ${{ steps.upstreamrepo.outputs.RemoteRepo }}
            ref: ${{ steps.upstreambranch.outputs.branchname }}
       - name: Install Uncrustify
-        run: apt-get update && apt-get --assume-yes install uncrustify
+        run: |
+          : # Install Uncrustify
+          echo "::group::Install Uncrustify"
+          sudo apt-get update && apt-get --assume-yes install uncrustify
+          echo "::endgroup::"
       - name: Run Uncrustify
         run: |
+          : # Uncrustify on C files while ignoring symlinks.
+          : # Make a collapsible section in the log to run uncrustify
+          echo "::group::Uncrustify Check"
           uncrustify --version
           find .  -iname "*.[hc]" -exec uncrustify -c tools/uncrustify.cfg --no-backup --replace {} +
+          echo "::endgroup::"
+          echo -e "\033[32;3mUncrustify Formatting Applied\033[0m"
       - name: Push changes to upstream repository
         run: |
+          : # Push changes to upstream repository
+          echo "::group::Push changes to upstream repository"
           git config --global --add safe.directory '*'
           git config --global user.name 'GitHub Action'
           git config --global user.email '[email protected]'
           git add -A
           git commit -m "Uncrustify: triggered by comment."
+          echo "::endgroup::"
           git push
+          if [ "$?" = "0" ]; then
+            echo -e "\033[32;3mPushed formatting changes, don't forget to run 'git pull'!\033[0m"
+            exit 0
+          else
+            echo -e "\033[32;31mFailed to push the formatting changes\033[0m"
+            exit 1
+          fi