The WikiText Security plugin addresses security concerns that arise from permitting arbitrary HTML in description fields in Jenkins.. The plugin allows you to enter descriptions in one of multiple wiki markup languages.
Jenkins lets users enter description fields in HTML as shown in Setting up project-specific descriptions. For some teams that have policy preferences towards writing wiki over HTML, this plugin allows you to use one of several well-known wiki markup formats in place of HTML.
Supported wiki markup languages
The WikiText plugin supports the following wiki markup languages today:
-
Confluence. See Confluence Wiki Markup for more information on Confluence Wiki Markup syntax.
-
MediaWiki. See Help:Formatting for more information on MediaWiki syntax.
-
Twiki. See TWiki Text Formatting for more information on Twiki syntax.
-
Textile. See Textile for more information on Textile syntax.
-
TracWiki. See WikiFormatting for more information on TracWiki syntax.
Configuring the desired wiki language
To select the desired wiki language, navigate to Manage Jenkins > Configure Global Security, and under Markup Formatter select the language from the supported wiki languages.
Using the plugin
Once the plugin is installed and configured, select add description on a particular project and enter the description in the preferred wiki markup language. WikiText usage uses the wiki markup to render the description in bold. Wikitext output shows the corresponding output.
