Comment issue(s)

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.

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, or you can also use Nunjucks annotations to insert other issue data into the Comment text, including issue, transition and current user information To find out more about using variables, see Using Nunjucks Templates.

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 Post Functions in the properties panel.

  4. Click Add post function.

  5. Select Comment issue(s) from the list of post function.

  6. Click Add to navigate to the Comment issue(s) post-function screen where you can add configuration details to the post function. See below for more information.

  7. Click on Add to add the post function to the transition. 

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. 

Issue(s) to operate on

Select the issues to operate on. They can be:

  • Target issues

    • Current issue: Select this option to set the assignee of the current issue. This is the default option.

    • Sub-tasks of the current issue: Select this option to set the assignee of sub-tasks of the current issue

    • Parent issue of the current sub-task: Select this option to set the assignee of the parent of the current issue

    • Issues that belong to the current issue (Epic): Select this option to set the assignee of issues that belongs to the current Epic

    • Epic of the current issue: Select this option to set the assignee of the Epic of the current issue

    • Child issues of the current issue in the Portfolio hierarchy: Select this option to set the assignee of child issues of the current issue in the Portfolio hierarchy

    • Parent issue of the current issue in the Portfolio hierarchy: Select this option to set the assignee of 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 set the assignee of the current issues' linked issues

    • Issues linked to the current issue through the following link type: Select this option to set the assignee of 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 set the assignee of 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 set the assignee of 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

      • {% 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).

  • Issue Link - Only available when Target issues, above, is set to Issues linked to the current issue through the following link type. Select the required link type between the current issue and the issue to be updated.

  • Nunjucks template - Only available when Target issues, above, is set to Issues returned by the following Nunjucks template. Enter a Groovy script that returns the ID values for the issue or issues to be updated. See Using Nunjucks Templates for more information on Nunjucks.

  • JQL expression - Only available when Target issues, above, is set to Issues returned by the following JQL search. Enter a JQL expression that returns the ID values for the issue or issues to be updated. See Using Jira Expressions for more information on JQL.

Comment

Enter the comment to be added to the target issues in the Comment script editor field.

Advanced options

Expand this section to see advanced configurations including which user will run the post function, conditional execution, and delayed execution.

Comment visibility

You can set the visibility of the comment using these options. For no restrictions, leave these fields blank.

  • Restrict to Group - Restricts the visibility of the comment to a specified group. When you select a valid group name in this field, the comment will be visible only to the members of that group.

  • Restrict to Project Role - Restricts the visibility of the comment to a selected project role. When you select a project role, the comment will be visible only to the members of that role.

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

Run As

Conditional execution

Delayed execution

You are viewing the documentation for Jira Cloud.

 

Comment issues post function configuration screen
Figure 1 - Comment issue(s) post function