Using Issue Checklist with Scheduler

We are receiving request about using Issue Checklist Free with The Scheduler, at first it looked it won't be possible, but we came up with a solution.

Due to limited number of available custom fields it won't work on next-gen project - at least not in current form of those projects.

 

The Scheduler uses fields available on 'create issue screen', to use Checklist items, you need to add it's field to create issue screen.

Here is an example with create issue screen with dedicated 'Checklist' tab including "Checklist Content YAML" field:



We advice adding this field only to 'create issue' screen, because when issue is created items can be edit on ticket. If it stays on the edit and view screens, then it is duplicated. We advice adding it only to create screen.

On create issue page the field looks like this:

The base structure of checklist items looks like this:

items:
  - text: 'item 1'
    checked: false
  - text: 'item 2'
    checked: false
  - text: 'item 3'
    checked: false

On create issue screen:

You need to use same structure, while creating Scheduled Issue:



Here you can see that, when issue gets created all checklist items are visible:



Now, you can even Schedule Issues with already existing items easily. Here you cans see I've added 3 new items, when I schedule it, all appears on 2nd step of the wizard:

Have fun using it!  

Mar 21, 2022 Update

It seems, that structure changed a bit, but it is still working :)

  1. Settings

    1. You need to add Checklist Text custom field to the create issue screen. Here you can see the field added to create issue screen in 2nd tab, to separate it from the main create issue screen.

    2. Fields was not edited, using default settings and it was added to 1 issue screen shared across projects, with 1 same context for all projects and issue types

  2. Verification

    1. You need to check if it displayed on the create issue screen, as expected it is visible in ‘More’ tab

    2. Check if it’s working, to simply and speed up… just create issue and then add checklist items

  3. Create Scheduled Issue with checklist items. You can do it 2 ways, hard way or simple way

    1. Hard way - learn the syntax and follow examples from the doc: https://herocoders.atlassian.net/wiki/spaces/IC/pages/1240760525/Items+formatting

    2. Easy way - use the power of created issue, use one of the features of The Scheduler to schedule existing issue. Use option to Schedule Issue

    3. You will see details on the 2nd step of the wizard and just check what was added to the checklist

    4. Go through the wizard, and execute the template / scheduled issue to check if data was added correctly

  4. Use / Test / Modify to your needs

When it done you can see that the syntax in the template looks like this:

# Default checklist * [x] Checked * [] Not checked * []? Optional

Now you can edit it to your needs:

# Default checklist * [] 1st item * [] 2nd item * [] 3rd item to do * []? optional thing to do * [] some status --- Acceptance Criteria - checklist item 1 - checklist item 2 with **bold** text - checklist item 3 with link to an issue IC-245

More in the docs: https://herocoders.atlassian.net/wiki/spaces/IC/pages/1241907238/Checklist+Text+format

Here is the result of created issue with The Scheduler with the use of the provided syntax snippet:

Feel free to tell us what topic should be covered: thescheduler@psc-software.atlassian.net