Configuration
The configuration file smm_config.json is the central place to change features available in the software metrics machine. With the configuration file in json format you can set the provider you are using, the repository location and more. The following table depicts the supported configuration options.
| Key | Section | Description | Required | Default Value |
|---|---|---|---|---|
| PROVIDERS | ||||
| git_provider | Provider | The git provider to use (github, gitlab, etc) | Yes | github |
| github_token | Provider | The personal access token for GitHub | Yes | |
| REPOSITORY | ||||
| github_repository | Repository | The GitHub repository in the format user/repo | Yes | |
| git_repository_location | Repository | The local path to the git repository (for codemaat) | Yes | |
| METRICS | ||||
| deployment_frequency_target_pipeline | Metrics | The personal access token for GitLab | No | |
| deployment_frequency_target_job | Metrics | The personal access token for GitLab | No | |
| main_branch | Metrics | The main branch repository, usually main by default | No | |
| DASHBOARD | ||||
| dashboard_start_date | Dashboard | Specifies the start date to start the dashboard | No | |
| dashboard_end_date | Dashboard | Specifies the end date to start the dashboard | No | |
| loggin_level | CLI | Specifies the logging level to print in the terminal (INFO, CRITICAL, DEBUG) | No | CRITICAL |