MergeMeMergeMe/Docs

Installation

GitHub.com

Connect MergeMe to GitHub by installing the MergeMe GitHub App on your org or account. No per-repo webhook setup is needed - the App handles that automatically.

Prerequisites

  • A MergeMe account (sign in at mergeme.dev with Google)
  • Owner access on the GitHub org or account you want to connect
  • A Slack workspace where notifications should appear

Setup

1

Create a workspace and choose GitHub.com

On first sign-in you'll be guided through onboarding. When asked to select a provider, choose GitHub.com.

2

Connect Slack

Open the Slack tab and click Connect Slack. Authorise the MergeMe bot in your Slack workspace.

3

Install the GitHub App

Open the GitHub tab and click Install GitHub App. You'll be redirected to GitHub.

Select the org or account you want to connect, then choose which repositories MergeMe can access - you can grant access to all repos or specific ones. Click Install.

You'll be redirected back to MergeMe automatically.

4

Add channel mappings

Open Channel Mappings. Select a repository from the dropdown (populated from your App installation), pick a Slack channel, and save.

No webhook registration is needed - the GitHub App already covers all repos you granted access to.

5

Map users (optional)

Open User Mappings. For each GitHub username, select the corresponding Slack user for @-mention resolution.

Permissions the App requests

PermissionWhy it's needed
Metadata: ReadMandatory for all GitHub Apps - enables repo listing
Pull requests: ReadRead PR data and receive PR webhook events
Issues: ReadRequired for PR comment events - GitHub sends general PR comments as issue_comment events

MergeMe does not request write access to pull requests, issues, or code.

Events MergeMe listens to

  • pull_request - opened, closed, merged, review requested
  • pull_request_review - review submitted (approved / changes requested / dismissed)
  • pull_request_review_comment - inline diff comments
  • issue_comment - general PR comments (filtered to PRs only)