Child pages
  • Project Description Setter Plugin

Due to some maintenance issues, this service has been switched in read-only mode, you can find more information about the why

and how to migrate your plugin documentation in this blogpost

Skip to end of metadata
Go to start of metadata

Plugin Information

View Project Description Setter on the plugin site for more information.

Change log


  • Set the project description using a file in the workspace
  • Use Token Macro tokens in the file to replace dynamic values, eg ${ENV,var="JENKINS_URL"}
  • File is read and description set at the end of the build - the file can be generated during the build
  • Matrix (Multi-configuration) projects supported in Jenkins 1.426 onwards
  • Use with PegDown Formatter Plugin to format the description with Markdown and prevent XSS (by selecting SUPPRESS_ALL_HTML)


Set the default Filename and Charset in Manage Jenkins > Configure System in the section titled Project description setter defaults

Enable the plugin by checking the box next to Set a project description from a file in the workspace in the Build Environment section of a project configuration.


The location of the file relative to the workspace root
The Filename can include Token Macro tokens which will be resolved before the description is set (ie, before a Markup formatter is invoked)

Advanced options
Disable tokens

Do not parse the description file for Token Macro tokens (tokens will still be expanded in the filename field)


Select the charset (character set and character-encoding) for the file

Change log

1.2 (Jan 13, 2017)

1.1 (12/06/2012)

  • Add option to disable token parsing of the contents of the description file JENKINS-14088
  • Enable environment and build variable token replacement

1.0 (05/08/2011)

  • Initial release

Questions, Comments, Bugs and Feature Requests

Please post questions or comments about this plugin to the Jenkins User mailing list.
To report a bug or request an enhancement to this plugin please create a ticket in JIRA.


  1. Unknown User (ryg_)

    I don't see  descriptor and any messages in log on matrix task.

  2. Unknown User (theandrewducker)

    JEP-200 seems to have killed this plugin for us.

    We get the following:

    java.lang.IllegalArgumentException: Null charset name
    	at java.nio.charset.Charset.lookup(Unknown Source)
    	at java.nio.charset.Charset.forName(Unknown Source)
    	at org.jenkinsCi.plugins.projectDescriptionSetter.DescriptionSetterWrapper.readFile(

    This was after Jenkins told us we had old data that wasn't supported, and pointed us at Plugins affected by fix for JEP-200

    Is this something that can be fixed?