Include org teams for PR reviewers #11407

andyfeller · 2025-07-29T22:22:55Z

This PR enhances the following scenarios to include organization teams as pull request reviewers:

Interactive gh pr create during additional metadata
Tab completing gh pr create --reviewer
Tab completing gh pr edit --add-reviewer
Tab completing gh pr edit --remove-reviewer

Additionally, a new gh pr create test case for ensuring that teams show up within interactive prompts has been added.

Demo

Building this branch locally and testing in personal repositories:

cli/cli ‹andyfeller/11403-pr-team-reviewers›$ make clean && make
rm -rf bin share
go build -trimpath -ldflags "-X github.com/cli/cli/v2/internal/build.Date=2025-07-29 -X github.com/cli/cli/v2/internal/build.Version=v2.76.1-3-g8f20f0ab5 " -o bin/gh ./cmd/gh

cli/cli ‹andyfeller/11403-pr-team-reviewers›$ alias gh=$(realpath bin/gh)

`gh pr create --reviewer` tab completion

‹cli-v2.76.1-pr-create-testing*›$ gh pr create --reviewer amenocal
amenocal                                   -- Alejandro Menocal
apdarr                                     -- Alex Darr
david-wiggs                                -- David Wiggs
decyjphr                                   -- Yadhav Jayaraman
enyil                                      -- Enyil Valle
evgenyrahman                               -- Evgeny Rahman
garnertb                                   -- Tyler Garner
JaredEgolf                                 -- Jared Egolf
jefeish                                    -- Jürgen Efeish
jonwicksy                                  -- Jon Wicks
katiem0                                    -- Katie May
kevfoste                                   -- Kevin Foster
polivebranch                               -- Payton Oliveri
ssulei7                                    -- Sully
vila89                                     -- Victoria Lam
tinyfists/actions-monorepo                 tinyfists/lgtm                             tinyfists/ps-delivery-engineers          
tinyfists/actions-monorepo-microservice-a  tinyfists/lgtm-reviewers                   tinyfists/pull-perms                     
tinyfists/actions-monorepo-microservice-b  tinyfists/lgtm-sensitive                   tinyfists/readers                        
tinyfists/actions-monorepo-microservice-c  tinyfists/lgtm-sensitive-reviewers         tinyfists/reposteam                      
tinyfists/actions-monorepo-microservice-d  tinyfists/monks                            tinyfists/reviewers                      
tinyfists/admin                            tinyfists/mostly-away                      tinyfists/team-jessica                   
tinyfists/away                             tinyfists/omni-reviewers                   tinyfists/under_scores                   
tinyfists/gh-pr-reviewers                  tinyfists/partly-away

`gh pr create` interactive reviewers metadata

tinyfists/gh-pr-test ‹cli-v2.76.1-pr-create-testing*›$ gh pr create
? Where should we push the 'cli-v2.76.1-pr-create-testing' branch? tinyfists/gh-pr-test
Working...

Creating pull request for cli-v2.76.1-pr-create-testing into main in tinyfists/gh-pr-test

? Title (required) Adding file to test with
? Choose a template Open a blank pull request
? Body <Received>
? What's next? Add metadata
? What would you like to add? Reviewers
Working...
? Reviewers  [Use arrows to move, space to select, <right> to all, <left> to none, type to filter]
> [ ]  amenocal (Alejandro Menocal)
  [ ]  apdarr (Alex Darr)
  [ ]  david-wiggs (David Wiggs)
  [ ]  decyjphr (Yadhav Jayaraman)
  [ ]  enyil (Enyil Valle)
  [ ]  evgenyrahman (Evgeny Rahman)
  [ ]  garnertb (Tyler Garner)
  [ ]  JaredEgolf (Jared Egolf)
  [ ]  jefeish (Jürgen Efeish)
  [ ]  jonwicksy (Jon Wicks)
  [ ]  katiem0 (Katie May)
  [ ]  kevfoste (Kevin Foster)
  [ ]  polivebranch (Payton Oliveri)
  [ ]  ssulei7 (Sully)
  [ ]  vila89 (Victoria Lam)
  [ ]  tinyfists/actions-monorepo
  [ ]  tinyfists/actions-monorepo-microservice-a
  [ ]  tinyfists/actions-monorepo-microservice-b
  [ ]  tinyfists/actions-monorepo-microservice-c
  [ ]  tinyfists/actions-monorepo-microservice-d
  [ ]  tinyfists/admin
  [ ]  tinyfists/away
  [ ]  tinyfists/gh-pr-reviewers
  [ ]  tinyfists/lgtm
  [ ]  tinyfists/lgtm-reviewers
  [ ]  tinyfists/lgtm-sensitive
  [ ]  tinyfists/lgtm-sensitive-reviewers
  [ ]  tinyfists/monks
  [ ]  tinyfists/mostly-away
  [ ]  tinyfists/omni-reviewers
  [ ]  tinyfists/partly-away
  [ ]  tinyfists/ps-delivery-engineers
  [ ]  tinyfists/pull-perms
  [ ]  tinyfists/readers
  [ ]  tinyfists/reposteam
  [ ]  tinyfists/reviewers
  [ ]  tinyfists/team-jessica
  [ ]  tinyfists/under_scores

