From 585a0098e92f76b3f0ef7ac637bc0c3fc1e06d7e Mon Sep 17 00:00:00 2001 From: Riddhesh Sanghvi Date: Tue, 6 Jul 2021 11:28:10 +0530 Subject: [PATCH] Update readme with skip folder details Signed-off-by: Riddhesh Sanghvi --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 0352d44..e7cc5e3 100644 --- a/README.md +++ b/README.md @@ -99,10 +99,15 @@ Allowed options: - `"autoapprove-php-nonfunctional-changes` For more details please check the documentation for [all options here](https://github.com/automattic/vip-go-ci#configuration-via-repository-config-file). + ## Skipping PHPCS scanning for specific folders 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. +This can be used as an alternate to `SKIP_FOLDERS` env variable. + +**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. + List each folder to be skipped on individual lines within those files. i.e: