Skip to content

Install the GitHub App ​

EasyMerge is a GitHub App. Installing it is what grants access to repositories; signing in alone does not.

Existing organization installation?

If a teammate has already installed EasyMerge, sign in with GitHub. Do not create a second installation.

Sign in vs. install ​

These are two separate GitHub screens, and you will see both the first time:

StepWhat GitHub asksWhat it grants
Sign inAuthorize EasyMerge to act as youYour identity and the list of installations you can see
InstallChoose an account and repositoriesAnalyse pull request changes and post review comments on those repositories

If you already have an installation and just want dashboard access; for example, a teammate installed it on your organization; signing in is enough.

Permissions requested ​

PermissionLevelWhy
MetadataReadRequired by GitHub for every app
ContentsReadRead pull request changes and the context needed to review them
Pull requestsRead & writeRead PRs and post the review
IssuesRead & writePR-level (non-inline) comments go through the Issues API
ChecksRead & writeMaintain the EasyMerge Review check run and read checks on Dependabot fix PRs
Commit statusesReadShow statuses reported for Dependabot fix PRs
Dependabot alertsReadShow dependency alerts in Security Center
AdministrationReadCheck whether Dependabot alerts and security updates are enabled
Email addressesReadRead your email at sign-in when it is not public
Organization membersReadCheck whether you own the organization, to decide who gets the EasyMerge admin role

EasyMerge never asks for write access to your code or repository administration. It cannot push commits, create branches, change repository settings, or merge anything.

Approving new permissions ​

When EasyMerge adds a GitHub permission, an owner must approve it for an existing installation. Until then, GitHub leaves the installation on its previous permissions.

EasyMerge shows a banner when the read permissions needed for Security Center are waiting for approval. Follow its Configure on GitHub link, review the request and approve it. Pull request reviews continue while approval is pending, but EasyMerge cannot sync Dependabot alerts for that installation.

Approving the App is only one part of dependency-security setup. You must also enable the required GitHub features on each repository; see Set up GitHub.

Choosing where to install ​

Personal account; installs immediately.

Organization; if you are an owner it installs immediately; otherwise GitHub sends a request an owner has to approve, and EasyMerge stays inactive until they do.

Then pick the repository scope:

  • All repositories; including ones created later.
  • Only select repositories; an explicit list you maintain.

Either choice can be changed later without reinstalling.

Manage repositories and members ​

Change the app's repository access on GitHub: Settings → Applications → Installed GitHub Apps → EasyMerge → Configure. For organization roles and review settings, see Connect repositories.

Uninstalling ​

Removing the app on GitHub stops all reviews for that account immediately, and removes that installation's repositories, reviews and findings from the dashboard; see Deleting your data.

Existing pull request comments stay where they are: EasyMerge does not delete anything from your repositories on the way out.