Finishing the creation process:

$ gh pr create
? Where should we push the 'cli-v2.76.1-pr-create-testing' branch? tinyfists/gh-pr-test
Working...

Creating pull request for cli-v2.76.1-pr-create-testing into main in tinyfists/gh-pr-test

? Title (required) Adding file to test with
? Choose a template Open a blank pull request
? Body <Received>
? What's next? Add metadata
? What would you like to add? Reviewers
Working...
? Reviewers tinyfists/monks
? What's next? Submit
To https://github.com/tinyfists/gh-pr-test.git
   e1fff86..ec05429  HEAD -> cli-v2.76.1-pr-create-testing
branch 'cli-v2.76.1-pr-create-testing' set up to track 'origin/cli-v2.76.1-pr-create-testing'.
Working...
https://github.com/tinyfists/gh-pr-test/pull/11

In this case, the code owners were selected for reviewers due to repository ruleset but tinyfists/monks didn't have permission to the repo:

After fixing the repo permissions, this just provides opportunity to test the next fix...

`gh pr edit --add-reviewer` tab completion

$ gh pr edit 11 --add-reviewer amenocal
amenocal                                   -- Alejandro Menocal
apdarr                                     -- Alex Darr
david-wiggs                                -- David Wiggs
decyjphr                                   -- Yadhav Jayaraman
enyil                                      -- Enyil Valle
evgenyrahman                               -- Evgeny Rahman
garnertb                                   -- Tyler Garner
JaredEgolf                                 -- Jared Egolf
jefeish                                    -- Jürgen Efeish
jonwicksy                                  -- Jon Wicks
katiem0                                    -- Katie May
kevfoste                                   -- Kevin Foster
polivebranch                               -- Payton Oliveri
ssulei7                                    -- Sully
vila89                                     -- Victoria Lam
tinyfists/actions-monorepo                 tinyfists/lgtm                             tinyfists/ps-delivery-engineers          
tinyfists/actions-monorepo-microservice-a  tinyfists/lgtm-reviewers                   tinyfists/pull-perms                     
tinyfists/actions-monorepo-microservice-b  tinyfists/lgtm-sensitive                   tinyfists/readers                        
tinyfists/actions-monorepo-microservice-c  tinyfists/lgtm-sensitive-reviewers         tinyfists/reposteam                      
tinyfists/actions-monorepo-microservice-d  tinyfists/monks                            tinyfists/reviewers                      
tinyfists/admin                            tinyfists/mostly-away                      tinyfists/team-jessica                   
tinyfists/away                             tinyfists/omni-reviewers                   tinyfists/under_scores                   
tinyfists/gh-pr-reviewers                  tinyfists/partly-away

And finally...

`gh pr edit --remove-reviewer` tab completion

