Summary checks
Configure Argos summary checks to combine commit statuses into one required status check before merging.
A summary check is a single commit status — argos/summary — that combines the result of all Argos builds on a commit. When your CI produces several builds (for example, one per app in a monorepo), the summary check gives you one status to glance at, and one status to require.
By default, Argos adds the summary check only when a commit has more than one build — a single build keeps its individual status (argos, or argos/<build-name> for a named build) with no summary added. See Commit status names for the exact context of each status Argos posts.
Summary checks are particularly useful as a required status check before merging: require the summary check instead of each individual build check, and the requirement keeps working as you add or rename builds.
Options
Argos offers three settings for summary checks:
Add a summary check only if there is more than one build — The default, recommended for most projects. The summary check appears when there are multiple builds to combine, and stays out of the way otherwise.
Always add a summary check — The summary check is posted even for a single build. Choose this if you require the summary check in your branch protection and some commits produce only one build — the required check is then always present.
Never add a summary check — Disable summary checks entirely if they don't add value to your workflow.
Summary checks are an additional layer of status reporting — they never replace the individual build statuses.
Configure summary checks
Go to your project Settings in Argos.
Locate the Summary Checks section.
Choose the option that fits your project.
Select Save to apply the changes.
Last updated
Was this helpful?