Checklist Content YAML (deprecated)

Deprecation Notice and Limitations

• The Checklist Content YAML field has been deprecated and will no longer be available after May 10, 2025 from Checklists for Jira. Please update any automation rules using the field and use the use Checklist Text instead.

• The Checklist Content YAML field is currently still available if you disable the Multiple Checklist per Issue global setting.

• The Checklist Content YAML field is not supported in Checklist for Jira ENTERPRISE .

The Checklist Text field not only allows the same functionality as Checklist Content YAML, but can also store multiple checklists (when enabled) and uses a more user-friendly format.

⚠️ For Automation Rules that Use the Checklist Content YAML Field

The Checklist Content YAML field will be removed from Checklists for Jira. You can convert existing automation rules that use the Checklist Content YAML field to use the Checklist Text field instead following the steps below.

1. Identify the rules that need to be converted. To help identify rules which may use the Checklist Content YAML field, navigate to the System > Global Automation and:

   1. Type checklist into the search bar. This will return any rules where Checklist (not case-sensitive) is used in the rule name.

   2. Use the Action filter to search for rules using the Edit work item action. This is the most likely use of the Checklist Content YAML field in automation, but your instance may have additional rules that use the field.

2. For rules that edit the Checklist Content YAML field:

   1. Copy the checklist that you want to add to the work items to clipboard. The easiest way to copy a formatted checklist is to copy the text from the checklist Editor.

   2. Ensure the Save local checklist items to Jira custom fields global setting is enabled.

   3. Navigate to the automation rule and click on the action that edits the Checklist Content YAML field.

   4. In the Choose fields to set dropdown deselect the Checklist Content YAML field and select the Checklist Text field.
      

      

   5. Paste the checklist into the Checklist Text input field. (The easiest way to copy a formatted checklist is to copy the text from the checklist Editor.)
      

      

   6. If instead of replacing the checklist items, you want to append new items to the existing checklist type {{issue.Checklist Text}} in the input field before pasting in the list items you want to add.

   7. Click Update to save the changes to the rule.

Usage

This Checklist Content YAML field has been deprecated and will no longer be available after May 10, 2025. Please use the Checklist Text field instead.

• Can be used to Import/export checklists from Trello, CSV or another Jira instance.

• Can be used with advanced JQL to search for specific contents of a checklist.

• Can be used when bulk editing to add a checklist to multiple issues.

• Allows access to the checklist via the Jira API.

• Can be used to modify a checklist when an issue is edited or transitioned.

• Records changes to the checklist in the Jira History tab.

• Can be used with automation or scripting apps to access and/or modify the checklist.

Copying Checklist in YAML Format

This Checklist Content YAML has been deprecated and will no longer be available after May 10, 2025. Please use the Checklist Text field instead.

You can copy the checklist in YAML format regardless of whether or not the YAML field is on the screen.

To copy the checklist in YAML format:

1. Click on More … menu of the checklist.

2. Select Copy checklist as YAML.