blob: c2034665d66b68daa8ea6c4da124bee762424a93 [file] [log] [blame]
Joshua Hesketh902ea502013-09-06 11:15:30 +10001:title:Turbo Hipster Structure
2
3Structure
4=======================
5
Joshua Heskethbacf1892013-09-09 11:30:39 +10006Plugins
7-------
8
Joshua Hesketh05d01582013-09-09 15:16:08 +10009A little bit about plugins to come here soon.
10
11 - You need to configure it in config.json
12 - Folder name must be the same as 'name'
13 - You probably want to specify a gate in the config
14 - see something (introduction?) about gates and how turbo-hipster
15 uses them
16 - Each plugin has a task.py with a Runner class
17 - Responsible for registering functions
18 - handling jobs
19 - checking for errors
20 - building reports
21 - publishing them according to configuration