$ gh pr edit 11 --remove-reviewer tinyfists/monks
amenocal                                   -- Alejandro Menocal
apdarr                                     -- Alex Darr
david-wiggs                                -- David Wiggs
decyjphr                                   -- Yadhav Jayaraman
enyil                                      -- Enyil Valle
evgenyrahman                               -- Evgeny Rahman
garnertb                                   -- Tyler Garner
JaredEgolf                                 -- Jared Egolf
jefeish                                    -- Jürgen Efeish
jonwicksy                                  -- Jon Wicks
katiem0                                    -- Katie May
kevfoste                                   -- Kevin Foster
polivebranch                               -- Payton Oliveri
ssulei7                                    -- Sully
vila89                                     -- Victoria Lam
tinyfists/actions-monorepo                 tinyfists/lgtm                             tinyfists/ps-delivery-engineers          
tinyfists/actions-monorepo-microservice-a  tinyfists/lgtm-reviewers                   tinyfists/pull-perms                     
tinyfists/actions-monorepo-microservice-b  tinyfists/lgtm-sensitive                   tinyfists/readers                        
tinyfists/actions-monorepo-microservice-c  tinyfists/lgtm-sensitive-reviewers         tinyfists/reposteam                      
tinyfists/actions-monorepo-microservice-d  tinyfists/monks                            tinyfists/reviewers                      
tinyfists/admin                            tinyfists/mostly-away                      tinyfists/team-jessica                   
tinyfists/away                             tinyfists/omni-reviewers                   tinyfists/under_scores                   
tinyfists/gh-pr-reviewers                  tinyfists/partly-away

This commit enhances the following scenarios to include organization teams as pull request reviewers: 1. Interactive `gh pr create` during additional metadata 2. Tab completing `gh pr create --reviewer` 3. Tab completing `gh pr edit --add-reviewer` 4. Tab completing `gh pr edit --remove-reviewer` Additionally, a new `gh pr create` test case for ensuring that teams show up within interactive prompts has been added.

Copilot

Pull Request Overview

This PR enhances the GitHub CLI to include organization teams as reviewers when creating and editing pull requests. The change addresses issue #11403 by ensuring teams are fetched and available for selection in interactive prompts and tab completion scenarios.

Enable team reviewers to be fetched when creating PRs interactively
Include team reviewers in tab completion for --reviewer and --add-reviewer/--remove-reviewer flags
Add comprehensive test coverage for interactive team reviewer selection

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File	Description
pkg/cmd/pr/shared/survey.go	Enables fetching team reviewers when "Reviewers" metadata is selected
pkg/cmd/pr/shared/completion.go	Updates completion logic to include team reviewers alongside individual reviewers
pkg/cmd/pr/create/create_test.go	Adds test case verifying team reviewers appear in interactive prompts and updates existing test names

This commit moves the `gh pr create` tab completion test closer to the logic rather than the commands that use it. This should ensure that any command or flag that lists reviewers will present teams and users as expected.

babakks

LGTM! Thanks for the quick fix! 🍻

babakks · 2025-07-30T13:29:18Z

pkg/cmd/pr/create/create_test.go

+							if v, ok := inputs["assigneeIds"]; ok {
+								t.Errorf("did not expect assigneeIds: %v", v)
+							}
+							if v, ok := inputs["userIds"]; ok {
+								t.Errorf("did not expect userIds: %v", v)
+							}


For consistency you can use require/assert:

Suggested change

if v, ok := inputs["assigneeIds"]; ok {

t.Errorf("did not expect assigneeIds: %v", v)

}

if v, ok := inputs["userIds"]; ok {

t.Errorf("did not expect userIds: %v", v)

}

assert.NotContains(t, inputs, "assigneeIds")

assert.NotContains(t, inputs, "userIds")

I appreciate that suggestion 🙇 I based this test on an existing gh pr create test and was reusing its logic, so we might need to update multiple tests 🤔

pkg/cmd/pr/shared/completion_test.go

babakks · 2025-07-30T13:40:11Z

pkg/cmd/pr/shared/completion_test.go

