feat: Add agent tasks API support by danyalahmed1995 · Pull Request #4225 · google/go-github

danyalahmed1995 · 2026-05-14T21:30:35Z

Summary

Adds typed client support for GitHub's Agent Tasks REST API.

This implements the documented public-preview Agent Tasks endpoints:

GET /agents/repos/{owner}/{repo}/tasks
POST /agents/repos/{owner}/{repo}/tasks
GET /agents/repos/{owner}/{repo}/tasks/{task_id}
GET /agents/tasks
GET /agents/tasks/{task_id}

Closes #4213.

Changes

Added AgentTasksService and registered it on Client.
Added Agent Tasks request/response types for tasks, sessions, artifacts, list options, and create options.
Added methods for listing, creating, and retrieving agent tasks.
Added tests covering:
- endpoint paths
- HTTP methods
- request bodies
- response parsing
- query parameters
- pagination
- preview API headers
Added OpenAPI operation metadata for the new preview endpoints.
Regenerated accessors and iterators.

Notes

The Agent Tasks API is currently in public preview, so this PR keeps the implementation scoped to the fields and endpoints currently documented by GitHub.

Validation

Ran the repository validation flow from CONTRIBUTING.md:

script/fmt.sh
script/test.sh ./...
script/lint.sh
script/generate.sh
git diff --check

script/test.sh with the default race configuration could not run on this Windows machine because cgo/gcc was not available. I reran the full test script with the non-race fallback across all modules, and it passed.

codecov · 2026-05-14T21:57:48Z

Codecov Report

❌ Patch coverage is 97.93814% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.46%. Comparing base (5475166) to head (96ff69b).
⚠️ Report is 10 commits behind head on master.

Files with missing lines	Patch %	Lines
github/agent_tasks.go	96.42%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #4225   +/-   ##
=======================================
  Coverage   97.45%   97.46%           
=======================================
  Files         189      190    +1     
  Lines       19164    19261   +97     
=======================================
+ Hits        18677    18772   +95     
- Misses        270      271    +1     
- Partials      217      218    +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

gmlewis

Thank you, @danyalahmed1995!
Just a couple tweaks/questions, then we should be ready for a second LGTM+Approval from any other contributor to this repo before merging.

cc: @stevehipwell - @alexandear - @zyfy29 - @Not-Dhananjay-Mishra - @munlicode

Co-authored-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>

danyalahmed1995 · 2026-05-14T23:06:00Z

@gmlewis Thanks, sounds good. I’ll address the review comments and push an update shortly.

gmlewis

Thank you, @danyalahmed1995!
LGTM.

cc: @stevehipwell - @alexandear - @zyfy29 - @Not-Dhananjay-Mishra - @munlicode

stevehipwell

Thanks for the PR @danyalahmed1995, I've added a couple of comments.

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

danyalahmed1995 · 2026-05-15T13:28:17Z

@stevehipwell @alexandear updated, thanks for the reviews.

Changes in the latest update:

adjusted the Agent Tasks response structs so documented required fields are non-pointers, while nullable/optional fields remain pointers
folded the private list helper back into List and removed the Codecov-only List bad-options test so the production code stays simpler
added agentTasksAPIVersion and replaced the repeated WithVersion("2026-03-10") usage
updated the Agent Tasks doc comment URLs so the apiVersion value matches the request version
regenerated the affected accessors/tests

Validation:

script/generate.sh passed
gofmt passed on changed Go files
go test ./github passed
script/fmt.sh passed
script/test.sh ./... passed
script/lint.sh passed
git diff --check passed
confirmed openapi_operations.yaml and go.mod have no diff
confirmed changed files are LF-only with no CRLF churn

danyalahmed1995 · 2026-05-15T18:00:35Z

@alexandear @stevehipwell Thanks for pointing me to the right direction.

Root cause was generator-side: the Agent Tasks documentation URLs did not include an explicit apiVersion, so the metadata normalizer defaulted the generated comments to 2022-11-28.

I added a narrow metadata mapping for /rest/agent-tasks/agent-tasks so generated Agent Tasks doc links normalize to apiVersion=2026-03-10, then reran script/generate.sh. The generated comments now stay aligned with agentTasksAPIVersion.

