Prerequisites

"Save checklist data to Jira custom fields" option must be enabled in Issue Checklist Global Settings. 

Step by step guide

1. Create a new rule in Automation plugin (go to Project Settings > Project automation and click Create rule button)
   
   
   
   
2. Select "Issue Transition" as a trigger and next choose source and destination statuses (details of transition)
   
   
   
   
3. Select Action as the next step and choose "Edit Issue" from the list of actions
   
   
   
   
4. Select Checklist Content YAML (or Checklist Text) field on the next screen 
   
   
   
   
5. Provide details for the custom field update as presented on the screenshot, i.e.:
   1. Checklist Content YAML (or Checklist Text) field ID in the double curly braces in order to insert existing checklist (check how to find custom field ID)

   2. New checklist items that you want to append, e.g.:
      
      
      
      

      Example Text

      Acceptance criteria 1
      Acceptance criteria 2

      Example YAML

        - text: 'Acceptance criteria 1'
          checked: false
        - text: 'Acceptance criteria 2'
          checked: false

       Read more about YAML

      Unable to render {include} The included page could not be found.

      If you want to replace/overwrite the checklist, then remove custom field ID in curly braces from the first line. Additionally, for YAML only, put "items:" phrase in the first line. Read more. 

6. Save the rule and test your setup (transition an issue, refresh the page and spot the checklist updated).
   
   

    If it doesn't work, read this

   If the checklist is not updated then, please add Checklist Content YAML (or Checklist Text) custom field to issue screen and check if it is correctly updated when the issue is transitioned.

   1. If the Checklist Content YAML (or Checklist Text) field is not updated (its content does not change) then please check the created rule, especially step 2 (source and destination transition) as the rule might not be started for a given transition.
   2. If the Checklist Content YAML (or Checklist Text) field is updated but the checklist panel (list of checkboxes) does not, then one of the following can be a reason:
      1. custom fields integration is not enabled (please enable it)
      2. the YAML provided in step 5 is invalid so it cannot be parsed and translated to the list of checkboxes. Consider using Checklist Text field (which is simpler for human interaction) or read more about YAML.
    Read why page refresh is required to see the checklist

   The following happens in the background:

   1. Issue is transitioned
   2. Jira sends a webhook notification to Automation plugin (this is asynchronous; usually 1 to 3 seconds but might take significantly more time)
   3. Automation plugin does its job (updates issue by setting the checklist field)
   4. When the issue is updated (checklist field), Jira sends a webhook notification to Checklist plugin (again, this is asynchronous; usually 1 to 3 seconds but might take significantly more time)
   5. Checklist plugin reads checklist text field and transforms it into the checklist that you can see in the UI (this is synchronous and almost instant 1-3 seconds)

   The above means that:

   • The issue page needs to be refreshed to see the checklist (because the process described in the list above is not finished yet when the issue page is loaded after transition - that is how plugins work in Jira Cloud).
   • On average, few seconds after transition are required to see the checklist in the UI (so usually the first page refresh after transition shows checklist already)
   • In rare cases, it might take longer to see the checklist (dozen of seconds or a couple of minutes so keep refreshing the issue page)