Skip to content

Update Copilot Setup Steps for use with a merge queue #43247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jonstacks wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update Copilot Setup Steps for use with a merge queue #43247

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c2f241
Initial plan
Copilot Mar 6, 2026
ac26e9f
docs: add merge queue note to copilot-setup-steps example
Copilot Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...ilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,9 @@ jobs:
# ...
```

> [!NOTE]
> If your repository uses a merge queue, the `push` trigger above will also run when pull requests are added to the merge queue. To prevent this, add `branches-ignore: ['gh-readonly-queue/**']` to the `push` trigger and restrict the `pull_request` trigger to your default branch with `branches: [YOUR-DEFAULT-BRANCH]`. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).
Copy link

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mitigation here implies both branches-ignore (on push) and restricting pull_request to the default branch are needed to stop merge-queue-related runs. In practice, the extra runs come from the merge queue pushing to gh-readonly-queue/**, so branches-ignore on push addresses that; tightening pull_request doesn’t prevent the merge-queue push-triggered runs and could unintentionally stop validation for PRs targeting non-default branches. Consider rewording to make the pull_request.branches restriction optional/separate, and (if relevant) call out that workflows required for merge queue checks should use the merge_group event instead of relying on push to queue branches.

Suggested change
> If your repository uses a merge queue, the `push` trigger above will also run when pull requests are added to the merge queue. To prevent this, add `branches-ignore: ['gh-readonly-queue/**']` to the `push` trigger and restrict the `pull_request` trigger to your default branch with `branches: [YOUR-DEFAULT-BRANCH]`. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).
> If your repository uses a merge queue, the `push` trigger above will also run when pull requests are added to the merge queue, because the merge queue pushes to `gh-readonly-queue/**` branches. To prevent these extra runs, add `branches-ignore: ['gh-readonly-queue/**']` to the `push` trigger. If you only want to validate pull requests that target your default branch, you can additionally restrict the `pull_request` trigger with `branches: [YOUR-DEFAULT-BRANCH]`, but this is optional and will stop validation for pull requests targeting other branches. For workflows that must participate in merge queue checks, consider using the `merge_group` event instead of relying on `push` to queue branches. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).

Copilot uses AI. Check for mistakes.

In your `copilot-setup-steps.yml` file, you can only customize the following settings of the `copilot-setup-steps` job. If you try to customize other settings, your changes will be ignored.

* `steps` (see above)
Expand Down
Loading