i#7344: Skip format checks if DISABLE_FORMAT_CHECKS is present in commit messages. (#7361)

Skip clang-format, vera and tab checks if DISABLE_FORMAT_CHECKS appears
in one of the commit messages.
This feature enables us to copy code over without format changes as a
base line and use subsequent PRs to fix format issues. And it is useful
to add .patch files or other files where tabs are part of the format.

Format checks can also be disabled by setting DISABLE_FORMAT_CHECKS to
ON, for example,
cmake -DDISABLE_FORMAT_CHECKS=ON ...

Test: I added DISABLE_FORMAT_CHECKS as part of a commit message to
#7304 and verified format
checks were disabled except aarch64 build.

"gh api" is not installed on the aarchxx machines. Adding "gh" to the
install list didn't work, and manually installing gh or github-cli
failed using tmate. I have added a TODO in
.github/workflows/ci-aarchxx.yml to add the support once "gh api" is
installed.

The original PR #7345 was reverted because
github.event.pull_request._links.commits.href is absent in case of
push/merge.
This PR handles the push/merge case by using
```
  if ${{ contains(toJSON(github.event.commits.*.message), 'DISABLE_FORMAT_CHECKS') }}
```
for push.
 
Test: 
- I added DISABLE_FORMAT_CHECKS as part of a commit message in a clone
repository, ivankyluk/dynamorio, to verify format checks were disable
when DISABLE_FORMAT_CHECKS was added as a commit message. And formats
checks were enabled when DISABLE_FORMAT_CHECKS was absent.
- I used the cloned repository to test the push/merge event.

Issue: #7344

Author: ivankyluk

.github/actions/are-format-checks-disabled/action.yml

@@ -0,0 +1,67 @@
+# **********************************************************
+# Copyright (c) 2025 Google, Inc.  All rights reserved.
+# **********************************************************
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of Google, Inc. nor the names of its contributors may be
+#   used to endorse or promote products derived from this software without
+#   specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL VMWARE, INC. OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+# DAMAGE.
+
+# Check if DISABLE_FORMAT_CHECKS appears in the PR commit messages.
+# Set disable_format_checks to "yes" if it does, "no" otherwise.
+outputs:
+  disable_format_checks:
+    description: |
+      'disable_format_checks is set to yes if format checks are disabled.'
+    value: ${{ steps.are_format_checks_disabled.outputs.disable_format_checks }}
+
+runs:
+  using: composite
+  steps:
+    - uses: actions/checkout@v4
+    - id: are_format_checks_disabled
+      name: Check if format checks are disabled.
+      env:
+        GH_TOKEN: ${{ github.token }}
+        GITHUB_REPOSITORY: ${{ github.repository }}
+      run: |
+        found=no
+        if ${{ github.event_name == 'pull_request' }}; then
+          commit_messages="$(gh api '${{ github.event.pull_request._links.commits.href }}' --paginate --jq .[].commit.message)"
+          if echo "$commit_messages" | grep -q "DISABLE_FORMAT_CHECKS"; then
+            found=yes
+          fi
+        elif ${{ github.event_name == 'push' }}; then
+          if ${{ contains(toJSON(github.event.commits.*.message), 'DISABLE_FORMAT_CHECKS') }}; then
+            found=yes
+          fi
+        fi
+        if [[ "$found" == "yes" ]]; then
+          echo "disable_format_checks=yes" >> $GITHUB_OUTPUT
+          echo "format checks are disabled."
+        else
+          echo "disable_format_checks=no" >> $GITHUB_OUTPUT
+          echo "format checks are enabled."
+        fi
+      shell: bash

.github/workflows/ci-aarchxx-cross.yml

@@ -94,13 +94,18 @@ jobs:
       with:
         cmakeVersion: '3.26.4'
 
+    - name: Check if format checks are disabled
+      id: are_format_checks_disabled
+      uses: ./.github/actions/are-format-checks-disabled
+
     - name: Run Suite
       working-directory: ${{ github.workspace }}
       run: ./suite/runsuite_wrapper.pl automated_ci 64_only
       env:
         DYNAMORIO_CROSS_AARCHXX_LINUX_ONLY: yes
         CI_TRIGGER: ${{ github.event_name }}
         CI_BRANCH: ${{ github.ref }}
+        DISABLE_FORMAT_CHECKS: ${{ steps.are_format_checks_disabled.outputs.disable_format_checks }}
 
   # ARM cross-compile with gcc, with some tests run under QEMU.
   # We use a more recent Ubuntu for a more recent QEMU.
