Require a comment on transition

Use the Require a comment on transition validator to make sure a comment is added to the issue during the chosen transition. For example, you can use this validator to ensure a closing statement is added to an issue when it is transitioned to Done, or equivalent.

This validator must be applied to a transition with a screen. Comments do not need to be configured to a screen as all transition screens include the option to add a comment.

Use this validator

  1. Go to Administration > Issues > Workflows.
  2. Select Edit on the workflow to which you want to add this validator. 
  3. Select the transition to which you wish to add this validator.

    Make sure the transition you're applying this validator to has a screen applied to it.  

  4. Under Options, select Validators.
    Image with validators option highlighted and an arrow pointing to the screen
  5. On the Transition page, select Add validator.
  6. Select Require a comment on transition.
    Image of the validator selected
  7. Select Add.
  8. Optional: Enter a note that describes the validator (this note is for your reference when viewing all validators). 
  9. Select Update.
    Image of completed validator

  10. Select Publish and choose if you want to save a backup copy of the workflow.
    Image with Publish option highlighted

    You can now test to see if this workflow validator works. Issues in your chosen project will throw an error if you try to transition the issue without a comment.

    Image displaying error message


Related content

On this page