[CI] Add help for IWYU and clang-tidy. (#4698)

Author: marcalff

.github/workflows/clang-tidy.yaml

@@ -108,6 +108,13 @@ jobs:
           readonly COUNT="$WARNING_COUNT"
           readonly LIMIT="$WARNING_LIMIT"
 
+          # Print instructions to help investigations
+          echo "::notice::See instructions below to investigate warnings"
+          echo "1) Find the previous job in CI, named 'Upload warning report'"
+          echo "2) In the job logs, search for 'Artifact download URL:'"
+          echo "3) Upload the report given by the URL"
+          echo "4) Read the warnings in the report, and adjust the code accordingly."
+
           echo "clang-tidy reported ${COUNT} unique warning(s) with preset '${CMAKE_OPTIONS}'"
           echo "Limit is ${LIMIT}"
 

.github/workflows/iwyu.yml

@@ -85,6 +85,13 @@ jobs:
           echo "include-what-you-use reported ${WARNING_COUNT} warning(s) with cmake options preset '${{ matrix.cmake_options }}'"
           # Acceptable limit, to decrease over time down to 0
           readonly WARNING_LIMIT=${{ matrix.warning_limit }}
+
+          # Print instructions to help investigations
+          echo "::notice::See instructions below to investigate warnings"
+          echo "1) Find the previous job in CI, named 'Build with include-what-you-use'"
+          echo "2) In the job logs, search for 'Warning: include-what-you-use reported diagnostics:'"
+          echo "3) Read the warning messages, and adjust the code accordingly."
+
           # FAIL the build if WARNING_COUNT > WARNING_LIMIT
           if [ $WARNING_COUNT -gt $WARNING_LIMIT ] ; then
             echo "include-what-you-use reported ${WARNING_COUNT} warning(s) exceeding the existing warning limit of ${WARNING_LIMIT} with cmake options preset '${{ matrix.cmake_options }}'"