Configure Mavka Review Settings

Learn how to configure your Mavka reviews using a YAML configuration file.

CategoryMain information
Tags
  • configuration
  • mavkadocs

You can customize your Mavka reviews by using a YAML configuration file. Adhering to the following rules ensures the proper setup of your configuration file:

  • The file must be named mavka.yaml or mavka.yml
  • It should be placed in the root directory of your project(s)
  • Ensure that the file is properly configured (refer to the configuration file schema below)

Hint You may not need all the settings in your mavka.yaml file — only include the ones you need. Any configurations not explicitly defined will automatically use default values.

Mavka Config File Schema 

## exclude-branches
  type: array
  items:
    type: string
    description:
      A list of source branches from which pull requests should be excluded from review.
    example: 
      'dev' - pull requests from 'dev' to 'main' will be excluded from review
    default: []
  
## enable-pr-description
  type: boolean
  description: Enable or disable pull request description (summary).
  default: true

## enable-files-changes-info
  type: boolean
  description: Enable or disable descriptions of file changes for each modified file in the pull request.
  default: false

## enable-ticket-link-check
  type: boolean
  description: Enable or disable check for ticket or issue links in pull request commit messages.
  default: false

Rule The yaml configuration file must exist in the source branch to be considered by Mavka during a review.

Configuration Example

Below is an example of a properly configured mavka.yaml file:

# Configuration file for Mavka pull request review settings

# List of branches from which pull requests should not be reviewed
  exclude-branches:
    - "dev" # e.g., pull requests from 'dev' to 'main' will not be reviewed

# Enable/disable pull request description (summary)
  enable-pr-description: true

# Enable/disable file changes info
  enable-files-changes-info: true

# Enable/disable check for ticket or issue links in pull request commit messages
  enable-ticket-link-check: true
Table of contents