Skip to content

clickthisnick/dynamic-release-checklist

Repository files navigation

Is your release checklist full of fluff?

That's why I created the Dynamic Release Checklist.

Only have relevant items in your checklist.


Demo:

Click For Demo

The Problem:

Too many times I see release checklists full of items that don't apply to this release.

This teaches and reinforces people to gloss over items, sometimes missing crucial tasks.

Imagine the checklist below with no downpage

Task Needed With This Release?
Create Downpage No
Push Code Yes
Remove Downpage No

You now have two items ( Create Downpage and Remove Downpage ) that are no longer needed on your checklist.


The Solution:

Create questions that reduce your release checklist to only the necessary items

First create a question

function questions(){
return [
  {id:1,text:'Is there a downpage?',description:'',default:false}
  ];
}

Then tie the tasks to the question.

Push code has no questionsRequiredYes so that tasks shows no matter what.

The tasks Create Downpage and Remove Downpage only show when the question with an id of 1 is set to True.

function tasks() {
return [
  {questionsRequiredYes:[1],questionsRequiredNo:[],questionsAnyYes:[],questionsAnyNo:[],role:'Developer',type:'Release',task:'Create Downpage'},
  {questionsRequiredYes:[],questionsRequiredNo:[],questionsAnyYes:[],questionsAnyNo:[],role:'Developer',type:'Release',task:'Push Code'},
  {questionsRequiredYes:[1],questionsRequiredNo:[],questionsAnyYes:[],questionsAnyNo:[],role:'Developer',type:'Release',task:'Remove Downpage'}
];
}

Further Explanation:

questionsRequiredYes => Put in any question ids that must be true for this item to be present

questionsRequiredNo => Put in any question ids that must be false for this item to be present

questionsAnyYes => If any of these questions are true this item will show

questionsAnyNo => If any of these questions are false this item will show

role => Who is responsible for this task

type => What section of the checklist will this task be put in

More Examples:

Clone the repo and checkout the examples in the examples folder

License

This project is licensed under the Apache 2.0 license.

About

An easy to modify dynamic checklist that is great for release management

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •