add desc for pomFiles parameter (#32)

jenkinsci · Oct 1, 2022 · 861727c · 861727c
1 parent 9495063
commit 861727c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -39,9 +39,10 @@ or
 ```
 mavenSnapshotCheck check: 'true'
 ```
-or
+or, you can customize the pomFiles parameter to check only the specified pom files 
+(If the pomFiles parameter is not defined, its default value is `pom.xml, * */pom.xml`)
 ```
-mavenSnapshotCheck check: 'true', pomFiles: 'pom.xml'
+mavenSnapshotCheck check: 'true', pomFiles: 'pom.xml,sub-dir/pom.xml'
 ```
 
 # Bug reports

diff --git a/README.zh.md b/README.zh.md
@@ -37,9 +37,10 @@ step([$class: 'MavenSnapshotCheck', check: 'true'])
 ```
 mavenSnapshotCheck check: 'true'
 ```
-或者
+或者，可以自定义 pomFiles 参数，用来只对指定的 pom 文件进行检查
+（如果未定义 pomFiles 参数，它的默认值是 `pom.xml,**/pom.xml`）
 ```
-mavenSnapshotCheck check: 'true', pomFiles: 'pom.xml'
+mavenSnapshotCheck check: 'true', pomFiles: 'pom.xml,sub-dir/pom.xml'
 ```
 
 # Bug 报告