|
| 1 | +name: Awesome CI Workflow |
| 2 | + |
| 3 | +on: [push] |
| 4 | +# push: |
| 5 | +# branches: [ master ] |
| 6 | +# pull_request: |
| 7 | +# branches: [ master ] |
| 8 | + |
| 9 | +jobs: |
| 10 | + code_format: |
| 11 | + name: Code Formatter |
| 12 | + runs-on: ubuntu-latest |
| 13 | + steps: |
| 14 | + - name: requirements |
| 15 | + run: | |
| 16 | + sudo apt -qq -y update |
| 17 | + sudo apt -qq install clang-format |
| 18 | + - uses: actions/checkout@master |
| 19 | + with: |
| 20 | + submodules: true |
| 21 | + - name: Setup Git Specs |
| 22 | + run: | |
| 23 | + git config --global user.name github-actions |
| 24 | + git config --global user.email '${GITHUB_ACTOR}@users.noreply.github.com' |
| 25 | + git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY |
| 26 | + - name: Filename Formatter |
| 27 | + run: | |
| 28 | + IFS=$'\n' |
| 29 | + for fname in `find . -type f -name '*.cpp' -o -name '*.cc' -o -name '*.h'` |
| 30 | + do |
| 31 | + echo "${fname}" |
| 32 | + new_fname=`echo ${fname} | tr ' ' '_'` |
| 33 | + echo " ${new_fname}" |
| 34 | + new_fname=`echo ${new_fname} | tr 'A-Z' 'a-z'` |
| 35 | + echo " ${new_fname}" |
| 36 | + new_fname=`echo ${new_fname} | tr '-' '_'` |
| 37 | + echo " ${new_fname}" |
| 38 | + new_fname=${new_fname/.cc/.cpp} |
| 39 | + echo " ${new_fname}" |
| 40 | + if [ ${fname} != ${new_fname} ] |
| 41 | + then |
| 42 | + echo " ${fname} --> ${new_fname}" |
| 43 | + git "mv" "${fname}" ${new_fname} |
| 44 | + fi |
| 45 | + done |
| 46 | + git commit -am "formatting filenames $GITHUB_SHA" || true |
| 47 | + - name: Clang Formatter |
| 48 | + run: | |
| 49 | + for fname in $(find . -name '*.cpp' -o -name '*.h') |
| 50 | + do |
| 51 | + clang-format --verbose -i --style="$line1 $line2 $line3 $line4" "$fname" |
| 52 | + done |
| 53 | + git commit -am "formatting source-code for $GITHUB_SHA" || true |
| 54 | + env: |
| 55 | + line1: "{ BasedOnStyle: Google, UseTab: Never," |
| 56 | + line2: "IndentWidth: 4, TabWidth: 4, " |
| 57 | + line3: "AllowShortIfStatementsOnASingleLine: false, IndentCaseLabels: false," |
| 58 | + line4: "ColumnLimit: 80, AccessModifierOffset: -3 }" |
| 59 | + - name: Git Push |
| 60 | + run: git push --force origin HEAD:$GITHUB_REF || true |
| 61 | + |
| 62 | + update_directory_md: |
| 63 | + name: Update Directory.md |
| 64 | + needs: code_format |
| 65 | + runs-on: ubuntu-latest |
| 66 | + steps: |
| 67 | + - uses: actions/checkout@v2 |
| 68 | + - uses: actions/setup-python@v1 |
| 69 | + - name: pull latest commit |
| 70 | + run: git pull |
| 71 | + - name: Update DIRECTORY.md |
| 72 | + shell: python |
| 73 | + run: | |
| 74 | + import os |
| 75 | + from typing import Iterator |
| 76 | +
|
| 77 | + URL_BASE = "https://github.com/TheAlgorithms/C-Plus-Plus/blob/master" |
| 78 | + g_output = [] |
| 79 | +
|
| 80 | + def good_filepaths(top_dir: str = ".") -> Iterator[str]: |
| 81 | + cpp_exts = tuple(".c .c++ .cc .cpp .cu .cuh .cxx .h .h++ .hh .hpp .hxx".split()) |
| 82 | + for dirpath, dirnames, filenames in os.walk(top_dir): |
| 83 | + dirnames[:] = [d for d in dirnames if d[0] not in "._"] |
| 84 | + for filename in filenames: |
| 85 | + if os.path.splitext(filename)[1].lower() in cpp_exts: |
| 86 | + yield os.path.join(dirpath, filename).lstrip("./") |
| 87 | +
|
| 88 | + def md_prefix(i): |
| 89 | + return f"{i * ' '}*" if i else "\n##" |
| 90 | +
|
| 91 | + def print_path(old_path: str, new_path: str) -> str: |
| 92 | + global g_output |
| 93 | + old_parts = old_path.split(os.sep) |
| 94 | + for i, new_part in enumerate(new_path.split(os.sep)): |
| 95 | + if i + 1 > len(old_parts) or old_parts[i] != new_part: |
| 96 | + if new_part: |
| 97 | + g_output.append(f"{md_prefix(i)} {new_part.replace('_', ' ').title()}") |
| 98 | + return new_path |
| 99 | +
|
| 100 | + def build_directory_md(top_dir: str = ".") -> str: |
| 101 | + global g_output |
| 102 | + old_path = "" |
| 103 | + for filepath in sorted(good_filepaths(), key=str.lower): |
| 104 | + filepath, filename = os.path.split(filepath) |
| 105 | + if filepath != old_path: |
| 106 | + old_path = print_path(old_path, filepath) |
| 107 | + indent = (filepath.count(os.sep) + 1) if filepath else 0 |
| 108 | + url = "/".join((URL_BASE, filepath, filename)).replace(" ", "%20") |
| 109 | + filename = os.path.splitext(filename.replace("_", " ").title())[0] |
| 110 | + g_output.append(f"{md_prefix(indent)} [{filename}]({url})") |
| 111 | + return "# List of all files\n" + "\n".join(g_output) |
| 112 | +
|
| 113 | + with open("DIRECTORY.md", "w") as out_file: |
| 114 | + out_file.write(build_directory_md(".") + "\n") |
| 115 | + - name: Update DIRECTORY.md |
| 116 | + run: | |
| 117 | + cat DIRECTORY.md |
| 118 | + git config --global user.name github-actions |
| 119 | + git config --global user.email '${GITHUB_ACTOR}@users.noreply.github.com' |
| 120 | + git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY |
| 121 | + git add DIRECTORY.md |
| 122 | + git commit -am "updating DIRECTORY.md" || true |
| 123 | + git push --force origin HEAD:$GITHUB_REF || true |
| 124 | +
|
| 125 | + # cpplint: |
| 126 | + # name: CPPLINT |
| 127 | + # needs: code_format |
| 128 | + # runs-on: ubuntu-latest |
| 129 | + # steps: |
| 130 | + # - uses: actions/checkout@master |
| 131 | + # - uses: actions/setup-python@master |
| 132 | + # - run: pip install cpplint |
| 133 | + # - run: git pull |
| 134 | + # - run: cpplint --filter=-legal --recursive . |
| 135 | + |
| 136 | + cpplint_modified_files: |
| 137 | + runs-on: ubuntu-latest |
| 138 | + needs: code_format |
| 139 | + name: CPPLINT |
| 140 | + steps: |
| 141 | + - uses: actions/checkout@master # v2 is broken for git diff |
| 142 | + - uses: actions/setup-python@master |
| 143 | + - run: python -m pip install cpplint |
| 144 | + - run: git remote -v |
| 145 | + - run: git branch |
| 146 | + - run: git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY |
| 147 | + - run: git pull |
| 148 | + - run: git diff --diff-filter=dr --name-only origin/master > git_diff.txt |
| 149 | + - run: echo "Files changed-- `cat git_diff.txt`" |
| 150 | + - name: cpplint_modified_files |
| 151 | + shell: python |
| 152 | + run: | |
| 153 | + import os |
| 154 | + import subprocess |
| 155 | + import sys |
| 156 | +
|
| 157 | + print("Python {}.{}.{}".format(*sys.version_info)) # Python 3.8 |
| 158 | + with open("git_diff.txt") as in_file: |
| 159 | + modified_files = sorted(in_file.read().splitlines()) |
| 160 | + print("{} files were modified.".format(len(modified_files))) |
| 161 | +
|
| 162 | + cpp_exts = tuple(".c .c++ .cc .cpp .cu .cuh .cxx .h .h++ .hh .hpp .hxx".split()) |
| 163 | + cpp_files = [file for file in modified_files if file.lower().endswith(cpp_exts)] |
| 164 | + print(f"{len(cpp_files)} C++ files were modified.") |
| 165 | + if not cpp_files: |
| 166 | + sys.exit(0) |
| 167 | +
|
| 168 | + print("cpplint:") |
| 169 | + for cpp_file in cpp_files: |
| 170 | + subprocess.run(["cpplint", "--filter=-legal/copyright,-build/include", cpp_file], check=True, text=True) |
| 171 | +
|
| 172 | + # print("g++:") |
| 173 | + # compile_exts = tuple(".c .c++ .cc .cpp .cu .cxx".split()) |
| 174 | + # compile_files = [file for file in cpp_files if file.lower().endswith(compile_exts)] |
| 175 | + # for cpp_file in cpp_files: |
| 176 | + # subprocess.run(["g++", cpp_file], check=True, text=True) |
| 177 | +
|
| 178 | + upper_files = [file for file in cpp_files if file != file.lower()] |
| 179 | + if upper_files: |
| 180 | + print(f"{len(upper_files)} files contain uppercase characters:") |
| 181 | + print("\n".join(upper_files) + "\n") |
| 182 | +
|
| 183 | + space_files = [file for file in cpp_files if " " in file or "-" in file] |
| 184 | + if space_files: |
| 185 | + print(f"{len(space_files)} files contain space or dash characters:") |
| 186 | + print("\n".join(space_files) + "\n") |
| 187 | +
|
| 188 | + nodir_files = [file for file in cpp_files if file.count(os.sep) != 1] |
| 189 | + if nodir_files: |
| 190 | + print(f"{len(nodir_files)} files are not in one and only one directory:") |
| 191 | + print("\n".join(nodir_files) + "\n") |
| 192 | +
|
| 193 | + bad_files = len(upper_files + space_files + nodir_files) |
| 194 | + if bad_files: |
| 195 | + sys.exit(bad_files) |
| 196 | +
|
| 197 | + build: |
| 198 | + name: Compile checks |
| 199 | + runs-on: ${{ matrix.os }} |
| 200 | + # needs: [cpplint, update_directory_md, cpplint_modified_files] |
| 201 | + needs: [update_directory_md] |
| 202 | + strategy: |
| 203 | + matrix: |
| 204 | + os: [ubuntu-latest, windows-latest, macOS-latest] |
| 205 | + steps: |
| 206 | + - uses: actions/checkout@master |
| 207 | + with: |
| 208 | + submodules: true |
| 209 | + - run: git pull |
| 210 | + - run: cmake -B ./build -S . |
| 211 | + - run: cmake --build build |
0 commit comments