Skip to content

Commit 0cb9c4e

Browse files
authored
Update README.md
1 parent bf87792 commit 0cb9c4e

File tree

1 file changed

+7
-17
lines changed

1 file changed

+7
-17
lines changed

README.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,18 @@
1-
# GitHub Action for running Flake8 commands
1+
# GitHub Action for running cpplint commands
22

3-
Each time that new code is pushed into your repo, you can have a [Flake8](http://flake8.pycqa.org) command automatically run.
3+
Each time that new code is pushed into your repo, you can have a [cpplint](https://github.com/cpplint/cpplint) command automatically run.
44

55
Example workflow:
66
* Put the following text into a file named `.github/main.workflow` in your repo):
77
```hcl
88
workflow "New workflow" {
99
on = "push"
10-
resolves = ["Flake8 command"]
10+
resolves = ["cpplint command"]
1111
}
1212
13-
action "Flake8 command" {
14-
uses = "cclauss/GitHub-Action-for-Flake8@master"
15-
args = "flake8 . --max-line-length=88"
13+
action "cpplint command" {
14+
uses = "cclauss/GitHub-Action-for-cpplint@master"
15+
args = "cpplint ."
1616
}
1717
```
18-
19-
Or to use [Flake8](http://flake8.pycqa.org) to find Python 3 syntax errors and undefined names, try:
20-
21-
$ __flake8 . --count --select=E901,E999,F821,F822,F823 --show-source --statistics__
22-
23-
__E901,E999,F821,F822,F823__ are the "_showstopper_" [flake8](http://flake8.pycqa.org) issues that can halt the runtime with a SyntaxError, NameError, etc. These 5 are different from most other flake8 issues which are merely "style violations" -- useful for readability but they do not effect runtime safety.
24-
* F821: undefined name `name`
25-
* F822: undefined name `name` in `__all__`
26-
* F823: local variable name referenced before assignment
27-
* E901: SyntaxError or IndentationError
28-
* E999: SyntaxError -- failed to compile a file into an Abstract Syntax Tree
18+
Or to add other [cpplint options](http://flake8.pycqa.org) to __args =__ above.

0 commit comments

Comments
 (0)