wechuli/allcheckspassed

GitHub Action to check if all checks have passed on a specific commit

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
commit_shaThe commit sha that you want to checkno
tokenThe GitHub token to use for authenticationno${{ github.token }}
checks_includeA comma separated list of checks to include in the evaluation, by default, all checks are included. You can provide a list of map keys, with app_id and check_name, to include only checks from a specific app, or with a specific name. Supports regexno-1
checks_excludeA comma separated list of checks to exclude, if these checks fail,the action will not failno-1
treat_skipped_as_passedIf set to true, skipped checks will be treated as passednotrue
treat_neutral_as_passedIf set to true, neutral checks will be treated as passednotrue
include_status_commitsIf set to true, the action will also check commit statuses in addition to checksnofalse
pollWhether to poll the API for completed checks or to simply check once and exitnotrue
delayThe period in minutes to wait to allow the checks to completeno1
polling_intervalThe period in minutes between API calls that polls the GitHub Api for completed checks, shorter intervals may result in API rate limitingno1
retriesThe number of times to retry the API call to get the checks, if the API call failsno10
fail_fastThe action will fail the step as soon as a single conditions for failure is met, defaults to true. This terminates the action early if a failure occurs. If you want to wait for all checks to complete before failing, set this to falsenotrue
fail_stepIf set to true, the action will fail the step if the conditions for failure are met, defaults to true. Be careful with this option if you have configured rulesets/branch protection rules that require all checks to pass before mergingnotrue
fail_on_missing_checksIf set to true, the action will fail if one or more checks defined on the checks_include input are not found on the commitnofalse
verboseIf set to true, the action will log which checks are being waited on in each iterationnofalse
show_job_summaryIf set to true, the action will log a summary of the checks that were evaluatednotrue
ignore_superseded_runsIf set to true, checks from GitHub Actions will be grouped by workflow run and only the latest run per workflow will be evaluated. This filters out stale checks from superseded or re-run workflowsnofalse
check_run_idThis is the check run id of the current job, there is no need to set this (and setting it will actually cause a problem), the action will automatically set it for you. This is used to exclude the current job from the evaluationno${{ job.check_run_id }}
namedescription
checksList of checks that were evaluated
missing_checksList of checks that were not found on the commit