Uploaded image for project: 'Jira Data Center'
  1. Jira Data Center
  2. JRASERVER-79171

Standard documentation for "Creating a custom Release Notes template containing release comments" needs an update

XMLWordPrintable

    • Icon: Suggestion Suggestion
    • Resolution: Unresolved
    • None
    • Documentation - All
    • None
    • We collect Jira feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

      Problem Definition

      Looking at the instruction from Creating a custom Release Notes template containing release comments page, it is observed that it is suggested that we should create a custom field under the “Release notes comments” name, but on the provided template of the modified “releasenotes-text.vm” file, you can see the following line: #if($customField.name.equals("release notes comments")) is a case-sensitive comparison.

      Suggested Solution

      • Update the Name of the custom field to "release notes comments" to {}match the one in the .vm template.
      • Add the complete configuration of the custom release notes:
          • Create a backup of the {{velocity-default.properties }}file
          • Add the allowlist under template loaders:
            # ----------------------------------------------------------------------------
            # T E M P L A T E  L O A D E R S
            # ----------------------------------------------------------------------------
            #
            resource.loader.file.allowlist.enabled = true
            # ---------------------------------------------------------------------------- 
          • In the introspector.proper.allowlist.methodssection, add the following methods to the existing ones:
            com.atlassian.jira.issue.DocumentIssueImpl#getIssueType(),\
            com.atlassian.jira.issue.managers.CachingCustomFieldManager#getCustomFieldObjects(java.lang.Long java.lang.String),\
            com.atlassian.jira.config.properties.ApplicationPropertiesImpl#getString(java.lang.String),\
            com.atlassian.jira.issue.fields.ImmutableCustomField#getValue(com.atlassian.jira.issue.Issue),\
            
          • Restart Jira

              94e733e73fd4 Robert Klimkiewicz
              fe9534534cb0 Deepak Kumar
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: