`restrict-creations` should warn about compatibility with merge queues

Open Beginner friendly
#45,334 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
github
Domain
documentation

Research direction

Start with the Restrict creations section in the affected available-rules-for-rulesets article, then read the linked merge queue article and community discussion for context. Done means the section clearly explains the required GitHub Merge Queue bypass when the rule matches merge queue branches, with the relevant branch pattern documented accurately.

Written by the indexing model from the issue text.

Description

content needs SME never-stale repositories Waiting on SME review
Code of Conduct
What article on docs.github.com is affected?

https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#restrict-creations

What part(s) of the article would you like to see updated?

Restrict creations

Explain that you need to add the GitHub Merge Queue app to the bypass list if you apply the rule to "all branches" (or anything that would match the github merge queue branch pattern)

Additional information

The github merge-queue prefix appears to be documented as gh-readonly-queue/{base_branch}:

https://github.com/github/docs/blob/68352680faac5483ecbe6472c5a20c5d81bb2ec0/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md?plain=1#L49

Dominant language
TypeScript
Stars
20.9k
Forks
68.8k
Avg merge
15h 4m
Merged PRs (30d)
103

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/docs

All issues in github/docs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.