Configuration
Debby can be configured through a TOML file in your project located at .debby/config.toml.
Here's a basic example that shows how to configure Debby's checks.
[check_model_descriptions]
enabled = true
skip = ['tmp_orders', 'deprecated_v1_customers']
minimum_description_length = 20
[check_source_fanout]
enabled = false
You can likely guess exactly what this configuration does. The check named check_model_descriptions is enabled, but it will skip models named tmp_orders and deprecated_v1_customers. The check also sets a custom parameter named minimum_description_length, which is used to ensure model descriptions are at least 20 characters long.
The check named check_source_fanout is disabled, and will not be ran against any sources.
Types of configuration
The example above showed two types of configuration.
1. Custom check parameters
These parameters are unique to a check, and only make sense for that specific check.
The custom parameters for a check are documented on each check's page. For example, the custom parameters for the check check_model_descriptions are documented at debbyapp.com/docs/checks/check_model_descriptions#parameters
2. Common check parameters
These parameters are applicable to all checks. Any check can use these parameters to control its behaviour. For example, any check can use the parameter enabled to completely enable or disable that check. Similarly, any check can use the parameter skip to skip individual resources that the check should not be ran against.
The common check parameters are documented below.
Common Check Parameters
enabled
This parameter determines if a check will run. Checks that are not enabled will not be ran against any resources.
Example.
skip
This parameter will cause a check to skip running against a resource. The value used here should be the resource name.
Example.