Skip to content

Commit 8120ee4

Browse files
authored
docs(mq): add browser extensions (#9681)
This documents the browser extensions for the merge queue.
1 parent 528b3ef commit 8120ee4

File tree

4 files changed

+65
-0
lines changed

4 files changed

+65
-0
lines changed
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: 'Browser Extensions'
3+
description: 'Install the Chrome or Firefox helpers that surface queue controls directly inside GitHub pull requests.'
4+
---
5+
6+
import { Image } from "astro:assets";
7+
import extensionListScreen from "../../images/merge-queue/browser-extensions/list.png";
8+
import extensionPrScreen from "../../images/merge-queue/browser-extensions/pr.png";
9+
10+
## Why use the browser extensions?
11+
12+
The Chrome and Firefox extensions inject a small Mergify toolbar into every GitHub pull request you
13+
open. The toolbar exposes the most common merge queue actions (such as queueing a pull request)
14+
without having to type [commands](/commands). Use it when you want to:
15+
16+
- Enqueue a pull request as soon as you review it.
17+
- Quickly dequeue without context switching.
18+
- See at a glance whether the pull request is already in one of your queues.
19+
20+
## Locate the official download links
21+
22+
The dashboard keeps the canonical links to the Chrome Web Store and Firefox Add-ons listing so you
23+
always grab the signed builds.
24+
25+
1. Sign in to the [Mergify dashboard](https://dashboard.mergify.com).
26+
2. Open `Settings → Browser Extensions` in the left navigation.
27+
3. Pick **Add to Chrome** or **Add to Firefox**.
28+
29+
<Image
30+
src={extensionListScreen}
31+
alt="Browser Extensions settings view in the Mergify dashboard"
32+
/>
33+
34+
## Install on Chrome or Firefox
35+
36+
### Chrome
37+
38+
1. Click **Add to Chrome** from the dashboard page.
39+
2. Confirm the permissions in the Chrome Web Store dialog.
40+
41+
### Firefox
42+
43+
1. Click **Add to Firefox** from the dashboard page.
44+
2. Approve the requested permissions in the Firefox Add-ons prompt.
45+
46+
## Use the queue controls inside GitHub
47+
48+
After installation, reload any pull request on GitHub. A Mergify toolbar appears near the GitHub
49+
merge box and displays queue-specific controls:
50+
51+
- **Queue** places the pull request into the selected merge queue with one click.
52+
53+
- **Dequeue** (available when the pull request is already in the queue) removes it without typing
54+
slash commands.
55+
56+
<Image
57+
src={extensionPrScreen}
58+
alt="Mergify browser extension toolbar injected into a GitHub pull request"
59+
/>
163 KB
Loading
58.1 KB
Loading

src/content/navItems.tsx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import {
2020
FaDiagramProject,
2121
FaGear,
2222
FaMoneyBill1,
23+
FaPuzzlePiece,
2324
FaRegCircleCheck,
2425
FaRegCirclePause,
2526
FaRegLightbulb,
@@ -170,6 +171,11 @@ const navItems: NavItem[] = [
170171
{ title: 'Monorepo', path: '/merge-queue/monorepo', icon: BsBoxes },
171172
{ title: 'Two-Step CI', path: '/merge-queue/two-step', icon: FaStairs },
172173
{ title: 'Deployment', path: '/merge-queue/deploy', icon: AiOutlineDeploymentUnit },
174+
{
175+
title: 'Browser Extensions',
176+
path: '/merge-queue/browser-extensions',
177+
icon: FaPuzzlePiece,
178+
},
173179
{ title: 'Monitoring', path: '/merge-queue/monitoring', icon: MdMonitorHeart },
174180
],
175181
},

0 commit comments

Comments
 (0)