@@ -143,13 +148,18 @@ jobs:
       with:
         cmakeVersion: '3.26.4'
 
+    - name: Check if format checks are disabled
+      id: are_format_checks_disabled
+      uses: ./.github/actions/are-format-checks-disabled
+
     - name: Run Suite
       working-directory: ${{ github.workspace }}
       run: ./suite/runsuite_wrapper.pl automated_ci 32_only
       env:
         DYNAMORIO_CROSS_AARCHXX_LINUX_ONLY: yes
         CI_TRIGGER: ${{ github.event_name }}
         CI_BRANCH: ${{ github.ref }}
+        DISABLE_FORMAT_CHECKS: ${{ steps.are_format_checks_disabled.outputs.disable_format_checks }}
 
   # Android ARM cross-compile with gcc, no tests:
   android-arm-cross-compile:
@@ -190,13 +200,18 @@ jobs:
       with:
         cmakeVersion: '3.26.4'
 
+    - name: Check if format checks are disabled
+      id: are_format_checks_disabled
+      uses: ./.github/actions/are-format-checks-disabled
+
     - name: Run Suite
       working-directory: ${{ github.workspace }}
       env:
         DYNAMORIO_CROSS_ANDROID_ONLY: yes
         DYNAMORIO_ANDROID_TOOLCHAIN: /tmp/android-gcc-arm-ndk-10e
         CI_TRIGGER: ${{ github.event_name }}
         CI_BRANCH: ${{ github.ref }}
+        DISABLE_FORMAT_CHECKS: ${{ steps.are_format_checks_disabled.outputs.disable_format_checks }}
       run: ./suite/runsuite_wrapper.pl automated_ci 32_only
 
   # Android AArch64 cross-compile with LLVM, no tests:
@@ -231,6 +246,10 @@ jobs:
       with:
         cmakeVersion: '3.26.4'
 
+    - name: Check if format checks are disabled
+      id: are_format_checks_disabled
+      uses: ./.github/actions/are-format-checks-disabled
+
     - name: Run Suite
       working-directory: ${{ github.workspace }}
       env:
@@ -239,6 +258,7 @@ jobs:
         DYNAMORIO_ANDROID_API_LEVEL: 35
         CI_TRIGGER: ${{ github.event_name }}
         CI_BRANCH: ${{ github.ref }}
+        DISABLE_FORMAT_CHECKS: ${{ steps.are_format_checks_disabled.outputs.disable_format_checks }}
       run: ./suite/runsuite_wrapper.pl automated_ci 64_only
 
   # AArch64 drdecode and drmemtrace on x86:
@@ -269,13 +289,18 @@ jobs:
       with:
         cmakeVersion: '3.26.4'
 
+    - name: Check if format checks are disabled
+      id: are_format_checks_disabled
+      uses: ./.github/actions/are-format-checks-disabled
+
     - name: Run Suite
       working-directory: ${{ github.workspace }}
       run: ./suite/runsuite_wrapper.pl automated_ci
       env:
         DYNAMORIO_A64_ON_X86_ONLY: yes
         CI_TRIGGER: ${{ github.event_name }}
         CI_BRANCH: ${{ github.ref }}
+        DISABLE_FORMAT_CHECKS: ${{ steps.are_format_checks_disabled.outputs.disable_format_checks }}
 
   send-failure-notification:
       uses: ./.github/workflows/failure-notification.yml

.github/workflows/ci-aarchxx.yml

@@ -118,6 +118,8 @@ jobs:
         with:
           cmakeVersion: '3.26.4'
 
+      # TODO i#7344: Check if we should skip clang format checks and vera tests
+      # after gh api is installed.
       - name: Run Suite
         working-directory: build
         run: ../suite/runsuite_wrapper.pl travis

.github/workflows/ci-clang-format.yml

@@ -81,8 +81,13 @@ jobs:
         sudo apt-get -y install doxygen vera++ zlib1g-dev libsnappy-dev \
           liblz4-dev clang-format-14 libunwind-dev
 
+    - name: Check if format checks are disabled
+      id: are_format_checks_disabled
+      uses: ./.github/actions/are-format-checks-disabled
+
     - name: Run Suite
       working-directory: ${{ github.workspace }}
+      if: ${{ steps.are_format_checks_disabled.outputs.disable_format_checks !=  'yes' }}
       run: ./suite/runsuite_wrapper.pl automated_ci 64_only require_format
       env:
         DYNAMORIO_CROSS_AARCHXX_LINUX_ONLY: no

.github/workflows/ci-osx.yml