Validation:

script/generate.sh passed and preserved the corrected Agent Tasks comments
go test ./github passed
go test ./metadata from tools passed
script/lint.sh passed
git diff --check passed
confirmed openapi_operations.yaml and go.mod have no diff
confirmed changed files are LF-only with no CRLF churn

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

danyalahmed1995 · 2026-05-17T00:42:49Z

@alexandear updated, thanks.

I added total_active_count and total_archived_count to AgentTaskList, added the deprecated user_collaborators field, and modeled owner / repository as minimal Agent Tasks ID-only structs instead of broader *User / *Repository.

I also added the public preview note to the Agent Tasks endpoint docs and kept agentTasksAPIVersion unchanged for now pending the constant naming/location preference.

I checked the schema for owner.id and repository.id; both are integer / int64, but the nested id fields are not marked as required, so they remain *int64 with omitempty.

Validation:

script/generate.sh passed
gofmt / script/fmt.sh passed
go test ./github passed
go test ./metadata from tools passed
script/lint.sh passed
git diff --check passed
confirmed openapi_operations.yaml and go.mod have no diff
confirmed changed files are LF-only with no CRLF churn

I leave the api20260310 / github.go constant discussion untouched until @stevehipwell answers.

# Conflicts: # github/github.go

gmlewis · 2026-05-26T19:11:43Z

@stevehipwell - @alexandear - could you please take another look when you get a chance?

alexandear · 2026-05-27T07:16:19Z

+	// Deprecated: UserCollaborators is deprecated by GitHub.
+	UserCollaborators []*User `json:"user_collaborators,omitempty"`


I propose not adding the deprecated field. Or should we?

This field is still present in the response schema, exposing it would keep the client complete and let callers read it if GitHub still returns it. I marked it deprecated so users are discouraged from relying on it.

GitHub’s official OpenAPI description still includes user_collaborators in the Agent Tasks response schema, marked deprecated. Since go-github models API response fields, exposing it keeps the SDK schema-complete and allows callers to read the field if GitHub still returns it.

alexandear · 2026-05-27T07:30:20Z

+const (
+	agentTaskID        = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
+	agentTaskSessionID = "s1a2b3c4-d5e6-7890-abcd-ef1234567890"
+)


Please do not declare global constants. It's better to have a separate constant for each test.

Fix here and below.

alexandear · 2026-05-27T07:35:52Z

+	createdAt := &Timestamp{time.Date(2025, time.January, 1, 0, 0, 0, 0, time.UTC)}
+	updatedAt := &Timestamp{time.Date(2025, time.January, 1, 1, 0, 0, 0, time.UTC)}


Could we use a different date, not 2025-01-01?

What do you think could be a good golden number for the date here 🤔 ?

alexandear · 2026-05-27T07:39:25Z

+	testJSONMarshal(t, u, want, cmpJSONRawMessageComparator())
+}
+
+func TestAgentTaskOwner_Marshal(t *testing.T) {


All *_Marshal tests are not needed and can be removed.

They are required only if we have custom marshal/unmarshal functions.

See #4253 (comment)

alexandear · 2026-05-27T07:42:33Z

 // Keep this in sync with defaultAPIVersion in github/github.go.
 const metadataDocsAPIVersion = "2022-11-28"

+var customDocsAPIVersions = map[string]string{


Maybe previewDocsAPIVersions would be a better name? And the var requires the comment.

Yeah that was the plan initially but you asked to change it, you want me to revert it back ?

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

github: add agent tasks API support

8d3c4df

This was referenced May 14, 2026

Add support for new agent tasks REST API #4213

Open

Add support for getting a GitHub App enterprise installation #4212

Closed

gmlewis changed the title ~~github: add agent tasks API support~~ feat: Add agent tasks API support May 14, 2026

gmlewis reviewed May 14, 2026

View reviewed changes

Comment thread openapi_operations.yaml Outdated

gmlewis mentioned this pull request May 14, 2026

chore: Update openapi_operations.yaml #4228

Merged

gmlewis added the NeedsReview PR is awaiting a review before merging. label May 14, 2026

danyalahmed1995 added 2 commits May 15, 2026 03:10

Merge remote-tracking branch 'upstream/master' into add-agent-tasks-api

efa12d7

test: cover agent tasks list options error

4263d58

gmlewis requested changes May 14, 2026

View reviewed changes

Comment thread github/agent_tasks.go

Comment thread github/agent_tasks.go Outdated

Update github/agent_tasks.go

43387ee

Co-authored-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>

danyalahmed1995 added 2 commits May 15, 2026 05:10

fix: address agent tasks review comments

3c4d321

fix: remove openapi operations diff

93e009c

gmlewis reviewed May 15, 2026

View reviewed changes

Comment thread github/agent_tasks.go Outdated

fix: restore agent tasks creator id type

738801b

gmlewis approved these changes May 15, 2026

View reviewed changes

stevehipwell suggested changes May 15, 2026

View reviewed changes

Comment thread github/agent_tasks.go

Comment thread github/agent_tasks.go Outdated

Comment thread github/agent_tasks.go Outdated

alexandear suggested changes May 15, 2026

View reviewed changes

Comment thread github/agent_tasks.go Outdated

Comment thread github/agent_tasks.go Outdated

Comment thread github/agent_tasks.go Outdated

Comment thread github/agent_tasks.go Outdated

Comment thread github/agent_tasks.go Outdated

danyalahmed1995 and others added 2 commits May 15, 2026 18:05

Update github/agent_tasks.go

ceabbf4

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

fix: address latest agent tasks review comments

f8042ad

stevehipwell reviewed May 15, 2026

View reviewed changes

Comment thread github/agent_tasks.go Outdated

alexandear mentioned this pull request May 15, 2026

Before contributing AI slop PRs to this repo... #3939

Open

alexandear reviewed May 15, 2026

View reviewed changes

Comment thread github/agent_tasks.go Outdated

fix: preserve agent tasks docs api version

a2f45a2

alexandear suggested changes May 16, 2026

View reviewed changes

Update github/agent_tasks.go

5160bbf

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

danyalahmed1995 and others added 5 commits May 17, 2026 04:41

Update github/agent_tasks.go

ab0cc87

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

Update github/agent_tasks.go

d10a780

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

Update github/agent_tasks.go

a982cae

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

Update github/agent_tasks.go

41b1ac1

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

fix: address agent tasks schema review

dc0817a

alexandear mentioned this pull request May 18, 2026

refactor: Add constants for API versions #4236

Merged

fix: use shared agent tasks api version constant

8e1ed64

alexandear reviewed May 19, 2026

View reviewed changes

Comment thread github/github.go

alexandear reviewed May 19, 2026

View reviewed changes

Comment thread tools/metadata/metadata.go Outdated

Merge remote-tracking branch 'upstream/master' into add-agent-tasks-api

96ff69b

# Conflicts: # github/github.go

gmlewis added the waiting for reply label May 27, 2026

alexandear reviewed May 27, 2026

View reviewed changes

danyalahmed1995 and others added 6 commits May 27, 2026 17:17

Update github/agent_tasks.go

d40f10b

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

Update github/agent_tasks.go

526dbeb

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

Update agent_tasks.go

ca7b94c

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

Update agent_tasks.go

f60454c

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

Update agent_tasks.go

38fdd45

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

Update agent_tasks_test.go

127e602

Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>

		// Deprecated: UserCollaborators is deprecated by GitHub.
		UserCollaborators []*User `json:"user_collaborators,omitempty"`

		createdAt := &Timestamp{time.Date(2025, time.January, 1, 0, 0, 0, 0, time.UTC)}
		updatedAt := &Timestamp{time.Date(2025, time.January, 1, 1, 0, 0, 0, time.UTC)}

Conversation

danyalahmed1995 commented May 14, 2026

Summary

Changes

Notes

Validation

Uh oh!

Uh oh!

codecov Bot commented May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

danyalahmed1995 commented May 14, 2026

Uh oh!

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

danyalahmed1995 commented May 15, 2026

Uh oh!

Uh oh!

Uh oh!

danyalahmed1995 commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

danyalahmed1995 commented May 17, 2026

Uh oh!

Uh oh!

Uh oh!

gmlewis commented May 26, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented May 14, 2026 •

edited

Loading

danyalahmed1995 commented May 15, 2026 •

edited

Loading