GitHub Checks

.YAML Notifications GitHub Checks

How to report PR build statuses to GitHub as checks


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

If you have set up checks in GitHub, your workflow build summary will appear in the Checks tab of the pull request in GitHub. For every build on the branch to be merged, Codemagic will report the build summary along with the status and logs of individual build steps to GitHub. Failed checks will block merging the pull request. In case reporting commit check failed, Codemagic attempts to report commit status.

Checks can be set up in GitHub when configuring branch protection rules for a repository.

  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 master branch, enter master.
  5. Under Protect matching branches, check Require status checks to pass before merging.
  6. Select the name of the workflow to add it as a check. Note that the workflow name is listed only if you have already built this workflow in Codemagic.
  7. Click Save changes.

Note that it’s not currently possible to rerun failed checks (builds) from GitHub UI.