Skip to content

Commit

Permalink
Add markup formatter description to README
Browse files Browse the repository at this point in the history
Include details of the markup formatters that have been tested and a
warning to existing users that they may need to enable the safe HTML
formatter.
  • Loading branch information
MarkEWaite committed Oct 12, 2024
1 parent 6d2621d commit f6e02a7
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
# Groovy postbuild plugin

This plugin executes a groovy script in the Jenkins JVM as a post-build action (a publisher) .
This plugin executes a groovy script in the Jenkins JVM as a post-build action (a publisher).
Typically, the script checks some conditions and updates the build result, puts badges next to the build in the build history, and/or displays information on the build summary page.

The plugin honors the [markup formatter](https://www.jenkins.io/doc/book/security/markup-formatter/) defined in Jenkins.
Markup formatters that have been tested with the plugin include:

* Plain text formatter, the Jenkins default
* Safe HTML formatter, provided by the [OWASP markup formatter plugin](https://plugins.jenkins.io/antisamy-markup-formatter)
* [Markdown](https://en.wikipedia.org/wiki/Markdown) formatter, provided by the [Markdown formatter plugin](https://plugins.jenkins.io/markdown-formatter/)

Releases 228.vcdb_cf7265066 and before applied a subset of safe HTML formatting with no alternative formatter.
Users upgrading to newer releases may need to install the [OWASP markup formatter plugin](https://plugins.jenkins.io/antisamy-markup-formatter) and enable the safe HTML formatter in order to have the same interpretation of the text in their groocy postbuild scripts.

## Usage

The groovy script can use the variable `manager`, which provides various methods to decorate your builds.
Expand Down

0 comments on commit f6e02a7

Please sign in to comment.