STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(featuredetection): document GHES removal criteria for ApiActorsSupported

Browse source 
Expand the ApiActorsSupported doc comment to explain the two API
generations (legacy AssignableUser vs actor-based AssignableActor),
what each returns, and the specific GraphQL schema additions to
check for when evaluating GHES support.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
Kynan Ware 2026-03-24 21:15:39 -06:00
parent ae5e857c2e
commit 92f205e54b
1 changed files with 23 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

28
internal/featuredetection/feature_detection.go
View file

@ -24,11 +24,29 @@ type Detector interface {
type IssueFeatures struct {
// TODO ApiActorsSupported
// ApiActorsSupported indicates the host supports actor-based APIs
// (replaceActorsForAssignable, requestReviewsByLogin, suggestedAssignableActors, etc.).
// True for github.com and ghe.com. False for GHES.
// Remove this flag once GHES supports these mutations, then collapse all
// // TODO ApiActorsSupported sites to the actor-only path.
// ApiActorsSupported indicates the host supports actor-based APIs. True for
// github.com and ghe.com, false for GHES.
//
// The GitHub API has two generations of assignee/reviewer types:
//
// Legacy (GHES): Uses AssignableUser (users only) and node-ID-based mutations.
// - assignableUsers query returns []AssignableUser
// - Mutations take node IDs (assigneeIds, userReviewerIds, teamReviewerIds)
//
// Actor-based (github.com): Uses AssignableActor (User + Bot union) and
// login-based mutations, enabling assignment of non-user actors like Copilot.
// - suggestedActors query returns []AssignableActor (User | Bot)
// - suggestedReviewerActors returns []ReviewerCandidate (User | Bot | Team)
// - Mutations take logins (replaceActorsForAssignable, requestReviewsByLogin)
//
// When GHES adds support for the actor-based types and mutations, this flag
// can be removed and all // TODO ApiActorsSupported sites collapsed to the
// actor-only path. To verify GHES support, check whether the GHES GraphQL
// schema includes:
// - The suggestedActors field on Repository (assignee search)
// - The suggestedReviewerActors field on PullRequest (reviewer search)
// - The replaceActorsForAssignable mutation
// - The requestReviewsByLogin mutation
ApiActorsSupported bool
}