Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

Project release notes

KoDKaT
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
November 7, 2019

Hello, 

 

I need to know if the project release notes include the release notes of their components? I searched on the web documentation / community and I dont saw anything about this information.

 

Thank you for helping me :)

1 answer

1 accepted

0 votes
Answer accepted
Petter Gonçalves
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
November 8, 2019

Hello @KoDKaT

Welcome to Atlassian Community!

Per your description, I understood that you would like to include the component information in the release notes of your JIRA projects. Is that correct?

As you see in this documentation, JIRA Server versions allow you to customize new format templates for JIRA release notes. These would be the steps:

  1. Create a Velocity template similar in content to that of the examples provided — releasenotes-text.vm and releasenotes-html.vm. Consult the Jira API documentation and the Apache Velocity User Guide.
  2. The title within the template should be modified along with the code within the text area. The other sections of the template do not need to be modified.
  3. Add the new format template to the list of existing ones within the jira-config.properties file. For each new template format, corresponding entries must be added to the existing values of the following properties:
    • jira.releasenotes.templatenames
    • jira.releasenotes.templates

      Notes:
      1. Corresponding entries in both of these properties must be in the same order.
      2. If these properties do not exist in your jira-config.properties file, then:
        1. For each of these properties, add the property's name,
        2. followed by an '=',
        3. followed by the content of the property's corresponding <default-value/> element copied from your Jira installation's jpm.xml file.
        4. Next, begin adding the corresponding entries for the new format template.

    (info) See Making changes to the jira-config.properties file for more information.

  4. The new format template is available for selection as a release note format template.

Also see the tutorial on Creating a Custom Release Notes Template Containing Release Comments.

Let us know if the documentation and tutorials provided give you some light in that matter.

KoDKaT
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
November 9, 2019

Thank you for your reply. I will try it

Petter Gonçalves
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
November 11, 2019

You are welcome, @KoDKaT

Let me know how it went for you. :)

Suggest an answer

Log in or Sign up to answer