Configuration
Configuration files
ScrumMD is configured by a toml file. The first of the following files available will be read for configuration:
.scrum.tomlscrum.tomlpyproject.toml
All fields in the [tool.scrummd] collection.
Where fields are listed as [tool.scrummd.fieldname], they should be in
square brackets as TOML categories/arrays.
Supported fields
[tool.scrummd]
allow_header_summary
Type
bool
Description
Permit summaries to be set by an empty summary. For instance:
This is a valid summary
=======================
# Description
Description goes here
strict
Type
bool
Description
Fail on any issue with the collection rather than trying to persevere.
scrum_path
Type
string
Description
Path to the Scrum repository containing cards and collections.
required
Type
array of str
Description
List of fields that must be present in all cards.
[tools.scrummd.fields.<field name>]
Type
array of str
Description
Limit field name to specific values. Each member is an array of str.
[tools.scrummd.collections.<collection name>]
Additional restrictions which apply only to a specific collection.
required
array of str
List of fields that must be present in all cards in the collection.
[tools.scrummd.collections.<collection name>.fields.<field name>]
Type
array of str
Description
Limit field name to specific values for all cards in the collection. Each member is an array of str.
[tools.scrummd.sbl]
columns
Type
array of string
Description
Array of columns to show with sbl.
omit_headers
Type
bool
Description
Whether to omit headers from sbl output.
default_group_by
Type
array of string
Description
Default fields to group by if there’s no --group-by field. Defaults to none.
[tools.scrummd.sboard]
default_group_by
Type
array of string
Description
Default fields to group by if there’s no --group-by field.
A --group-by argument or default_group_by configuration must be set
for sboard to work.
[tools.scrummd.scard]
default_template
Type
str
Description
A path of a jinja2 template to use for scard output.
See the Output Template Guide for formatting the template.
The search path priorities are as follows:
the current working directory;
the
.templatesdirectory in thescrum_paththe
templatesdirectory in thescrum_pathtemplatesin the scrummd package;
Example configuration file
[tool.scrummd]
strict = true
scrum_path = "scrum"
allow_header_summary = false
required = ["status"]
[tool.scrummd.sbl]
columns = ["index", "status", "summary"]
omit_headers = false
# default_group_by is unset but commented as example
# default_group_by = ["status"]
[tool.scrummd.sboard]
default_group_by = ["status"]
[tool.scrummd.scard]
default_template = "default_scard.j2"
[tool.scrummd.fields]
status = ["Not Fully Defined", "Ready", "In Progress", "In Testing", "Done"]
[tool.scrummd.collections.epic]
required = ["cost centre", "members"]
[tool.scrummd.collections.epic.fields]
cost_status = ["Not Costed", "Fully Costed"]