Validate before transition

You can prevent the Jira issue from transition to the next state if not all Smart Checklist items are checked.

Since version, v5.2.0 Smart Checklist add-on doesn’t need “Smart Checklist Progress” field setup

If your Smart Checklist version is lower than v5.2.0 - Follow these instructions to add the "Smart Checklist Progress" custom field, then proceed to the steps below.

Set up transition validator

  1. Go to Workflows

  2. Choose one that you want to add validation to and click Edit

  3. Choose transition and click on "Validators" link

  4. Add Validator

  5. Choose "Smart Checklist Completed Validator"

  6. Click Add - new Validator will be saved

  7. Then Publish this changed workflow

Check Validator in action

  1. Go to Kanban board (or Issue view)

  2. Try to change the state of an item with opened checklist items

  3. You'll get the error:

  4. If you check all Smart Checklist items - you'll be able to transition the Jira issue successfully!

If you want to know how to display "Show Checklist progress" on Agile boards read Progress on Agile Board

 

Validate if certain items are completed

You can add a validator that verifies if only certain items have been checked off before allowing the transition.

Let’s imagine, you have the following checklist:

The Checklists custom field will contain the following string:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 # Definition of Done + Code produced (all to do items in code completed) > Code commented, checked in and run against current version in source control ~ Code reviewed > @Peer reviewed (or produced with pair programming) > meeting development standards - Builds without errors - Unit tests written and passing - Deployed to system test environment and passed system tests - Acceptance criteria met > Passed UAT (User Acceptance Testing) > signed off as meeting requirements by@ProductOwner - Any build/deployment/configuration changes implemented/documented/communicated - Relevant documentation/diagrams produced and/or updated

Using Scripted (Groovy) Validator you can check if all items with the text 'Code reviewed' and 'Unit tests are written and passing' are done:

1 2 3 4 5 6 7 8 9 10 11 def checklist = issue.get("customfield_10113"); if (!checklist) { return true; } def checklistItems = checklist.split('\n').findAll({ it -> it.matches("^[-|+|~].*")}); for (item in checklistItems) { if (!item.startsWith("+") && (item.contains("Code reviewed") || item.contains("Unit tests written and passing"))) { return false; } } return true;

 


For any questions or feature requests contact us: smartchecklist@railsware.com