docs(enterprise): tell self-hosted admins to upload the App logo - #12391
Merged
Conversation
The GitHub App the Enterprise installer creates has no logo, so Mergify's check runs render with GitHub's default placeholder on every pull request of every self-hosted install. Nothing in the Enterprise guide mentioned it, so admins had no reason to know it was theirs to fix. Add a "Set the GitHub App Logo" section to the installation guide, right after the App is created and installed, plus a pointer to it from the legacy manual-installation page. It covers where an org-owned App's settings page lives on either github.com or a GHES host, the Display information -> Upload a logo -> crop -> Set new avatar flow, the file constraints, and the Badge background color field that only shows up once a logo is uploaded. The section says in one sentence why this is manual, so nobody goes looking for an API: GitHub's App manifest rejects any image field, and an App registration cannot be modified through the API after creation. Ship a square asset for admins to upload: public/mergify-github-app-logo.png, a 200x200 PNG of the Mergify mark matching the one the hosted App uses, so self-hosted checks look like the hosted ones. The installer's vendored wordmark is 1024x275 and crops badly, so it is not usable here. MRGFY-418 Change-Id: Ia11c411bad8e7bab1e7ae933961e751e70099fd9
Contributor
Merge Protections🟢 All 6 merge protections satisfied — ready to merge. Show 6 satisfied protections🟢 🤖 Continuous Integration
🟢 👀 Review Requirements
🟢 Enforce conventional commitMake sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 🔎 Reviews
🟢 📕 PR description
🟢 🚦 Auto-queueWhen all merge protections are satisfied, this pull request will be queued automatically. |
There was a problem hiding this comment.
Pull request overview
Adds explicit documentation for Mergify Enterprise (self-hosted) administrators to upload a GitHub App logo so check runs don’t show GitHub’s default placeholder image, and cross-links the legacy manual-installation page to this new guidance.
Changes:
- Adds a new “Set the GitHub App Logo” section to the Enterprise installation guide with step-by-step instructions and a downloadable logo link.
- Adds a pointer from the legacy manual-installation guide to the new logo section.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/content/docs/enterprise/manual-installation-legacy.mdx | Adds a short note explaining why check runs show a placeholder and links to the new logo instructions. |
| src/content/docs/enterprise/installation.mdx | Introduces the new “Set the GitHub App Logo” section and references a downloadable logo asset. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
jd
marked this pull request as ready for review
August 14, 2026 09:34
kozlek
approved these changes
Aug 14, 2026
JulianMaurin
approved these changes
Aug 14, 2026
Contributor
Merge Queue Status
This pull request spent 2 minutes 31 seconds in the queue, including 2 minutes 3 seconds running CI. Required conditions to merge
|
60 tasks
mergify
Bot
deleted the
devs/jd/jd/mrgfy-418-add-procedure-to-add-logo-manually/tell-self-hosted-admins-upload-app-logo--a11c411b
branch
August 14, 2026 11:59
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The GitHub App the Enterprise installer creates has no logo, so Mergify's
check runs render with GitHub's default placeholder on every pull request
of every self-hosted install. Nothing in the Enterprise guide mentioned
it, so admins had no reason to know it was theirs to fix.
Add a "Set the GitHub App Logo" section to the installation guide, right
after the App is created and installed, plus a pointer to it from the
legacy manual-installation page. It covers where an org-owned App's
settings page lives on either github.com or a GHES host, the Display
information -> Upload a logo -> crop -> Set new avatar flow, the file
constraints, and the Badge background color field that only shows up once
a logo is uploaded.
The section says in one sentence why this is manual, so nobody goes
looking for an API: GitHub's App manifest rejects any image field, and an
App registration cannot be modified through the API after creation.
Ship a square asset for admins to upload: public/mergify-github-app-logo.png,
a 200x200 PNG of the Mergify mark matching the one the hosted App uses, so
self-hosted checks look like the hosted ones. The installer's vendored
wordmark is 1024x275 and crops badly, so it is not usable here.
MRGFY-418