1. Install the App
On Settings → Integrations, an admin of the team presses Install on the GitHub App card. GitHub opens and asks two things: which account (you or an organisation), and which repositories — all of them, or only the ones you select. Press Install there.
GitHub sends you back to Integrations. The card now shows the account and how many repositories the App can see. That is all installing does: no check starts, nothing is linked to any app.
What the App may do in your repositories, and why:
- Read deployments — to hear that a deploy finished.
- Write checks — to put the result on the commit you deployed.
- Read contents and write pull requests — not used today.
2. Choose the repository of an app
Open the app, then Settings → Integrations → GitHub repository. Pick the repository this app is deployed from and when its deploys are checked: Production deploys or Off. Press Save.
One repository per app. The line under the choice says what will happen and what a check of this app usually costs. This is the step that turns checks on; before it, deploys start nothing.
3. What happens on a deploy
- Your host finishes a deploy and reports it to GitHub as a deployment. Vercel does this by itself. A deployment to an environment named
production(any case) counts; previews do not. - CheckMyApp starts a check of the app linked to that repository, for that commit. On the commit, a check named CheckMyApp appears as running.
- When the check ends, it shows the verdict, the number of problems and the price — for example “Needs attention · 1 finding · $0.61” — with a link to the full result. A broken app marks the commit as failed, a clean one as passed; anything in between is neutral, so it never blocks your merge on its own.
- One check of an app runs at a time. A deploy that lands while one is still running gets “Not checked” on its commit, with the reason.
- If a check does not finish on our side, the commit says so and nothing is charged.
4. What it costs
Each check is paid from your balance like any other: the app's usual price is shown in the line under its repository. A busy week of deploys is that price times the number of production deploys. Plans are on Pricing.
5. How to stop it
- For one app: set its GitHub repository to Off, or choose None, and Save.
- For everything: suspend or uninstall the App in your GitHub settings. A suspended App starts nothing.
your host does not report deployments?
Some hosts (Cloudflare Workers Builds, for one) post their own status on the commit but do not create GitHub deployments, so the App never hears about the deploy. Use one step in your workflow instead.