​
Installation

Install your Github Reviewer here: Github Reviewer

​
Configuration

You can configure our tool using either TOML or YAML format. To do so, create a file named zenable_config.toml or zenable_config.yaml in any directory of your repository.

TOML Example:

[github_reviewer]
skip_filenames = ["foo.txt", "bar.txt"]
skip_branches = ["internal/*"]

YAML Example:

github_reviewer:
  skip_filenames:
    - foo.txt
    - bar.txt
  skip_branches:
    - internal/*

Both formats are supported, choose the one that best fits your workflow.

​
Available options

  • skip_filenames: List of filenames to skip. This is a list of filenames, not a glob pattern.
  • skip_branches: List of branches to skip. You can use python regex to match the branch names. We will check all the patterns in the list, if any pattern match, the PR opened in that branch will be skipped.

​
Default configuration

The default configuration is the following:

[github_reviewer]
skip_filenames = [
            "conda-lock.yml",
            "bun.lock",
            "go.mod",
            "requirements.txt",
            "uv.lock",
            ".terraform.lock.hcl",
            "Gemfile.lock",
            "package-lock.json",
            "yarn.lock",
            "composer.lock",
            "poetry.lock",
            "pdm.lock",
            "Cargo.lock",
            "go.sum",
            "Package.resolved",
            "Podfile.lock",
            "mix.lock",
            ]
skip_branches = []

The default configuration will be loaded if no configuration is found or a configuration file is found but its invalid.

​
Troubleshooting

If you’re having issues with the Github Reviewer, try the following:

  • Check that you only have one configuration file in your repository, either zenable_config.toml or zenable_config.yaml. If you have multiple in different directories, the Github Reviewer will fail to load the configuration and will use the default configuration.

  • Check that the file its a valid TOML or YAML file and that the structure is correct.

  • The skip_branches option uses python regex to match the branch names. Check that the regex is correct.

  • If any of these solutions don’t work, you can contact our support team at support@zenable.io.