2024-03-06 19:52:11 +00:00
## Overview
2024-02-16 18:30:29 +00:00
The CI feedback tool (`/checks)` automatically triggers when a PR has a failed check.
The tool analyzes the failed checks and provides several feedbacks:
2024-03-06 19:52:11 +00:00
2024-02-16 18:30:29 +00:00
- Failed stage
- Failed test name
- Failure summary
- Relevant error logs
2024-04-18 07:04:38 +00:00
## Example usage
2024-03-26 21:00:57 +00:00
{width=768}
2024-02-16 18:30:29 +00:00
→
2024-03-26 21:00:57 +00:00
{width=768}
2024-02-16 18:30:29 +00:00
___
In addition to being automatically triggered, the tool can also be invoked manually by commenting on a PR:
```
/checks "https://github.com/{repo_name}/actions/runs/{run_number}/job/{job_number}"
```
where `{repo_name}` is the name of the repository, `{run_number}` is the run number of the failed check, and `{job_number}` is the job number of the failed check.
2024-04-18 13:31:41 +00:00
## Disabling the tool from running automatically
If you wish to disable the tool from running automatically, you can do so by adding the following configuration to the configuration file:
```
[checks]
enable_auto_checks_feedback = false
```
2024-03-06 19:52:11 +00:00
## Configuration options
2024-02-16 18:30:29 +00:00
- `enable_auto_checks_feedback` - if set to true, the tool will automatically provide feedback when a check is failed. Default is true.
- `excluded_checks_list` - a list of checks to exclude from the feedback, for example: ["check1", "check2"]. Default is an empty list.
- `persistent_comment` - if set to true, the tool will overwrite a previous checks comment with the new feedback. Default is true.
2024-02-21 06:55:59 +00:00
- `enable_help_text=true` - if set to true, the tool will provide a help message when a user comments "/checks" on a PR. Default is true.
2024-03-07 08:01:40 +00:00
- `final_update_message` - if `persistent_comment` is true and updating a previous checks message, the tool will also create a new message: "Persistent checks updated to latest commit". Default is true.