Skip to content

Commit b60086c

Browse files
authored
Update README.md
1 parent 958e5a5 commit b60086c

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
1-
## Action that finds Python 3 syntax errors and undefined names
2-
A GitHub Action that runs selected [flake8](http://flake8.pycqa.org) tests on the Python code in your repo.
3-
If there are ___syntax errors or undefined names___ found in your Python code then this Action will fail.
1+
# GitHub Action for running Flake8 commands
42

5-
Example workflow (Put the following text into `.github/main.workflow`):
6-
```
3+
You can run any [Flake8](http://flake8.pycqa.org) command you need.
4+
5+
Example workflow (Put the following text into the file `.github/main.workflow` in your repo):
6+
```hcl
77
workflow "New workflow" {
88
on = "push"
9-
resolves = ["Find Python 3 syntax errors and undefined names"]
9+
resolves = ["Flake8 command"]
1010
}
1111
12-
action "Find Python 3 syntax errors and undefined names" {
13-
uses = "cclauss/Find-Python-syntax-errors-action@master"
12+
action "Flake8 command" {
13+
uses = "cclauss/GitHub-Action-for-Flake8@master"
14+
args = "flake8 ."
1415
}
1516
```
16-
## Flake8 finds Python 3 syntax errors and undefined names
17+
18+
Or to use Flake8 to find Python 3 syntax errors and undefined names, try:
19+
1720
$ __flake8 . --count --select=E901,E999,F821,F822,F823 --show-source --statistics__
1821

1922
__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.

0 commit comments

Comments
 (0)