Context

When using Codemagic for CI/CD, you may want to report pull request build statuses to GitHub as Checks. This allows build summaries, statuses, and logs of individual build steps to appear in the Checks tab of a pull request in GitHub. Failed checks can also be configured to block merging of pull requests.

Answer

Note: Reporting to GitHub Checks is only available for repositories connected via the Codemagic GitHub App integration.

To enable GitHub Checks, you need to configure branch protection rules in your GitHub repository settings. Follow these steps:

1. In GitHub, open the Settings of your repository.

2. In the left menu, click Branches.

3. Click Add rule to add a new branch protection rule.

4. Enter the name of the branch you want to protect in the Branch name pattern field. For example, if you want to require checks on pull requests to the main branch, enter main.

5. Under Protect matching branches, check Require status checks to pass before merging.

6. Select the name of your Codemagic workflow to add it as a check. Note that the workflow name will only appear in the list if you have already built that workflow in Codemagic at least once.

7. Click Save changes.

Once configured, Codemagic will report the build summary along with the status and logs of individual build steps to GitHub for every build on the branch being merged. If reporting a commit check fails, Codemagic will attempt to fall back to reporting a commit status instead.

Re-running Checks: If a check fails, you can re-run failed builds or all builds in a check suite directly from the GitHub UI.