Ignoring Content from Analysis

Qodo allows you to control what is excluded from analysis, including pull requests, files, and folders. Ignoring content helps reduce noise from automated changes, generated code, or areas that are out of scope, ensuring reviews focus only on relevant updates.

Ignoring files or folders from analysis

You can prevent Qodo from analyzing specific files or folders by defining ignore rules using glob or regex patterns. These rules can be applied per pull request or globally in the configuration.

Ignore all Python files in a single pull request:

/review --ignore.glob="['*.py']"

Ignore Python files for all pull requests using glob patterns:

[ignore]
glob = ['*.py']

Ignore Python files for all pull requests using regex:

[ignore]
regex = [".*\\.py$"]

Files whose paths match any configured glob or regex patterns will be excluded from analysis.

Ignoring pull requests from analysis

You can prevent automatic reviews from running on certain pull requests based on specific criteria:

• PRs with specific titles (using regex matching)

• PRs between specific branches (using regex matching)

• PRs from specific repositories (using regex matching)

• PRs not from specific folders

• PRs containing specific labels

• PRs opened by specific users

Ignoring PRs with specific titles

To ignore PRs with a specific title such as "[Bump]: ...", you can add the following to your configuration.toml file:

[config]
ignore_pr_title = ["\\[Bump\\]"]

Where the ignore_pr_title is a list of regex patterns to match the PR title you want to ignore. Default is ignore_pr_title = ["^\\[Auto\\]", "^Auto"].

Ignoring PRs between specific branches

To ignore PRs from specific source or target branches, you can add the following to your configuration.toml file:

[config]
ignore_pr_source_branches = ['develop', 'main', 'master', 'stage']
ignore_pr_target_branches = ["qa"]

Where the ignore_pr_source_branches and ignore_pr_target_branches are lists of regex patterns to match the source and target branches you want to ignore. They are not mutually exclusive, you can use them together or separately.

Ignoring PRs from specific repositories

To ignore PRs from specific repositories, you can add the following to your configuration.toml file:

[config]
ignore_repositories = ["my-org/my-repo1", "my-org/my-repo2"]

Where the ignore_repositories is a list of regex patterns to match the repositories you want to ignore. This is useful when you have multiple repositories and want to exclude certain ones from analysis.

Ignoring PRs not from specific folders

To allow only specific folders (often needed in large monorepos), set:

[config]
allow_only_specific_folders=['folder1','folder2']

For the configuration above, automatic feedback will only be triggered when the PR changes include files where 'folder1' or 'folder2' is in the file path

Ignoring PRs containing specific labels

To ignore PRs containing specific labels, you can add the following to your configuration.toml file:

[config]
ignore_pr_labels = ["do-not-merge"]

Where the ignore_pr_labels is a list of labels that when present in the PR, the PR will be ignored.

Ignoring PRs from specific users

Qodo tries to automatically identify and ignore pull requests created by bots using:

• GitHub's native bot detection system

• Name-based pattern matching

While this detection is robust, it may not catch all cases, particularly when:

• Bots are registered as regular user accounts

• Bot names don't match common patterns

To supplement the automatic bot detection, you can manually specify users to ignore. Add the following to your configuration.toml file to ignore PRs from specific users:

[config]
ignore_pr_authors = ["my-special-bot-user", ...]

Where the ignore_pr_authors is a regex list of usernames that you want to ignore.

There is one specific case where bots will receive an automatic response - when they generated a PR with a failed test. In that case, the ci_feedback tool will be invoked.

Ignoring generated files by language/framework

To automatically exclude files generated by specific languages or frameworks, you can add the following to your configuration.toml file:

[config]
ignore_language_framework = ['protobuf', ...]

You can view the list of auto-generated file patterns in generated_code_ignore.toml. Files matching these glob patterns will be automatically excluded from PR Agent analysis.

Ignoring tickets with specific labels

When Qodo analyzes tickets (JIRA, GitHub Issues, GitLab Issues, etc.) referenced in your PR, you may want to exclude tickets that have certain labels from the analysis. This is useful for filtering out tickets marked as "ignore-compliance", "skip-review", or other labels that indicate the ticket should not be considered during PR review.

To ignore tickets with specific labels, add the following to your configuration.toml file:

[config]
ignore_ticket_labels = ["ignore-compliance", "skip-review", "wont-fix"]

Where ignore_ticket_labels is a list of label names that should be ignored during ticket analysis.