Branch search syntax is not documented

[BBI-YggyKing]

What article on docs.github.com is affected?

The article on searching pull requests has extensive information and examples about how to search pull requests, including the ability to search for PR's that have (or have not) been merged. There is no equivalent article for searching branches. It appears that branch search does not support is:unmerged or similar (though it would be great if this was supported), but there is no documentation to explain the branch search syntax.

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

I would like to see documentation on how to search branches, i.e. what is the query syntax for:
https://github.com/myorganization/myrepo/branches/all?query=???

Additional information

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[janiceilene]

👋 @BBI-YggyKing Thanks for opening this issue! I agree that an article like this would be beneficial. We'll need to get correct info from engineering on what syntax is supported. From there, we'll create a content strategy, we'll want the article to follow a similar format to our other search articles and also link to it from the branching content.

[amein0]

چه مقاله ای در docs.github.com تحت تأثیر قرار می گیرد؟

مقاله مربوط به جستجوی درخواست های کشش دارای اطلاعات و مثالهای گسترده ای در مورد چگونگی جستجوی درخواستهای کشش است ، از جمله توانایی جستجو برای روابط عمومی ادغام شده (یا نشده). هیچ مقاله ای معادل برای جستجوی شعب وجود ندارد. به نظر می رسد که جستجوی شعبه پشتیبانی نمی کند is:unmergedیا موارد مشابه (اگرچه اگر این پشتیبانی شود بسیار خوب است) ، اما هیچ اسنادی برای توضیح نحو جستجوی شاخه وجود ندارد.

دوست دارید کدام قسمت از مقاله را به روز کنید؟

من می خواهم اسنادی را در مورد نحوه جستجوی شاخه ها ببینم ، یعنی نحو پرس و جو برای چیست:
https://github.com/myorganization/myrepo/branches/all?query=???

اطلاعات تکمیلی

پرونده هنوز احتیاج به برسی دارد کمی زمان بر است و باید به دقت مرور شود نگران نباشید ما به صورت روح در حال برسی هستیم

[amein0]

@BBI-YggyKing

👋 @ BBI-YggyKing با تشکر برای باز کردن این شماره! من موافقم که مقاله ای از این دست مفید خواهد بود. ما باید اطلاعات صحیحی را از مهندسی در مورد پشتیبانی از نحو دریافت کنیم. از آنجا ، ما یک استراتژی محتوا ایجاد خواهیم کرد ، ما می خواهیم مقاله از قالب مشابه سایر مقالات جستجوی ما پیروی کند و همچنین از محتوای انشعاب به آن پیوند دهد.

این مورد نیار به برسی دارد تمای شعب بانکهای جهان باید در دسترس باشند هیچ موردی استثنا نیست حتی کشورهایی که در تحریم هستند باید شعب آنها در دسترس باشند و تعلیق شعب بعد از اتمام پروژه به عهده نمایندگان دولتها و تصمیم نهایی را مدیر بانک جهانی خواهد گرفت لطفا از درگیرهای سیاسی پرهیز کنید
من نیاز دچار فشار دولتها هستم اما درگیر مسائل سیاسی نیستم و از حقوق مردو و شهروندان دفاع میکنم این پروژه در راستای حقوق از مردم و شهروندان عادی است ن دفاع از دولتها
دقت داشته باشید اولویت ما پول الکترونیکی یعنی رمز ارزهای دیجیتال است ودرصد کمی را به پولهای رایج در پروژه قراد میدهیم.

[amein0]

@به استراتژی محتوا نیاز داریم

[janiceilene]

This is being triaged internally for now! For the writer who picks it up, please:

• Get the right syntax from engineering
• Create a simplified CS in this issue
• After the CS is reviewed, move this to the "available issues" column, add a help wanted and a good first issue label

[felicitymay]

Hi @BBI-YggyKing - thanks for raising this issue. You're right - this doesn't seem to be covered in the documentation at the moment.

I've just spoken to the engineering team who are responsible for the various search fields on GitHub.

• When you search in the main search field in GitHub (in the top left of the menu bar), this search includes only the code in your default branch.

• It sounds as if you're describing the search box on the branches page of a repository (Viewing branches in your repository). The engineering team have confirmed that this search field provides a simple, case-insensitive, sub-string search on the branch name. There is no additional syntax available currently.

I'm not entirely sure where best to cover the search on the branches page. The syntax is so simple that I'm not sure that it warrants a separate page among the other search topics. We could add a section about searching on the branches page to Viewing branches in your repository. This would be shown in the results if you searched for "searching branches".

Let me know what you think and we can update this issue with a content design plan to add the information.

[BBI-YggyKing]

You are correct, I was referring to the search box in the branches page. I had hoped there was syntax available there to find merged branches, unmerged branches, search by author, etc.

As far as documenting current behaviour, a short paragraph on the Viewing branches in your repository page to explain the simple functionality of the search box seems appropriate.

I'm inclined to open a feature request for more full-featured search functionality, but I guess that's a separate issue. :)