#8 update readme to suggest open push event by default (#9)

* #8 update readme to suggest open push event by default

* Push capable (#14)

* Output exit code (#10)
* solution for #7
* parameterize EXIT_CODE
* fix bash function calls; switch to the new docker image
* fix bash array length syntax
* oops need that apt update
* ok now change the test code a bit
* check output is working
* fix bad yml syntax
* is it being set at all?
* use a string instead of an integer
* fix bash logic syntax
* single square brackets are the old way to do logic
* review changes
* add output var info to the readme
* Update demo.cpp
* Revert action to upstream master
* fix dockerfile from image not exist
* solution for #7
* parameterize EXIT_CODE
* fix bash function calls; switch to new docker image
* check output is working
* show me some env vars
* trigger on push events
* switch action to push-capable branch
* echo the JSON that lives on the runner
* use cat instead of echo
* remove backticks
* use alpine while debugging git events
* Revert "use alpine while debugging git events"
This reverts commit fbbb1b5a6f8a80f8d4245ebce07d7048ff74fedd.
* test push compatibility
* provide version input
* docker uses tags
* oops update run_checks.sh
* fix jq args on push
* test push src change
* test src change w/ GH checkout
* fix filename output for push events (w/ checkouts)
* test new comment body
* gotta break that bad habit
* check against src change
* use sed directly instead of sed then cat
* tidy docs lied
* don't know why sed isn't working
* try multiple ARG options
* try to replace the docker file
* maybe without dyn var
* bad domain?
* nope needs a docker:// domain
* reverting changes to docker file FROM
* fix clang-format output to file
* test on src changes
* list clang-fmt warnings per file
* add demo.h and adjust comment body
* make test action use default extensions
* don't checkout repo on test action
* stay in working dir. DL into a hidden file
* organize output better
* adjust output again
* fix output; switch back to checkout repo
* enforce CPP syntax in the filename (no checkout)
* sed taking too much out of the path in clang-tidy out
* that's better (checkout is faster)
* segregate script into functions
* oops uncomment from debugging locally
* show me a long diff
* show me a split diff
* clean-up (ready for PR)
* update readme
* remove the version from user inputs
* only apply clang-tidy checks if it was specified
* switch test action back to upstream
* add version for user input

Co-authored-by: Brendan <[email protected]>

Author: shenxianpeng

.gitattributes

@@ -0,0 +1,8 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+*.py text eol=lf
+*.rst text eol=lf
+*.sh text eol=lf

.github/workflows/test.yml

@@ -1,19 +1,18 @@
 name: Test action
 
-on: [pull_request]
+on: [push, pull_request]
 
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      # - uses: actions/checkout@v2
+      - uses: actions/checkout@v2
       - uses: shenxianpeng/cpp-linter-action@master
         id: linter
-        with:
-          style: file
-          extensions: 'cpp'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          style: file
 
       - name: Fail fast?!
         if: steps.linter.outputs.checks-failed > 0

.gitignore

@@ -1,2 +1,3 @@
-clang-format-report.txt
-clang-tidy-report.txt
+.cpp_linter_action_changed_files.json
+clang_format_report.txt
+clang_tidy_report.txt

Dockerfile

@@ -1,4 +1,8 @@
-FROM xianpengshen/clang-tools:11
+FROM xianpengshen/clang-tools:all
+
+# WORKDIR option is set by the github action to the environment variable GITHUB_WORKSPACE.
+# See https://docs.github.com/en/actions/creating-actions/dockerfile-support-for-github-actions#workdir
+
 
 LABEL com.github.actions.name="cpp-linter check"
 LABEL com.github.actions.description="Lint your code with clang-tidy in parallel to your builds"
@@ -13,4 +17,8 @@ RUN apt-get -y install curl jq
 
 COPY runchecks.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh
+
+# github action args use the CMD option
+# See https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsargs
+# also https://docs.docker.com/engine/reference/builder/#cmd
 ENTRYPOINT [ "/entrypoint.sh" ]

README.md

@@ -6,12 +6,13 @@ Github Actions for linting the C/C++ code. Integrated clang-tidy, clang-format c
 
 Just create a `yml` file under your GitHub repository. For example `.github/workflows/cpp-linter.yml`
 
-!!! Requires `secrets.GITHUB_TOKEN` set to an environment variable name "GITHUB_TOKEN".
+!!! Requires `secrets.GITHUB_TOKEN` set to an environment variable named `GITHUB_TOKEN`.
 
 ```yml
 name: cpp-linter
 
-on: [pull_request]
+# Triggers the workflow on push or pull request events
+on: [push, pull_request]
 jobs:
   cpp-linter:
     name: cpp-linter
@@ -30,6 +31,13 @@ jobs:
 |------------|---------------|-------------|
 | style | 'llvm' | The style rules to use. Set this to 'file' to have clang-format use the closest relative .clang-format file. |
 | extensions | 'c,h,C,H,cpp,hpp,cc,hh,c++,h++,cxx,hxx' | The file extensions to run the action against. This is a comma-separated string. |
+| tidy-checks | 'boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-*,cppcoreguidelines-*' | A string of regex-like patterns specifying what checks clang-tidy will use.|
+| repo-root | '.' | The relative path to the repository root directory. This path is relative to path designated by the runner's GITHUB_WORKSPACE environment variable. |
+| version | '10' | The desired version of the clang tools to use. Accepted options are strings which can be 6.0, 7, 8, 9, 10, 11, 12. |
+
+### Outputs
+
+This action creates 1 output variable named `checks-failed`. Even if the linting checks fail for source files this action will still pass, but users' CI workflows can use this action's output to exit the workflow early if that is desired.
 
 ### Outputs
 

action.yml

@@ -5,14 +5,33 @@ branding:
   icon: 'check-circle'
   color: 'green'
 inputs:
-  style: # the specific style rules
-    description: "The style rules to use (defaults to 'llvm'). Set this to 'file' to have clang-format use the closest relative .clang-format file."
+  style:
+    description: >
+      The style rules to use (defaults to 'llvm').
+      Set this to 'file' to have clang-format use the closest relative .clang-format file.
     required: false
     default: 'llvm'
   extensions:
-    description: "The file extensions to run the action against. This comma-separated string defaults to 'c,h,C,H,cpp,hpp,cc,hh,c++,h++,cxx,hxx'."
+    description: >
+      The file extensions to run the action against.
+      This comma-separated string defaults to 'c,h,C,H,cpp,hpp,cc,hh,c++,h++,cxx,hxx'.
     required: false
     default: "c,h,C,H,cpp,hpp,cc,hh,c++,h++,cxx,hxx"
+  tidy-checks:
+    description: >
+      A string of regex-like patterns specifying what checks clang-tidy will use.
+      This defaults to 'boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-*,cppcoreguidelines-*'. See also clang-tidy docs for more info.
+    required: false
+    default: 'boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-*,cppcoreguidelines-*'
+  repo-root:
+    description: >
+      The relative path to the repository root directory. The default value '.' is relative to the runner's GITHUB_WORKSPACE environment variable.
+    required: false
+    default: '.'
+  version:
+    description: "The desired version of the clang tools to use. Accepted options are strings which can be 6.0, 7, 8, 9, 10, 11, 12. Defaults to 10."
+    required: false
+    default: '10'
 outputs:
   checks-failed:
     description: An integer that can be used as a boolean value to indicate if all checks failed.
@@ -22,3 +41,6 @@ runs:
   args:
     - ${{ inputs.style }}
     - ${{ inputs.extensions }}
+    - ${{ inputs.tidy-checks }}
+    - ${{ inputs.repo-root }}
+    - ${{ inputs.version }}

demo/compile_commands.json

@@ -1,7 +1,12 @@
 [
-{
-  "directory": ".",
-  "command": "/usr/bin/g++ -Wall -Werror demo.cpp",
-  "file": "/demo.cpp"
-}
+  {
+    "directory": ".",
+    "command": "/usr/bin/g++ -Wall -Werror demo.cpp",
+    "file": "/demo.cpp"
+  },
+  {
+    "directory": ".",
+    "command": "/usr/bin/g++ -Wall -Werror demo.cpp",
+    "file": "/demo.hpp"
+  }
 ]

demo/demo.cpp

@@ -1,5 +1,5 @@
 /** This is a very ugly test code (doomed to fail linting) */
-
+#include "demo.hpp"
 #include <stdio.h>
 
 
@@ -9,6 +9,8 @@ int main(){
 
     for (;;) break;
 
+
     printf("Hello world!\n");
 
+
     return 0;}

demo/demo.hpp

@@ -0,0 +1,39 @@
+#pragma once
+
+
+
+class Dummy {
+    char* useless;
+    int numb;
+    Dummy() :numb(0), useless("\0"){}
+
+    public:
+    void *not_usefull(char *str){useless = str;}
+};
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+struct LongDiff
+{
+    long diff;
+
+};