From 09b15ea08e5d1d8d513e68ea6e07718bcedd9548 Mon Sep 17 00:00:00 2001 From: Carlos Nizolli <55762776+carlosnizolli@users.noreply.github.com> Date: Sun, 16 Jul 2023 22:46:13 -0300 Subject: [PATCH] Update README.md --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 14e0a35..b731de2 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,7 @@ [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 @@ -13,5 +12,22 @@ Example: 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 +