diff --git a/README.md b/README.md index 2079585d..6548f8f5 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,21 @@ Second, the plugin looks for the `CASC_JENKINS_CONFIG` environment variable. The - A full path to a single file. For example, `/var/jenkins_home/casc_configs/jenkins.yaml`. - A URL pointing to a file served on the web. For example, `https://acme.org/jenkins.yaml`. -If `CASC_JENKINS_CONFIG` points to a folder, the plugin will recursively traverse the folder to find file (suffix with .yml,.yaml,.YAML,.YML), but doesn't contain hidden files or hidden subdirectories. It follows symbolic links for both files and directories. +If `CASC_JENKINS_CONFIG` points to a folder, the plugin will recursively traverse the folder to find file(s) with .yml,.yaml,.YAML,.YML suffix. It will exclude hidden files or files that contain a hidden folder in **any part** of the full path. It follows symbolic links for both files and directories. +
Exclusion examples + +`CASC_JENKINS_CONFIG=/jenkins/casc_configs` +:heavy_check_mark: `/jenkins/casc_configs/jenkins.yaml` +:heavy_check_mark: `/jenkins/casc_configs/dir1/config.yaml` +:x: `/jenkins/casc_configs/.dir1/config.yaml` +:x: `/jenkins/casc_configs/..dir2/config.yaml` + +`CASC_JENKINS_CONFIG=/jenkins/.configs/casc_configs` contains hidden folder `.config` +:x: `/jenkins/.configs/casc_configs/jenkins.yaml` +:x: `/jenkins/.configs/casc_configs/dir1/config.yaml` +:x: `/jenkins/.configs/casc_configs/.dir1/config.yaml` +:x: `/jenkins/.configs/casc_configs/..dir2/config.yaml` +
If you do not set the `CASC_JENKINS_CONFIG` environment variable, the plugin will default to looking for a single config file in `$JENKINS_HOME/jenkins.yaml`.