Post Check
Create a check-run on a pull request.
The post_check action allows Mergify to create a check-run on a pull request.
This can be useful in situations where you want to add a custom check to the
status of a pull request based on Mergify's evaluation.
Checks posted by Mergify using this action are usable as any other condition. See the example below.
Parameters
| Key name | Value type | |
|---|---|---|
success_conditions | list of condition | |
List of conditions to match to mark the pull request check as succeeded, otherwise, it will be marked as failing. If unset, the conditions from the rule that triggers this action are used. | ||
neutral_conditions | list of condition | |
List of conditions to match to mark the pull request check as neutral, otherwise, it will be marked as failing. | ||
summary | template | |
The summary of the check. | ||
title | template | |
The title of the check. | ||
As the title and summary are
templates, you can benefit from any pull
request attributes, e.g. {{author}},
and also these additional variables:
-
{{ check_rule_name }}the name of the rule that triggered this action; -
{{ check_succeed }}istrueif all the conditions match,falseotherwise; -
{{ check_conditions }}the list of all conditions with a checkbox marked if the condition matches.