diff --git a/public/mergify-github-app-logo.png b/public/mergify-github-app-logo.png new file mode 100644 index 0000000000..3e8a231917 Binary files /dev/null and b/public/mergify-github-app-logo.png differ diff --git a/src/content/docs/enterprise/installation.mdx b/src/content/docs/enterprise/installation.mdx index c2660836f1..6f45086313 100644 --- a/src/content/docs/enterprise/installation.mdx +++ b/src/content/docs/enterprise/installation.mdx @@ -4,6 +4,7 @@ description: 'Step-by-step process for deploying the on-premise image and wiring --- import { Image } from "astro:assets" +import DownloadLink from "../../../components/DownloadLink.astro" import installerScreen from "../../images/enterprise/installer.png" import createGitHubAppScreen from "../../images/enterprise/create-github-app.png" import installerEnvScreen from "../../images/enterprise/installer-env.png" @@ -108,6 +109,34 @@ The GitHub App creation and installation is finished. Mergify App Installation Success +## Set the GitHub App Logo + +The App you just created has no logo, so its check runs show GitHub's default +placeholder image on every pull request. Uploading a logo is a manual step: the +manifest the installer submits refuses any image field, and GitHub offers no API +to change an App registration once it exists. You only have to do it once, and it +applies to everything the App posts from then on. + +Download the Mergify +logo, or use your own image. GitHub accepts a PNG, JPG, or GIF +under 1 MB, and recommends 200 by 200 pixels. + +Then: + +1. Open your organization's **Settings → Developer settings → GitHub Apps** and + click **Edit** next to the App. The direct URL is + `https:///organizations//settings/apps/`, + where `` is `github.com` or your GitHub Enterprise Server + host. + +2. Under **Display information**, drag the image onto the logo area or click + **Upload a logo**. + +3. Adjust the crop if you need to, then click **Set new avatar**. + +A **Badge background color** field appears under the logo once one is uploaded. +It fills the background of the App's badge; `#000000` matches the Mergify logo. + ## Stop the Installer You can now stop the installer container: diff --git a/src/content/docs/enterprise/manual-installation-legacy.mdx b/src/content/docs/enterprise/manual-installation-legacy.mdx index ff28d32e7e..4d82b7b318 100644 --- a/src/content/docs/enterprise/manual-installation-legacy.mdx +++ b/src/content/docs/enterprise/manual-installation-legacy.mdx @@ -84,6 +84,9 @@ description: 'Legacy process for provisioning the Mergify GitHub App and engine From the GitHub App page, click **Install App**, pick your organization, choose the repositories to manage, and complete the installation. +The App has no logo at this point, so its check runs show GitHub's default placeholder image. See +[Set the GitHub App Logo](/enterprise/installation/#set-the-github-app-logo) to upload one. + ## 3. Build `mergify.env` Create a file named `mergify.env` with at least: