Skip to content

Commit 585a009

Browse files
committed
Update readme with skip folder details
Signed-off-by: Riddhesh Sanghvi <riddhesh237@gmail.com>
1 parent 36eba5a commit 585a009

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,15 @@ Allowed options:
9999
- `"autoapprove-php-nonfunctional-changes`
100100

101101
For more details please check the documentation for [all options here](https://github.com/automattic/vip-go-ci#configuration-via-repository-config-file).
102+
102103
## Skipping PHPCS scanning for specific folders
103104

104105
You can add files to the root of the repository indicating folders that should not be scanned. For PHPCS, the file should be named `.vipgoci_phpcs_skip_folders`. For PHP Linting the file should be named `.vipgoci_lint_skip_folders`. Please ensure both files are located in the root of the repository.
105106

107+
This can be used as an alternate to `SKIP_FOLDERS` env variable.
108+
109+
**Please note** that the folders exlcuded in the PHPCS xml file do not work in this action, you can check the reason [here](https://github.com/rtCamp/action-phpcs-code-review/issues/29#issuecomment-623933663). Instead you should add all the folders to be excluded in either `SKIP_FOLDERS` env or `.vipgoci_phpcs_skip_folders` file.
110+
106111
List each folder to be skipped on individual lines within those files.
107112

108113
i.e:

0 commit comments

Comments
 (0)