@@ -76,6 +76,10 @@ jobs:
       run: |
         brew install nasm zlib snappy lz4
 
+    - name: Check if format checks are disabled
+      id: are_format_checks_disabled
+      uses: ./.github/actions/are-format-checks-disabled
+
     - name: Run Suite
       working-directory: ${{ github.workspace }}
       run: ./suite/runsuite_wrapper.pl automated_ci 64_only
@@ -89,6 +93,7 @@ jobs:
         DEVELOPER_DIR: /Applications/Xcode_14.1.app/Contents/Developer
         CI_TRIGGER: ${{ github.event_name }}
         CI_BRANCH: ${{ github.ref }}
+        DISABLE_FORMAT_CHECKS: ${{ steps.are_format_checks_disabled.outputs.disable_format_checks }}
 
   send-failure-notification:
       uses: ./.github/workflows/failure-notification.yml

.github/workflows/ci-riscv64.yml

@@ -96,6 +96,10 @@ jobs:
           sudo rsync -av ../extract/lib/riscv64-linux-gnu/ /usr/riscv64-linux-gnu/lib/; \
         fi
 
+    - name: Check if format checks are disabled
+      id: are_format_checks_disabled
+      uses: ./.github/actions/are-format-checks-disabled
+
     - name: Run Suite
       working-directory: ${{ github.workspace }}
       run: ./suite/runsuite_wrapper.pl automated_ci 64_only
@@ -104,6 +108,7 @@ jobs:
         CI_TRIGGER: ${{ github.event_name }}
         CI_BRANCH: ${{ github.ref }}
         QEMU_LD_PREFIX: /usr/riscv64-linux-gnu/
+        DISABLE_FORMAT_CHECKS: ${{ steps.are_format_checks_disabled.outputs.disable_format_checks }}
 
   send-failure-notification:
       uses: ./.github/workflows/failure-notification.yml

.github/workflows/ci-windows.yml

@@ -83,6 +83,10 @@ jobs:
         md c:\projects\install
         (New-Object System.Net.WebClient).DownloadFile("https://github.com/ninja-build/ninja/releases/download/v1.10.2/ninja-win.zip", "c:\projects\install\ninja.zip")
 
+    - name: Check if format checks are disabled
+      id: are_format_checks_disabled
+      uses: ./.github/actions/are-format-checks-disabled
+
     - name: Run Suite
       working-directory: ${{ github.workspace }}
       run: |
@@ -97,6 +101,7 @@ jobs:
       env:
         CI_TRIGGER: ${{ github.event_name }}
         CI_BRANCH: ${{ github.ref }}
+        DISABLE_FORMAT_CHECKS: ${{ steps.are_format_checks_disabled.outputs.disable_format_checks }}
 
   ###########################################################################
   # 64-bit VS2019 and tests:
@@ -126,6 +131,10 @@ jobs:
         md c:\projects\install
         (New-Object System.Net.WebClient).DownloadFile("https://github.com/ninja-build/ninja/releases/download/v1.10.2/ninja-win.zip", "c:\projects\install\ninja.zip")
 
+    - name: Check if format checks are disabled
+      id: are_format_checks_disabled
+      uses: ./.github/actions/are-format-checks-disabled
+
     - name: Run Suite
       working-directory: ${{ github.workspace }}
       run: |
@@ -140,6 +149,7 @@ jobs:
       env:
         CI_TRIGGER: ${{ github.event_name }}
         CI_BRANCH: ${{ github.ref }}
+        DISABLE_FORMAT_CHECKS: ${{ steps.are_format_checks_disabled.outputs.disable_format_checks }}
 
   ###########################################################################
   # 32-bit and 64-bit VS2019 release builds:
@@ -169,6 +179,10 @@ jobs:
         md c:\projects\install
         (New-Object System.Net.WebClient).DownloadFile("https://github.com/ninja-build/ninja/releases/download/v1.10.2/ninja-win.zip", "c:\projects\install\ninja.zip")
 
+    - name: Check if format checks are disabled
+      id: are_format_checks_disabled
+      uses: ./.github/actions/are-format-checks-disabled
+
     - name: Run Suite
       working-directory: ${{ github.workspace }}
       run: |
@@ -183,6 +197,7 @@ jobs:
       env:
         CI_TRIGGER: ${{ github.event_name }}
         CI_BRANCH: ${{ github.ref }}
+        DISABLE_FORMAT_CHECKS: ${{ steps.are_format_checks_disabled.outputs.disable_format_checks }}
 
   send-failure-notification:
       uses: ./.github/workflows/failure-notification.yml