diff --git a/.github/workflows/cpplint_modified_files.yml b/.github/workflows/cpplint_modified_files.yml index f4b1e276e..d8fd59ad1 100644 --- a/.github/workflows/cpplint_modified_files.yml +++ b/.github/workflows/cpplint_modified_files.yml @@ -1,8 +1,9 @@ -# GitHub Action that allows for gradual compliance with cpplint as only files added or -# modified are checked. -# 1. runs cpplint only on those files that have been modified vs. origin/master -# 2. compiles with g++ only on those files that have been modified vs. origin/master -# 3. Other optional filepath verifications can be commented out at the end of this file. +# GitHub Action that enables a repo to achieve gradual compliance with cpplint by +# linting only those files that have been added or modified (vs. origin/master). +# 1. runs cpplint only on those files that have been modified vs. origin/master. +# 2. compiles with g++ only those files that have been modified vs. origin/master. +# 3. other optional filepath verifications may be commented out at the end of this file. +# From: https://github.com/cpplint/GitHub-Action-for-cpplint name: cpplint_modified_files on: [push, pull_request] @@ -12,7 +13,7 @@ jobs: steps: - uses: actions/checkout@v1 - uses: actions/setup-python@v1 - - shell: python # Show shell: python version and then upgrade shell: python to Python 3.8 + - shell: python # Show the version of shell: python and then upgrade shell: python to Python 3.8 run: import sys ; print("Python {}.{}.{}".format(*sys.version_info)) # Legacy Python :-( - run: sudo update-alternatives --install /usr/bin/python python ${pythonLocation}/bin/python3.8 10 - run: python -m pip install cpplint @@ -25,14 +26,14 @@ jobs: import subprocess import sys - print("Python {}.{}.{}".format(*sys.version_info)) # Python 3.8.0 + print("Python {}.{}.{}".format(*sys.version_info)) # Python 3.8 with open("git_diff.txt") as in_file: modified_files = sorted(in_file.read().splitlines()) print("{} files were modified.".format(len(modified_files))) cpp_exts = tuple(".c .c++ .cc .cpp .cu .cuh .cxx .h .h++ .hh .hpp .hxx".split()) cpp_files = [file for file in modified_files if file.lower().endswith(cpp_exts)] - print("{} C++ files were modified.".format(len(cpp_files))) + print(f"{len(cpp_files)} C++ files were modified.") if not cpp_files: sys.exit(0) @@ -46,17 +47,17 @@ jobs: upper_files = [file for file in cpp_files if file != file.lower()] if upper_files: - print("{} files contain uppercase characters:".format(len(upper_files))) + print(f"{len(upper_files)} files contain uppercase characters:") print("\n".join(upper_files) + "\n") space_files = [file for file in cpp_files if " " in file or "-" in file] if space_files: - print("{} files contain space or dash characters:".format(len(space_files))) + print(f"{len(space_files)} files contain space or dash characters:") print("\n".join(space_files) + "\n") nodir_files = [file for file in cpp_files if file.count(os.sep) != 1] if nodir_files: - print("{} files are not in one and only one directory:".format(len(nodir_files))) + print(f"{len(nodir_files)} files are not in one and only one directory:") print("\n".join(nodir_files) + "\n") bad_files = len(upper_files + space_files + nodir_files)