Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

A workflow post-function that creates a comment on the current issue or issues related to the current issue. The text of the comment to be created can be any simple text or a text with Nunjucks annotations.

To add 'Comment issue(s)' post function to a transition: 

  1. Click Edit for the workflow that has the transition you wish to add the post-function on.

  2. In the Workflow Designer, select the transition.

  3. Click on Post Functions in the properties panel.

  4. Click on Add post function.

  5. Select Comment issue from the list of post-functions.

  6. Click on Add to add the post-function on the transition.
    Image Removed

    Image Added

  7. Select the “Target issue” (see below)

  8. Input a comment in the Comment field.
    To input issue or transition or currentUser information in the Comment field see, How to insert information using Nunjucks annotations.

  9. Click on Add to add the post-function to the transition.

  10. After adding, move the post-function to the appropriate position according to Placing post-functions in a transition document.

Refer Use cases for the use cases for this post-function
  1. .

Common to all post-functions:

Content by Label
showLabelsfalse
max5
spacesKB
sorttitle
showSpacefalse
typepage
labelskb-troubleshooting-article
cqllabel = "common-issue" and type = "page" and space = "JMWEC"

Known issues specific to this post-function

Content by Label
showLabelsfalse
max5
spacesKB
showSpacefalse
sortmodified
typepage
reversetrue
labelskb-troubleshooting-article
cqllabel = "comment-issue" and type = "page" and space = "JMWEC"

Troubleshooting this post-function configuration: In case the post-function does not work as expected these are the things to look out for

Content by Label
kb-troubleshooting-article
showLabelsfalse
max5
spacesKB
showSpacefalse
sortmodified
typepage
reversetrue
labelskb-troubleshooting-article
cqllabel in ( "placing-postfunctions" , "troubleshooting" ) and type = "page" and space = "JMWEC"labels


Info

JMWE shows an error message on the issue view if any error occurs during the execution of the post-function. This message is only displayed if the current user is a Jira administrator. 

When you add this post-function to a transition and trigger the transition, the add-on picks the value entered in the Comment field and adds it as a comment on the target issue(s). The Comment to be created can be any simple text, e.g. This is a comment. You can also use Nunjucks annotations to insert issue, transition and current user information into the comment text, using the 'issue', 'transition' and 'currentUser' variables, respectively. To find out more about the variables, see How to insert information using Nunjucks annotations.

Issue(s) to operate on

Select the issues to operate on. They can be:

  • Current issue: Select this option to add a comment on the current issue. This is the default option.

  • Sub-tasks of the current issue: Select this option to add a comment on each sub-task of the current issue

  • Parent issue of the current sub-task: Select this option to add a comment on the parent of the current issue

  • Issues that belong to the current issue (Epic): Select this option to add a comment on the issues that belong to the current Epic

  • Epic of the current issue: Select this option to add a comment on the parent Epic of the current issue

  • Child issues of the current issue in the Portfolio hierarchy: Select this option to add a comment on the child issues of the current issue in the Portfolio hierarchy

  • Parent issue of the current issue in the Portfolio hierarchy: Select this option to add a comment on the parent issue of the current issue in the Portfolio hierarchy

  • Issues linked to the current issue through any link type: Select this option to add a comment on all issues linked to the current issue

  • Issues linked to the current issue through the following link type: Select this option to add a comment on the issues linked to the current issue through a specific link type. Select the specific link type under “Issue link”

  • Issues returned by the following Nunjucks template: Select this option to add a comment on the issues returned by the result of a Nunjucks template. Input a Nunjucks template which is a comma-separated list of valid issue keys. For example:

    • "TEST-1"

    • "TEST-1","TEST-2"

    • {{ issue.fields.parent.key }}

    • {{ issue.fields.subtasks | join(",", "key") }}

  • Issues returned by a JQL search: Select this option to add a comment on the issues returned by a JQL search. Input a JQL search expression. For example:

    • project = TEST returns issues of the project with the key TEST

    • project = {{ issue.fields.project.key }} and assignee = {{currentUser._accountId}} returns issues of a project that belong to the project with key TEST and the assignee is the current user

    • Code Block
      {% if issue.fields.assignee %}
          assignee = {{issue.fields.assignee._accountId}}
      {% else %}
          issuekey=INVALID-1
      {% endif %}

      Note that the {% if %} block is necessary to avoid an invalid JQL query when the issue is unassigned. In that case, the template will return a valid JQL query that returns no issue (issuekey=INVALID-1).

Comment visibility

  • Restrict to Group: Restricts the visibility of the comment to a specified group. When you select a valid group name in the Restrict to Group field, the comment will be visible only to the members of the specified group. For no restriction, leave the field blank.

  • Restrict to Project Role: Restricts the visibility of the comment to a selected project role. When you select a project role from the drop-down Restrict to Project Role field, the comment will be visible only to the members of the selected project role. For no restriction, leave the field blank.

  • Restrict to Internal (Jira Service Desk only): Restricts the visibility of the comment to the Service Desk Agents and Collaborators only.

Run As

  • Run as current user: The current user will be the author of the comment created on the issue by the post-function. 

  • Run as add-on user: The add-on user will be the author of the comment created on the issue by the post-function. 

  • Run as this user: Any user selected in this field will be the author of the comment created on the issue by the post-function. 

Conditional execution

To execute this post-function based on the result of a Nunjucks template see Conditional execution.

Delayed execution

To delay the execution of this post-function see Delayed execution.
Include Page
Delayed execution
Delayed execution

Use case

A typical use of this workflow post-function is to comment on an issue during a transition. Consider a use where on resolving/closing a ticket you want to comment on the issue a summary of the worklog. To configure it:

  1. Add the Comment issue post-function to the Resolve transition of the issue's workflow.

  2. Write the following content in the Comment section.

    Code Block
    {% set worklogs = issue.fields.worklog.worklogs %}
    {% set count = 1%}
    {% for worklog in worklogs %}
    Worklog {{count}}:
    Started : {{ worklog.started }}
    Time Spent : {{ worklog.timeSpent }}
    Work Description : {{ worklog.comment }}
    
    {% set count = count + 1 %}
    {% else %}
    No work logged for this issue
    {% endfor %}

  3. Save the post-function

  4. Publish the workflow

See here for more use cases