dashboards.md

Dashboards

Single Dashboard

To only show a single dashboard, simply add all configuration and rules in the main config.toml.

Example

tuwat -conf config.toml

[[rule]]
description = "Ignore Drafts"
[rule.label]
Draft = "true"

[[github]]
Repos = ['synyx/tuwat', 'synyx/buchungsstreber']
Tag = 'gh'

Dashboard types

There are two kinds of dashboards:

• mode = "exclude": The normal kind of dashboard. Each rule will filter the matching items from the board.
• mode = "include": Only items matching the rules are shown on the board.

[main]
mode = "include"

Multiple Dashboards

To have multiple dashboards, split the configuration into a main config in config.toml and create a folder containing the rule files for additional dashboards. These dashboards will appear in the navigation bar named like the corresponding files.

Example

tuwat -conf config.toml -dashboards tuwat.d

# config.example.toml
[[github]]
Repos = ['synyx/tuwat', 'synyx/buchungsstreber']
Tag = 'gh'

# tuwat.d/no-drafts.toml
[[rule]]
description = "Ignore Drafts"
[rule.label]
Draft = "true"

# tuwat.d/drafts.toml
[main]
mode = "include"

[[rule]]
description = "Show only drafts"
[rule.label]
Draft = "true"