Viewing release notes fail due to ParseErrorException

Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.

Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.

*Except Fisheye and Crucible

The information in this page relates to customizations in Jira. Consequently, Atlassian Support cannot guarantee to provide 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:

1 2 3 4 5 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

  1. Verify if modified templates are being used for release note generation:

    1. Browse to JIRA System Info to check if the list of modified files contains Velocity templates (.vm files)

    2. You could also open the $JIRA_HOME/jira-config.properties file and check whether the properties jira.releasenotes.templates and/or jira.releasenotes.templatenames are/is defined.

  2. Check each of the modified files for formatting errors and fix them.

  3. You might need to restart JIRA to ensure that the modified templates are used.

Updated on April 8, 2025

Still need help?

The Atlassian Community is here for you.