Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve writing of plugin description #28

Merged
merged 1 commit into from
Jun 1, 2019
Merged

Improve writing of plugin description #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
returned 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.
22 changes: 18 additions & 4 deletions src/main/webapp/help.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
<div>
<p>
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
<a href="https://javadoc.jenkins-ci.org/hudson/model/Result.html#UNSTABLE">unstable</a>,
<a href="https://javadoc.jenkins-ci.org/hudson/model/Result.html#FAILURE">failure</a>, or
<a href="https://javadoc.jenkins-ci.org/hudson/model/Result.html#NOT_BUILT">not built</a>.
</p>
</div>
<p>
For example, you can search for the string <code>failure</code> 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.
</p>
<p>
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
returned an overall exit status of zero.
</p>
</div>