+			},
+		},
+		{
+			name:              "when users are available but teams aren't, users are listed",


This is just to improve coverage, so feel free to skip.

What do you think about another test case to simulate the Could not resolve to an Organization API error? It can be added here, or rather to api/queries_repo_test.go.

That is a solid suggestion 🤔

I'd like to follow this PR up with that improvement so we can ship this regression fix while not forgetting about this. I thought I had this exact response documented in my notes but I can't find it 😞

BagToad

Looks good to me, thanks!

andyfeller · 2025-07-30T21:05:22Z

Following up on govulncheck failure, github.com/go-chi/chi@v4.1.2+incompatible is a 2nd order, transitive dependency by way of github.com/sigstore/sigstore-go v1.1.0 and github.com/sigstore/rekor.

github.com/go-chi/chi@v5 has been out for a few years now, so there is a larger dependency vulnerability challenge here that we should work with @cli/package-security to work with the larger Sigstore community to fix perhaps? 🤷

I'm going to proceed with merging these changes for a hotfix while following up on an improved test for GraphQL resolve error mentioned by @babakks

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | patch | `v2.76.1` -> `v2.76.2` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>cli/cli (cli/cli)</summary> ### [`v2.76.2`](https://github.com/cli/cli/releases/tag/v2.76.2): GitHub CLI 2.76.2 [Compare Source](cli/cli@v2.76.1...v2.76.2) #### `gh pr create` regression fix This release fixes a regression introduced in `v2.76.1` where organization teams were not present in prompts for pull request reviewers. This caused problems in multiple commands: - Interactive `gh pr create` could not select teams when adding pull request reviewers - Tab completions with `gh pr create --reviewer` flag did not present a list of organization teams - Tab completions with `gh pr edit --add-reviewer` flag did not present a list of organization teams - Tab completions with `gh pr edit --remove-reviewer` flag did not present a list of organization teams For more information, see cli/cli#11403 #### What's Changed ##### 🐛 Fixes - Include org teams for MR reviewers by [@andyfeller](https://github.com/andyfeller) in cli/cli#11407 ##### 📚 Docs & Chores - Delete obsolete comment about `gh-models` not respecting API rate-limit by [@babakks](https://github.com/babakks) in cli/cli#11398 **Full Changelog**: cli/cli@v2.76.1...v2.76.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever MR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Copilot AI review requested due to automatic review settings July 29, 2025 22:22

andyfeller requested a review from a team as a code owner July 29, 2025 22:22

andyfeller requested a review from babakks July 29, 2025 22:22

andyfeller temporarily deployed to cli-automation July 29, 2025 22:23 — with GitHub Actions Inactive

Copilot AI reviewed Jul 29, 2025

View reviewed changes

cliAutomation assigned andyfeller Jul 29, 2025

andyfeller mentioned this pull request Jul 29, 2025

PR Create lost the ability to ask review from teams #11403

Closed

andyfeller added 2 commits July 30, 2025 09:16

Test gh pr create --reviewer tab completion

c9bc185

Refactor tab completion test

bbc3d02

This commit moves the `gh pr create` tab completion test closer to the logic rather than the commands that use it. This should ensure that any command or flag that lists reviewers will present teams and users as expected.

babakks approved these changes Jul 30, 2025

View reviewed changes

BagToad approved these changes Jul 30, 2025

View reviewed changes

andyfeller merged commit a2e23a2 into trunk Jul 30, 2025
10 of 11 checks passed

andyfeller deleted the andyfeller/11403-pr-team-reviewers branch July 30, 2025 21:05

This comment was marked as spam.

Sign in to view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Include org teams for PR reviewers #11407

Include org teams for PR reviewers #11407

Uh oh!

andyfeller commented Jul 29, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

babakks left a comment

Uh oh!

babakks Jul 30, 2025

Uh oh!

andyfeller Jul 30, 2025

Uh oh!

Uh oh!

babakks Jul 30, 2025

Uh oh!

andyfeller Jul 30, 2025

Uh oh!

BagToad left a comment

Uh oh!

andyfeller commented Jul 30, 2025

Uh oh!

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

Uh oh!

Include org teams for PR reviewers #11407

Include org teams for PR reviewers #11407

Uh oh!

Conversation

andyfeller commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Demo

gh pr create --reviewer tab completion

gh pr create interactive reviewers metadata

gh pr edit --add-reviewer tab completion

gh pr edit --remove-reviewer tab completion

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

babakks left a comment

Choose a reason for hiding this comment

Uh oh!

babakks Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

andyfeller Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

babakks Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

andyfeller Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

BagToad left a comment

Choose a reason for hiding this comment

Uh oh!

andyfeller commented Jul 30, 2025

Uh oh!

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

Uh oh!

andyfeller commented Jul 29, 2025 •

edited

Loading

`gh pr create --reviewer` tab completion

`gh pr create` interactive reviewers metadata

`gh pr edit --add-reviewer` tab completion

`gh pr edit --remove-reviewer` tab completion