| 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. |
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:
Click Edit for the workflow that has the transition you wish to add the post-function on.
In the Workflow Designer, select the transition.
Click on Post Functions in Functions in the properties panel.
Click on Add post function.
Select Comment issue issue(s) from the list of post -functionsfunction.
Click on Add to add the navigate to the Comment issue(s) post-function on the transition.
Select the “Target issue” (see below)
Input a comment in the
Commentfield.
To input issue or transition or currentUser information in theCommentfield see, Using Nunjucks Templatesscreen where you can add configuration details to the post function. See below for more information.Click on Add to add the post - function to the transition.
After adding, move the post-function to the appropriate position according to Placing post-functions in a transition document.
| Info |
|---|
You are viewing the documentation for Jira Cloud. |
On This Page
| Table of Contents | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
| 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.
Restrict to Group field the specified For no restriction, leave the field blank.: from the drop-down Restrict to Project Role field the selected project For no restriction, leave the field blank.: the To execute this post-function based on the result of a Nunjucks template see Conditional execution.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
Save the post-function
Publish the workflow
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:
Add the Comment issue post-function to the Resolve transition of the issue's workflow.
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 %} |
You are viewing the documentation for Jira Cloud.
On This Page
|
|---|
