​
Configuration Files

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

[pr_reviews]
skip_filenames = ["foo.txt", "bar.txt", "*.log", "**/*.tmp", "test/**/*.spec.js"]
skip_branches = ["internal/*"]

[pr_reviews.comments]
taking_a_look = true  # Enable "Taking a look" comment (default: true)
no_findings = true    # Enable "Nice work" comment when no issues found (default: true)

​
YAML Example

pr_reviews:
  skip_filenames:
    - foo.txt
    - bar.txt
    - "*.log"
    - "**/*.tmp"
    - "test/**/*.spec.js"
  skip_branches:
    - internal/*
  comments:
    taking_a_look: true  # Enable "Taking a look" comment (default: true)
    no_findings: true    # Enable "Nice work" comment when no issues found (default: true)
Both formats are supported, choose the one that best fits your workflow.

​
Configuration Options

​
skip_filenames

List of additional filenames or glob patterns to skip. This field accepts a list (array) of patterns and works like gitignore, including support for negation patterns.
A standard list of lock files will automatically be added to the beginning of your configuration.
Supports:
  • Exact filename matches (e.g., "package-lock.json")
  • Glob patterns (e.g., "**/*.rbi", "foo/**/*.pyc")
  • Negation patterns with ! prefix (e.g., "!keep-this.json")
Order matters with negation patterns! Patterns are evaluated in the order they appear in your list. The last matching pattern determines whether a file is skipped or included. This follows the same behavior as gitignore files.

​
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.

​
comments

Configuration section for controlling which comments are posted during reviews. This allows you to enable or disable specific informational comments that the reviewer generates.

​
comments.taking_a_look

When set to true, posts the “Taking a look… 👀” comment at the start of a review. This comment indicates the review has started and is automatically deleted once the review is complete. Set to false to disable this comment. Default: true (comment is posted)

​
comments.no_findings

When set to true, posts the “Nice work! 😎” comment when no issues are found in the PR. Set to false to disable this comment - when disabled and there are no findings, no review comment will be posted at all. Default: true (comment is posted)
These settings only affect informational comments. Reviews with actual findings or suggestions will always be posted regardless of these settings.

​
Default Configuration

By default, all review comments are enabled: 
[pr_reviews.comments]
taking_a_look = true
no_findings = true
The following files are prepended to your skip file configuration by default: 
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
*.ico
*.jpeg
*.jpg
*.png
*.svg
By default, no branches are skipped.

​
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 is 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.