From 2baa472bcc35427d3bbe759554f224cef4feeef0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Ho=C5=99e=C5=88ovsk=C3=BD?= Date: Fri, 6 Nov 2020 15:36:26 +0100 Subject: [PATCH] Add GitHub action to check that include guards use standard pattern Based on work by @innerout, but finished and merged by me, because the GitHub action refused to run for him. Closes #2075 Closes #2091 --- .github/workflows/validate-header-guards.yml | 33 ++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/workflows/validate-header-guards.yml diff --git a/.github/workflows/validate-header-guards.yml b/.github/workflows/validate-header-guards.yml new file mode 100644 index 00000000..c57bd8f3 --- /dev/null +++ b/.github/workflows/validate-header-guards.yml @@ -0,0 +1,33 @@ +name: Check header guards + +# Run this workflow every time a new commit pushed to your repository + +on: [push, pull_request] + +jobs: + # Set the job key. The key is displayed as the job name + # when a job name is not provided + checkguard: + # Name the Job + name: Check include guard naming convention + # Set the type of machine to run on + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Setup Dependencies + uses: actions/setup-python@v2 + with: + python-version: '3.7' + - name: Install checkguard + run: pip install guardonce + + - name: Run checkguard + run: | + wrong_files=$(checkguard -r src/catch2/ -p "name | append _INCLUDED | upper") + if [[ $wrong_files ]]; then + echo "Files with wrong header guard:" + echo $wrong_files + exit 1 + fi