Checklist YAML format

Checklist Content YAML custom field accepts and stores data in YAML format. This field stores only items from the default checklist and is ignored if multiple checklists are enabled.

The content of Checklist Content YAML field consists of "items" array and each entry contains obligatory "text" property (checklist item text) and optional "checked" property (boolean value for state of the checkbox).

It might contain also "description" property for multiline description and "status" property if statuses are enabled.

Here is a valid example:

Default (no statuses)

items:
  - text: '--- Header (title)'
    checked: false
  - text: 'Item #1'
    checked: true
  - text: 'Item #2'
    checked: false
  - text: 'Item #3'
    checked: false

And another example with enabled statuses:

Statuses enabled

items:
  - text: '---UI tested on'
    checked: false
    status: open
  - text: 'Chrome :santa'
    checked: false
    status: in progress
  - text: Firefox
    checked: true
    status: done
  - text: Edge
    checked: true
    status: skipped
  - text: Safari
    checked: true
    status: skipped

Read how to get YAML from existing checklist

Checklist Content YAML field is deprecated and it will be removed in the future. Please use the Checklist Text field instead.

If you need a checklist in YAML format for automation purposes, then use "Copy checklist as YAML" option from the checklist "..." menu.

Go to any issue page
Add checklist items through the Checklist panel as you usually do

Use "Copy Checklist as YAML" button from the "..." menu (the YAML representing actual checklist is copied to the clipboard)

Here is the example YAML copied to clipboard (use Ctrl+P to paste it):

items:
  - text: '--- Optional checklist header/title'
    checked: false
  - text: item 1
    checked: false
  - text: item 2 with **description**
    checked: false
    description: example description