check-code-style.yml

# This workflow is intended to check if PR conforms with coding standards used
# in the project.
#
# Documentation for GitHub Actions:
# [workflow-syntax]: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions
# [context-and-expression-syntax]: https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions
# [workflow-commands]: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions

# name: Check code style

# on:
#   pull_request:
#     branches:
#       - main
#       - llvm_release_*
#     paths-ignore: # no need to check formatting for:
#       - 'docs/**' # documentation
#       - 'test/**' # tests
#       - '**.md'   # README
#       - '**.txt'  # CMakeLists.txt
#       - '**/check-**-build.yml' # Other workflows

# env:
#   # We need compile command database in order to perform clang-tidy check. So,
#   # in order to perform configure step we need to setup llvm-dev package. This
#   # env variable used to specify desired version of it
#   LLVM_VERSION: 20

# jobs:
#   clang-format-and-tidy:
#     name: clang-format & clang-tidy
#     runs-on: ubuntu-20.04
#     steps:
#     - name: Checkout sources
#       uses: actions/checkout@v4
#       with:
#         # In order to gather diff from PR we need to fetch not only the latest
#         # commit. Depth of 2 is enough, because GitHub Actions supply us with
#         # merge commit as {{ github.sha }}, i.e. the second commit is a merge
#         # base between target branch and PR
#         fetch-depth: 2

#     - name: Gather list of changes
#       id: gather-list-of-changes
#       run: |
#         git diff -U0 --no-color ${{ github.sha }}^ -- include lib \
#             ':(exclude)include/LLVMSPIRVExtensions.inc' \
#             ':(exclude)lib/SPIRV/libSPIRV/SPIRVErrorEnum.h' \
#             ':(exclude)lib/SPIRV/libSPIRV/SPIRVOpCodeEnum.h' \
#             ':(exclude)lib/SPIRV/libSPIRV/SPIRVOpCodeEnumInternal.h' \
#             > diff-to-inspect.txt
#         if [ -s diff-to-inspect.txt ]; then
#           # Here we set an output of our step, which is used later to either
#           # perform or skip further steps, i.e. there is no sense to install
#           # clang-format if PR hasn't changed .cpp files at all
#           # See [workflow-commands] for reference
#           echo '::set-output name=HAS_CHANGES::true'
#         fi

#     - name: Install dependencies
#       if: ${{ steps.gather-list-of-changes.outputs.HAS_CHANGES }}
#       run: |
#         # clang-tidy requires compile command database in order to be properly
#         # launched, so, we need to setup llvm package to perform cmake
#         # configuration step to generate that database
#         curl -L "https://apt.llvm.org/llvm-snapshot.gpg.key" | sudo apt-key add -
#         echo "deb https://apt.llvm.org/focal/ llvm-toolchain-focal main" | sudo tee -a /etc/apt/sources.list
#         sudo apt-get update
#         sudo apt-get install -yqq \
#             clang-format-${{ env.LLVM_VERSION }} clang-tidy-${{ env.LLVM_VERSION }} \
#             clang-tools-${{ env.LLVM_VERSION }} llvm-${{ env.LLVM_VERSION }}-dev \
#             libomp-${{ env.LLVM_VERSION }}-dev libllvmlibc-${{ env.LLVM_VERSION }}-dev \
#             mlir-${{ env.LLVM_VERSION }}-tools libpolly-${{ env.LLVM_VERSION }}-dev \

#     - name: Generate compile command database
#       if: ${{ steps.gather-list-of-changes.outputs.HAS_CHANGES }}
#       run: |
#         mkdir build && cd build
#         cmake -DCMAKE_CXX_COMPILER=clang++-${{ env.LLVM_VERSION }} \
#             -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DCMAKE_BUILD_TYPE=Release -G "Unix Makefiles" ${{ github.workspace }}

#     - name: Run clang-format
#       if: ${{ steps.gather-list-of-changes.outputs.HAS_CHANGES }}
#       id: run-clang-format
#       run: |
#         cat diff-to-inspect.txt | /usr/share/clang/clang-format-${{ env.LLVM_VERSION }}/clang-format-diff.py \
#             -p1 -binary clang-format-${{ env.LLVM_VERSION }}

#     - name: Run clang-tidy
#       # By some reason, GitHub Actions automatically include "success()"
#       # expression into an "if" statement if it doesn't contain any of job
#       # status check functions. This is why this and following steps has
#       # "always()" and "failure()" in "if" conditions.
#       # See "Job status check functions" in [context-and-expression-syntax]
#       if: ${{ always() && steps.gather-list-of-changes.outputs.HAS_CHANGES }}
#       id: run-clang-tidy
#       run: |
#         cat diff-to-inspect.txt | /usr/lib/llvm-${{ env.LLVM_VERSION }}/share/clang/clang-tidy-diff.py \
#             -p1 -clang-tidy-binary clang-tidy-${{ env.LLVM_VERSION }} -quiet \
#             -path ${{ github.workspace}}/build

#     - name: Upload patch with clang-format fixes
#       uses: actions/upload-artifact@v4
#       if: ${{ failure() && steps.run-clang-format.outcome == 'failure' }}
#       with:
#         name: clang-format.patch
#         path: clang-format.patch
#         if-no-files-found: ignore

#     - name: Upload clang-tidy log
#       uses: actions/upload-artifact@v4
#       if: ${{ failure() && steps.run-clang-tidy.outcome == 'failure' }}
#       with:
#         name: clang-tidy.log
#         path: clang-tidy.log
#         if-no-files-found: ignore