Viewing release notes fail due to ParseErrorException
The information on this page relates to customizations in JIRA Applications. Consequently, Atlassian Support cannot guarantee the provision of any support for the steps described on this page as customizations are not covered under Atlassian Support Offerings. Please be aware that this material is provided for your information only and that you use it at your own risk.
Also, please be aware that customizations done by directly modifying files are not included in the upgrade process. These modifications will need to be reapplied manually on the upgraded instance.
Symptoms
The release notes page in JIRA gives the following error:
2014-06-03 15:17:36,377 Processor1 ERROR bjaison 917x650x1 nvkafz 116.90.138.219 /secure/ReleaseNote.jspa [velocity] ResourceManager.getResource() parse exception: org.apache.velocity.exception.ParseErrorException: Lexical error: org.apache.velocity.runtime.parser.TokenMgrError: Lexical error at line xx, column xxx.
at com.atlassian.velocity.DefaultVelocityManager.getEncodedBody(DefaultVelocityManager.java:61)
at com.atlassian.velocity.DefaultVelocityManager.getBody(DefaultVelocityManager.java:46)
at com.atlassian.jira.project.util.ReleaseNoteManager.getReleaseNote(ReleaseNoteManager.java:148)
...Cause
The velocity template parser is unable to parse the Velocity templates. This is usually due to customisations that break the template format.
Resolution
- Verify if modified templates are being used for release note generation:
- Browse to JIRA System Info to check if the list of modified files contains Velocity templates (.vm files)
You could also open the
$JIRA_HOME/jira-config.propertiesfile and check whether the propertiesjira.releasenotes.templatesand/orjira.releasenotes.templatenamesare/is defined.
Check each of the modified files for formatting errors and fix them.
You might need to restart JIRA to ensure that the modified templates are used.