Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosnizolli authored Jul 17, 2023
1 parent 6e852d5 commit 09b15ea
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,30 @@
[Robocop](https://robocop.readthedocs.io/en/stable/
) is a tool that performs static code analysis of Robot Framework code.


Example:
### Usage

- uses: actions/checkout@v3

- name: Run RoboCop
uses: carlosnizolli/RoboCop@v01
with:
max-warnings: 30
path: Dir/Tests1 Dir/Tests2
path: Back/Tests Front
argumentfile: .github/robocop-arguments.txt

### Arguments:

- max-warnings: Required argument, maximum number of warnings allowed.
By default, it blocks any critical error, this can be changed in the arguments file;
- path: Indicates the location to be scanned, location of robot files. When not informed, all files in the repository will be analyzed;
- argumentfile: Text file with list of arguments.

#### Argument file example:

--exclude 0302
--exclude 0913
--exclude 0508
--exclude 0305
--configure too-many-arguments:max_args:6
--configure too-many-calls-in-keyword:max_calls:15

0 comments on commit 09b15ea

Please sign in to comment.