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

Document the contents of the velocity context for release notes

    • 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.

      NOTE: This suggestion is for JIRA Server. Using JIRA Cloud? See the corresponding suggestion.

      We have documentation on the contents of the velocity context for email notifications and custom fields, we need one for release notes. From a user:

      What i had trouble with tho was not the velocity side as it is relatively straight forward, but more so the fact that i had no idea what classes i had access to from within the velocity template, or how to add classes (infact i didn't even know you could add classes).

      Once i got over that hurdle, it was just a matter of finding the relevant classes to pass to the release notes in the jira api, so i could gain acces to each issues linked issues.

      I think that some documentation could be added to this affect. ie what classes are initially available to the release notes templates. As well as how to add more classes to this list (through the method getTemplateVariables in ReleaseNoteManager)
      Another issue, which fortunately i didn't come up against as we have the enterprise edition of jira so was able to get the source code for the ReleasenotesManager, edit it, recompile and replace the existing ReleaseNoteManager class file. But if i didn't have enterprise and didn't have access to the source, how would have i gone about this?

      Anyway that just my 2cents on a few things that would have helped me out greatly to avoid the issues that i had. (Judging by the number of views that this thread has had i am guessing i am not the only one who has come up against these issues also)

      Cheers
      Sam

            [JRASERVER-10222] Document the contents of the velocity context for release notes

            Fabian added a comment -

            Nothing changed, right?

            I have the same problem and need a documentation. Is that so hard to produce?????

            Fabian added a comment - Nothing changed, right? I have the same problem and need a documentation. Is that so hard to produce?????
            Katherine Yabut made changes -
            Workflow Original: JAC Suggestion Workflow [ 3043153 ] New: JAC Suggestion Workflow 3 [ 3671498 ]
            Status Original: RESOLVED [ 5 ] New: Closed [ 6 ]
            Owen made changes -
            Workflow Original: Confluence Workflow - Public Facing v4 [ 2603071 ] New: JAC Suggestion Workflow [ 3043153 ]
            Rachel Lin (Inactive) made changes -
            Workflow Original: JIRA PM Feature Request Workflow v2 - TEMP [ 2552053 ] New: Confluence Workflow - Public Facing v4 [ 2603071 ]
            Status Original: Closed [ 6 ] New: Resolved [ 5 ]
            Ignat (Inactive) made changes -
            Workflow Original: JIRA Bug Workflow w Kanban v6 - TEMP [ 2339177 ] New: JIRA PM Feature Request Workflow v2 - TEMP [ 2552053 ]
            Katherine Yabut made changes -
            Workflow Original: JIRA Bug Workflow w Kanban v6 [ 2113924 ] New: JIRA Bug Workflow w Kanban v6 - TEMP [ 2339177 ]
            Katherine Yabut made changes -
            Workflow Original: JIRA Bug Workflow w Kanban v6 - TEMP [ 2091913 ] New: JIRA Bug Workflow w Kanban v6 [ 2113924 ]
            Katherine Yabut made changes -
            Workflow Original: JIRA Bug Workflow w Kanban v6 [ 884021 ] New: JIRA Bug Workflow w Kanban v6 - TEMP [ 2091913 ]
            jonah (Inactive) made changes -
            Description Original: We have documentation on the contents of the velocity context for email notifications and custom fields, we need one for release notes. From a user:

            {quote}
            What i had trouble with tho was not the velocity side as it is relatively straight forward, but more so the fact that i had no idea what classes i had access to from within the velocity template, or how to add classes (infact i didn't even know you could add classes).

            Once i got over that hurdle, it was just a matter of finding the relevant classes to pass to the release notes in the jira api, so i could gain acces to each issues linked issues.

            I think that some documentation could be added to this affect. ie what classes are initially available to the release notes templates. As well as how to add more classes to this list (through the method getTemplateVariables in ReleaseNoteManager)
            Another issue, which fortunately i didn't come up against as we have the enterprise edition of jira so was able to get the source code for the ReleasenotesManager, edit it, recompile and replace the existing ReleaseNoteManager class file. But if i didn't have enterprise and didn't have access to the source, how would have i gone about this?

            Anyway that just my 2cents on a few things that would have helped me out greatly to avoid the issues that i had. (Judging by the number of views that this thread has had i am guessing i am not the only one who has come up against these issues also)

            Cheers
            Sam
            {quote}
            New: {panel:bgColor=#e7f4fa}
              *NOTE:* This suggestion is for *JIRA Server*. Using *JIRA Cloud*? [See the corresponding suggestion|http://jira.atlassian.com/browse/JRACLOUD-10222].
              {panel}

            We have documentation on the contents of the velocity context for email notifications and custom fields, we need one for release notes. From a user:

            {quote}
            What i had trouble with tho was not the velocity side as it is relatively straight forward, but more so the fact that i had no idea what classes i had access to from within the velocity template, or how to add classes (infact i didn't even know you could add classes).

            Once i got over that hurdle, it was just a matter of finding the relevant classes to pass to the release notes in the jira api, so i could gain acces to each issues linked issues.

            I think that some documentation could be added to this affect. ie what classes are initially available to the release notes templates. As well as how to add more classes to this list (through the method getTemplateVariables in ReleaseNoteManager)
            Another issue, which fortunately i didn't come up against as we have the enterprise edition of jira so was able to get the source code for the ReleasenotesManager, edit it, recompile and replace the existing ReleaseNoteManager class file. But if i didn't have enterprise and didn't have access to the source, how would have i gone about this?

            Anyway that just my 2cents on a few things that would have helped me out greatly to avoid the issues that i had. (Judging by the number of views that this thread has had i am guessing i am not the only one who has come up against these issues also)

            Cheers
            Sam
            {quote}
            jonah (Inactive) made changes -
            Link New: This issue relates to JRACLOUD-10222 [ JRACLOUD-10222 ]

              nick.menere Nick Menere [Atlassian] (Inactive)
              dylan@atlassian.com Dylan Etkin [Atlassian]
              Votes:
              5 Vote for this issue
              Watchers:
              8 Start watching this issue

                Created:
                Updated:
                Resolved: