x/build/maintner: GitHubIssue.ClosedBy field is never populated #28745
Labels
Builders
x/build issues (builders, bots, dashboards)
help wanted
NeedsFix
The path to resolution is known, but the work has not been done.
Milestone
There exists a
GitHubIssue.ClosedBy
field inmaintner
:What did you expect to see?
Accurate values.
What did you see instead?
The field is never populated and always equals to
nil
for all GitHub issues.This can be misleading for anyone looking to use that information.
Cause
The
closed_by
JSON field is documented and shown in the sample response at https://developer.github.com/v3/issues/#get-a-single-issue.However,
maintner
uses the https://developer.github.com/v3/issues/#list-issues-for-a-repository endpoint for getting information about many issues at once:https://github.com/golang/build/blob/23803abc1638efbf100d69fe6d901b14a9ad55fd/maintner/github.go#L1605-L1613
But GitHub doesn't include all detailed fields when listing many issues rather than getting a single issue. The
closed_by
field is indeed missing:Response from Get Single Issue Endpoint
Response from List Issues Endpoint
Possible Fixes
I see two possible solutions:
Since this field isn't included in the existing endpoint queried by
maintner
, it would require making additional API calls per issue. That can be extremely expensive and simply not viable.I'd suggest removing it or documenting, at least as an intermediate step. But open to ideas. /cc @bradfitz
The text was updated successfully, but these errors were encountered: