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 (34dd998) to head (195d12f).
⚠️ Report is 3 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.46%   97.46%           
=======================================
  Files         192      193    +1     
  Lines       19258    19355   +97     
=======================================
+ Hits        18770    18865   +95     
- Misses        270      271    +1     
- Partials      218      219    +1

☔ View full report in Codecov by Harness.
📢 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

alexandear · 2026-05-16T16:33:07Z

+	IsArchived bool `url:"is_archived,omitempty"`
+
+	// Since filters tasks updated at or after this time.
+	Since *time.Time `url:"since,omitempty"`


All fields should be non-pointer types with url tags:

Suggested change

Since *time.Time `url:"since,omitempty"`

Since time.Time `url:"since,omitempty"`

@danyalahmed1995 - this comment has not yet been addressed.

@gmlewis This was tested both ways.

The linter failed because Since has url:"since,omitempty" and is an optional query parameter. I restored it to *time.Time, which keeps the absent-vs-zero-value behavior and passes the fork CI/linter.

So this is intentionally kept as:

Since *time.Time url:"since,omitempty"

@danyalahmed1995 you're right, thanks.

alexandear · 2026-05-16T16:54:19Z

+	HTMLURL      *string              `json:"html_url,omitempty"`
+	Name         *string              `json:"name,omitempty"`
+	Creator      *User                `json:"creator,omitempty"`
+	CreatorType  *string              `json:"creator_type,omitempty"`


missing user_collaborators field:

"user_collaborators": { "type": "array", "items": { "type": "object", "description": "A GitHub user", "properties": { "id": { "type": "integer", "format": "int64", "description": "The unique identifier of the user" } } }, "description": "User objects of collaborators on this task", "deprecated": true },

@danyalahmed1995 - user_collaborators is still missing from this struct. Stopping review here.

I am so sorry for this confusion 😔. I must have missed it because it was asked to be removed I restored it and checked the CI again on my fork to make sure it doesnt fail again.

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

alexandear · 2026-06-01T09:57:53Z

+	AgentTaskListOptions
+
+	// CreatorIDs filters tasks by creator user IDs.
+	CreatorIDs []int64 `url:"creator_id,omitempty"`


Suggested change

CreatorIDs []int64 `url:"creator_id,omitempty"`

CreatorID []int64 `url:"creator_id,omitempty"`

I'm curious why our linter didn't catch this one.

The linter catches this:

I just wanted to emphasize that this needs to be fixed.

Sincere apology for the inconvenience , I went through the reviews and this time properly double checked all the missing pieces and linter errors on my fork . Kindly when you guys have time confirm if everything is good . I will keep this and the other review thread open , until you guys verify it.

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

danyalahmed1995 · 2026-06-11T05:49:13Z

Guys is anything left 🤔

alexandear · 2026-06-11T11:18:26Z

Guys is anything left 🤔

Please read all our comments and apply fixes. Also, do not forget to fix lint issues and tests. Run the following commands:

$ ./script/lint.sh
$ ./script/test.sh

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

gmlewis · 2026-06-11T19:50:35Z

+	HTMLURL      *string              `json:"html_url,omitempty"`
+	Name         *string              `json:"name,omitempty"`
+	Creator      *User                `json:"creator,omitempty"`
+	CreatorType  *string              `json:"creator_type,omitempty"`


@danyalahmed1995 - user_collaborators is still missing from this struct. Stopping review here.

gmlewis · 2026-06-12T12:43:25Z

+	IsArchived bool `url:"is_archived,omitempty"`
+
+	// Since filters tasks updated at or after this time.
+	Since *time.Time `url:"since,omitempty"`


@danyalahmed1995 - this comment has not yet been addressed.

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 Outdated

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

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

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

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>

Update github/agent_tasks.go

139e26e

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

alexandear reviewed May 29, 2026

View reviewed changes

Comment thread tools/metadata/metadata.go Outdated

gmlewis requested changes May 29, 2026

View reviewed changes

Comment thread tools/metadata/metadata.go Outdated

fix: use default docs version for agent tasks links

24294fe

alexandear reviewed Jun 1, 2026

View reviewed changes

danyalahmed1995 and others added 10 commits June 1, 2026 15:48

Update agent_tasks.go

0c9c94e

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

Update agent_tasks.go

a39607d

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

Update agent_tasks.go

0ee670d

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

Update agent_tasks.go

848a6ab

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

Update agent_tasks.go

c8a51f9

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

Update agent_tasks.go

7053044

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

Update agent_tasks.go

77ee6f4

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

Update agent_tasks_test.go

5847795

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

Update agent_tasks_test.go

332e7f9

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

fix: address agent tasks schema review

2f707eb

alexandear suggested changes Jun 11, 2026

View reviewed changes

danyalahmed1995 and others added 3 commits June 11, 2026 19:01

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

67b9739

fix: address agent tasks review feedback

5aeb196

Update agent_tasks.go

d2b4f56

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

gmlewis requested changes Jun 11, 2026

View reviewed changes

Comment thread github/agent_tasks.go

danyalahmed1995 added 4 commits June 11, 2026 22:36

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

2860c60

Fix agent tasks option accessors

cdc4021

Trigger fork CI

05edbf1

Fix agent tasks since option

b36299e

gmlewis removed the waiting for reply label Jun 11, 2026

gmlewis requested changes Jun 11, 2026

View reviewed changes

Add agent task user collaborators field

195d12f

gmlewis requested changes Jun 12, 2026

View reviewed changes

	Since *time.Time `url:"since,omitempty"`
	Since time.Time `url:"since,omitempty"`

	CreatorIDs []int64 `url:"creator_id,omitempty"`
	CreatorID []int64 `url:"creator_id,omitempty"`

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!

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!

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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

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!

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!

codecov Bot commented May 14, 2026 •

edited

Loading

danyalahmed1995 commented May 15, 2026 •

edited

Loading