2019-12-05 15:13:36 +08:00
|
|
|
# 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
|
2019-12-05 14:18:36 +08:00
|
|
|
|
2019-11-28 17:27:27 +08:00
|
|
|
name: cpplint_modified_files
|
2019-11-27 21:17:48 +08:00
|
|
|
on: [push, pull_request]
|
|
|
|
jobs:
|
2019-11-28 17:27:27 +08:00
|
|
|
cpplint_modified_files:
|
2019-11-27 21:17:48 +08:00
|
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
2020-03-01 22:03:32 +08:00
|
|
|
- uses: actions/checkout@v1 # v2 is broken for git diff
|
2019-12-05 14:18:36 +08:00
|
|
|
- uses: actions/setup-python@v1
|
2019-11-28 17:27:27 +08:00
|
|
|
- run: python -m pip install cpplint
|
2020-02-17 21:04:32 +08:00
|
|
|
- run: git remote -v
|
|
|
|
- run: git branch
|
2020-03-01 22:03:32 +08:00
|
|
|
- run: git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
|
2020-03-01 22:05:34 +08:00
|
|
|
- run: git diff origin/master --name-only > git_diff.txt
|
2019-11-28 17:27:27 +08:00
|
|
|
- name: cpplint_modified_files
|
2019-11-27 21:17:48 +08:00
|
|
|
shell: python
|
|
|
|
run: |
|
|
|
|
import os
|
2019-11-28 17:27:27 +08:00
|
|
|
import subprocess
|
2019-11-27 21:17:48 +08:00
|
|
|
import sys
|
2019-11-28 17:27:27 +08:00
|
|
|
|
2019-12-05 15:13:36 +08:00
|
|
|
print("Python {}.{}.{}".format(*sys.version_info)) # Python 3.8
|
2019-11-27 21:17:48 +08:00
|
|
|
with open("git_diff.txt") as in_file:
|
2019-11-28 17:27:27 +08:00
|
|
|
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)]
|
2019-12-05 15:13:36 +08:00
|
|
|
print(f"{len(cpp_files)} C++ files were modified.")
|
2019-11-28 17:27:27 +08:00
|
|
|
if not cpp_files:
|
|
|
|
sys.exit(0)
|
|
|
|
|
|
|
|
print("cpplint:")
|
2019-12-04 15:24:07 +08:00
|
|
|
subprocess.run(["cpplint", "--filter=-legal/copyright"] + cpp_files, check=True, text=True)
|
|
|
|
|
|
|
|
print("g++:")
|
|
|
|
# compile_exts = tuple(".c .c++ .cc .cpp .cu .cxx".split())
|
|
|
|
# compile_files = [file for file in cpp_files if file.lower().endswith(compile_exts)]
|
|
|
|
subprocess.run(["g++"] + cpp_files, check=True, text=True)
|
2019-11-27 21:17:48 +08:00
|
|
|
|
2019-11-28 21:34:13 +08:00
|
|
|
upper_files = [file for file in cpp_files if file != file.lower()]
|
2019-11-27 21:17:48 +08:00
|
|
|
if upper_files:
|
2019-12-05 15:13:36 +08:00
|
|
|
print(f"{len(upper_files)} files contain uppercase characters:")
|
2019-11-27 21:17:48 +08:00
|
|
|
print("\n".join(upper_files) + "\n")
|
|
|
|
|
2019-11-28 21:34:13 +08:00
|
|
|
space_files = [file for file in cpp_files if " " in file or "-" in file]
|
2019-11-27 21:17:48 +08:00
|
|
|
if space_files:
|
2019-12-05 15:13:36 +08:00
|
|
|
print(f"{len(space_files)} files contain space or dash characters:")
|
2019-11-27 21:17:48 +08:00
|
|
|
print("\n".join(space_files) + "\n")
|
|
|
|
|
2019-11-28 21:34:13 +08:00
|
|
|
nodir_files = [file for file in cpp_files if file.count(os.sep) != 1]
|
2019-11-27 21:17:48 +08:00
|
|
|
if nodir_files:
|
2019-12-05 15:13:36 +08:00
|
|
|
print(f"{len(nodir_files)} files are not in one and only one directory:")
|
2019-11-27 21:17:48 +08:00
|
|
|
print("\n".join(nodir_files) + "\n")
|
|
|
|
|
|
|
|
bad_files = len(upper_files + space_files + nodir_files)
|
|
|
|
if bad_files:
|
|
|
|
sys.exit(bad_files)
|