check_license_header.yaml

#
# Distributed Linear Algebra with Future (DLAF)
#
# Copyright (c) 2018-2024, ETH Zurich
# All rights reserved.
#
# Please, refer to the LICENSE file in the root directory.
# SPDX-License-Identifier: BSD-3-Clause
#

name: Check license

on: [pull_request]

jobs:
  check-licenses:
    runs-on: ubuntu-24.04

    steps:
      - uses: actions/javascript-action@v1
      - uses: actions/checkout@v4

      - name: Check file extensions
        if: always()          # needed so that it runs even if previous one fails
        run: |
          # Highlight if in these folders there are files with other extensions.
          # Hidden files are excluded from the check.
          find src include test miniapp ! -path 'miniapp/cmake/*' -type f         \
               ! '('                                                              \
                       -name '*.cpp'                                              \
                   -o  -name '*.h'                                                \
                   -o  -name '*.h.in'                                             \
                   -o  -name '*.tpp'                                              \
                   -o  -name '*.cu'                                               \
                   -o  -name '*.c'                                                \
                   -o  -name 'CMakeLists.txt'                                     \
                   -o  -name '.*'                                                 \
               ')'                                                                \
            > result-extension.check
          # Generate an error message for each file with an unkown extension
          for filepath in `cat result-extension.check`; do                        \
            echo "::error file=$filepath,line=1::check extension of $filepath";   \
          done

          test ! -s result-extension.check

      - name: Check license in source code
        if: always()          # needed so that it runs even if previous one fails
        run: |
          # Compare first lines of each source file with reference in misc/HEADER
          find src include test miniapp -type f                                   \
               '('                                                                \
                       -name '*.cpp'                                              \
                   -o  -name '*.h'                                                \
                   -o  -name '*.h.in'                                             \
                   -o  -name '*.tpp'                                              \
                   -o  -name '*.cu'                                               \
                   -o  -name '*.c'                                                \
               ')'                                                                \
            | xargs -I{} sh -c                                                    \
                ".github/check_license.sh misc/HEADER {} > /dev/null || echo {}"  \
            > result-cpp.check

          # Generate an error message for each offending file
          for filepath in `cat result-cpp.check`; do                              \
            echo "::error file=$filepath,line=1::check the license in $filepath"; \
          done

          test ! -s result-cpp.check

      - name: Check license in files using "#" comments
        if: always()          # needed so that it runs even if previous one fails
        run: |
          # Generate header license CMake/Python compliant (with hashes)
          sed 's|^//|#|g' misc/HEADER > HEADER_HASH

          # Check license in files that should have the license at the very beginning
          find  '(' -type f ! -path './misc*' ')'                                 \
                '('                                                               \
                        -name 'CMakeLists.txt'                                    \
                    -o  -name '*.cmake'                                           \
                    -o  -name '*.cmake.in'                                        \
                    -o  -name '*.yaml'                                            \
                ')'                                                               \
            | xargs -I{} sh -c                                                    \
                ".github/check_license.sh HEADER_HASH {} > /dev/null || echo {}"  \
            >> result.check

          # Check license in scripts which may start with #! shebang and other directives
          find -type f '(' -name '*.py' -o -name '*.sh' ')'                           \
            | xargs -I{} sh -c                                                        \
                ".github/check_license.sh -r 4 HEADER_HASH {} > /dev/null || echo {}" \
            >> result.check

          # Generate an error message for each offending file
          for filepath in `cat result.check`; do                                  \
            echo "::error file=$filepath,line=1::check the license in $filepath"; \
          done

          test ! -s result.check