diff --git a/README.md b/README.md index df49eb1..97b78c2 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,21 @@ [![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/text-finder.svg)](https://plugins.jenkins.io/text-finder) [![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/text-finder.svg)](https://plugins.jenkins.io/text-finder) -This plugin lets you search keywords in the files you specified and use that to downgrade a "successful" build to be unstable or a failure. - -This is handy when you have some tools in your build chain that don't use the exit code properly. - -The search is always performed, even on builds which returned a non-zero exit status, but the reclassification only applies to builds which returned an overall exit status of zero. - - -See the documentation and release notes at [Text-finder Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Text-finder+Plugin) on the Jenkins Wiki for more information. - - - - +This plugin lets you search for some text using regular expressions in a set of +files or the console log. Once a match is found, you can downgrade a successful +build to a status of +[unstable](https://javadoc.jenkins-ci.org/hudson/model/Result.html#UNSTABLE), +[failure](https://javadoc.jenkins-ci.org/hudson/model/Result.html#FAILURE), or +[not built](https://javadoc.jenkins-ci.org/hudson/model/Result.html#NOT_BUILT). + +For example, you can search for the string `failure` in a set of log files. If +a match is found, you can downgrade the build from success to failure. This is +handy when you have some tools in your build chain that don't properly set the +exit code. + +Note that the search is always performed, even on builds which returned a +non-zero exit status, but the reclassification only applies to builds which +geturned an overall exit status of zero. + +See [the Text Finder Plugin page](https://wiki.jenkins-ci.org/display/JENKINS/Text-finder+Plugin) +on the Jenkins wiki for more information. diff --git a/src/main/webapp/help.html b/src/main/webapp/help.html index 0852fc4..af1a052 100644 --- a/src/main/webapp/help.html +++ b/src/main/webapp/help.html @@ -1,7 +1,21 @@

- This plugin can be used to search for some text using regular expressions - on a set of files. For example, it can be used to search for the string - "failure" in a set of log files. + This plugin lets you search for some text using regular expressions in a set + of files or the console log. Once a match is found, you can downgrade a + successful build to a status of + unstable, + failure, or + not built.

-
\ No newline at end of file +

+ For example, you can search for the string failure in a set of + log files. If a match is found, you can downgrade the build from success to + failure. This is handy when you have some tools in your build chain that + don't properly set the exit code. +

+

+ Note that the search is always performed, even on builds which returned a + non-zero exit status, but the reclassification only applies to builds which + geturned an overall exit status of zero. +

+