You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/learn/integrations/github.mdx
+19-4Lines changed: 19 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,11 +58,11 @@ Argos needs the following permissions to operate:
58
58
59
59
We take your security and privacy seriously. If you have any concerns or questions, please [contact us](https://argos-ci.com/contact).
60
60
61
-
## GitHub Merge Queue support
61
+
## Merge Queue support
62
62
63
-
Argos supports GitHub Merge Queue when you use the full-access Argos GitHub App. Merge Queue relies on Argos reading commit history to compute merge bases and publish required checks, so the restricted “GitHub without content access” integration does not support it. When Argos runs inside the mergequeue, it compares your queued change against the previously approved commit on the target branch to ensure only clean visual changes are merged.
63
+
When Argos runs inside the merge queue, it compares the queued changes against the merge base of all pull requests in the queue, ensuring that visual tests reflect the final merged state. This is supported out of the box with [GitHub's native Merge Queue](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue), and can be configured for custom merge queue systems as well.
64
64
65
-
### GitHub Actions setup for Merge Queue
65
+
### GitHub Actions setup for GitHub Merge Queue
66
66
67
67
Listen to both `pull_request` and `merge_group` events so Argos uploads run for PR reviews and for queued merges:
When you are using a merge queue system other than GitHub’s built-in Merge Queue (like [Mergify](https://mergify.com/)), you can set `ARGOS_MERGE_QUEUE_PRS` to the comma-separated pull request numbers included in the queued build. This tells Argos to treat the upload as a merge queue build and use the right baseline for visual comparisons.
91
+
92
+
```yml
93
+
steps:
94
+
- name: Upload screenshots to Argos
95
+
env:
96
+
ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
97
+
ARGOS_MERGE_QUEUE_PRS: "101,102"
98
+
run: npm exec -- argos upload ./screenshots
99
+
```
100
+
101
+
Use the pull request numbers included in the merge queue batch. Passing `ARGOS_MERGE_QUEUE_PRS` tells Argos to treat the upload as a merge queue build.
102
+
88
103
## GitHub Integration without Content Permission
89
104
90
-
If you prefer to use Argos without granting full content access to your repositories, you can integrate via a more restricted setup. This mode does not support Merge Queue because Argos cannot read commit history.
105
+
If you prefer to use Argos without granting full content access to your repositories, you can integrate via a more restricted setup.
0 commit comments