Skip to content

feat!: Support workflow dispatch run details in response #4028

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gmlewis merged 4 commits into from
Feb 24, 2026
Merged

feat!: Support workflow dispatch run details in response #4028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2f504f9
feat: support workflow dispatch run details in response
LinaKACI-pro Feb 21, 2026
6817b9e
fix: return nil dispatch response when API returns 204 No Content
LinaKACI-pro Feb 23, 2026
f71d381
refactor: struct naming WorkflowDispatchRunDetails
LinaKACI-pro Feb 24, 2026
40a1676
refactor: struct naming WorkflowDispatchRunDetails on unit tests
LinaKACI-pro Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 23 additions & 6 deletions github/actions_workflows.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,20 @@ type CreateWorkflowDispatchEventRequest struct {
// Ref is required when creating a workflow dispatch event.
Ref string `json:"ref"`
// Inputs represents input keys and values configured in the workflow file.
// The maximum number of properties is 10.
// The maximum number of properties is 25.
// Default: Any default properties configured in the workflow file will be used when `inputs` are omitted.
Inputs map[string]any `json:"inputs,omitempty"`
// ReturnRunDetails specifies whether the response should include
// the workflow run ID and URLs.
ReturnRunDetails *bool `json:"return_run_details,omitempty"`
Comment on lines +57 to +59
Copy link
Copy Markdown
Contributor

@rmacklin rmacklin Mar 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PSA: I just learned that in the new 2026-03-10 version of the GitHub API, the return_run_details parameter has been removed and the endpoint will always returns 200 with the workflow run details in the response body.

Source: https://docs.github.com/en/rest/about-the-rest-api/breaking-changes?apiVersion=2026-03-10#version-2026-03-10:~:text=Removes%20the%20return_run_details%20parameter.%20The%20endpoint%20now%20always%20returns%20200%20with%20the%20workflow%20run%20details%20in%20the%20response%20body.

I also see there's already a general issue about the new API version: #4077 - so mostly just commenting here to add visibility that this is one of the affected methods.

}

// WorkflowDispatchRunDetails represents the response from creating
// a workflow dispatch event when ReturnRunDetails is set to true.
type WorkflowDispatchRunDetails struct {
WorkflowRunID *int64 `json:"workflow_run_id,omitempty"`
RunURL *string `json:"run_url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
}

// WorkflowsPermissions represents the permissions for workflows in a repository.
Expand Down Expand Up @@ -191,7 +202,7 @@ func (s *ActionsService) getWorkflowUsage(ctx context.Context, url string) (*Wor
// GitHub API docs: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event
//
//meta:operation POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches
func (s *ActionsService) CreateWorkflowDispatchEventByID(ctx context.Context, owner, repo string, workflowID int64, event CreateWorkflowDispatchEventRequest) (*Response, error) {
func (s *ActionsService) CreateWorkflowDispatchEventByID(ctx context.Context, owner, repo string, workflowID int64, event CreateWorkflowDispatchEventRequest) (*WorkflowDispatchRunDetails, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/actions/workflows/%v/dispatches", owner, repo, workflowID)

return s.createWorkflowDispatchEvent(ctx, u, &event)
Expand All @@ -202,19 +213,25 @@ func (s *ActionsService) CreateWorkflowDispatchEventByID(ctx context.Context, ow
// GitHub API docs: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event
//
//meta:operation POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches
func (s *ActionsService) CreateWorkflowDispatchEventByFileName(ctx context.Context, owner, repo, workflowFileName string, event CreateWorkflowDispatchEventRequest) (*Response, error) {
func (s *ActionsService) CreateWorkflowDispatchEventByFileName(ctx context.Context, owner, repo, workflowFileName string, event CreateWorkflowDispatchEventRequest) (*WorkflowDispatchRunDetails, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/actions/workflows/%v/dispatches", owner, repo, workflowFileName)

return s.createWorkflowDispatchEvent(ctx, u, &event)
}

func (s *ActionsService) createWorkflowDispatchEvent(ctx context.Context, url string, event *CreateWorkflowDispatchEventRequest) (*Response, error) {
func (s *ActionsService) createWorkflowDispatchEvent(ctx context.Context, url string, event *CreateWorkflowDispatchEventRequest) (*WorkflowDispatchRunDetails, *Response, error) {
req, err := s.client.NewRequest("POST", url, event)
if err != nil {
return nil, err
return nil, nil, err
}

return s.client.Do(ctx, req, nil)
var dispatchRunDetails *WorkflowDispatchRunDetails
resp, err := s.client.Do(ctx, req, &dispatchRunDetails)
if err != nil {
return nil, resp, err
}

return dispatchRunDetails, resp, nil
}

// EnableWorkflowByID enables a workflow and sets the state of the workflow to "active".
Expand Down
124 changes: 112 additions & 12 deletions github/actions_workflows_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,42 +235,59 @@ func TestActionsService_CreateWorkflowDispatchEventByID(t *testing.T) {
client, mux, _ := setup(t)

event := CreateWorkflowDispatchEventRequest{
Ref: "d4cfb6e7",
Ref: "d4cfb6e7",
ReturnRunDetails: Ptr(true),
Inputs: map[string]any{
"key": "value",
},
}
mux.HandleFunc("/repos/o/r/actions/workflows/72844/dispatches", func(_ http.ResponseWriter, r *http.Request) {
mux.HandleFunc("/repos/o/r/actions/workflows/72844/dispatches", func(w http.ResponseWriter, r *http.Request) {
var v CreateWorkflowDispatchEventRequest
assertNilError(t, json.NewDecoder(r.Body).Decode(&v))

testMethod(t, r, "POST")
if !cmp.Equal(v, event) {
t.Errorf("Request body = %+v, want %+v", v, event)
}

w.WriteHeader(http.StatusOK)
fmt.Fprint(w, `{"workflow_run_id":1,"run_url":"https://api.github.com/repos/o/r/actions/runs/1","html_url":"https://github.com/o/r/actions/runs/1"}`)
})

ctx := t.Context()
_, err := client.Actions.CreateWorkflowDispatchEventByID(ctx, "o", "r", 72844, event)
dispatchResponse, _, err := client.Actions.CreateWorkflowDispatchEventByID(ctx, "o", "r", 72844, event)
if err != nil {
t.Errorf("Actions.CreateWorkflowDispatchEventByID returned error: %v", err)
}

want := &WorkflowDispatchRunDetails{
WorkflowRunID: Ptr(int64(1)),
RunURL: Ptr("https://api.github.com/repos/o/r/actions/runs/1"),
HTMLURL: Ptr("https://github.com/o/r/actions/runs/1"),
}
if !cmp.Equal(dispatchResponse, want) {
t.Errorf("Actions.CreateWorkflowDispatchEventByID = %+v, want %+v", dispatchResponse, want)
}

// Test s.client.NewRequest failure
client.BaseURL.Path = ""
_, err = client.Actions.CreateWorkflowDispatchEventByID(ctx, "o", "r", 72844, event)
_, _, err = client.Actions.CreateWorkflowDispatchEventByID(ctx, "o", "r", 72844, event)
if err == nil {
t.Error("client.BaseURL.Path='' CreateWorkflowDispatchEventByID err = nil, want error")
}

const methodName = "CreateWorkflowDispatchEventByID"
testBadOptions(t, methodName, func() (err error) {
_, err = client.Actions.CreateWorkflowDispatchEventByID(ctx, "o", "r", 72844, event)
_, _, err = client.Actions.CreateWorkflowDispatchEventByID(ctx, "o", "r", 72844, event)
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
return client.Actions.CreateWorkflowDispatchEventByID(ctx, "o", "r", 72844, event)
got, resp, err := client.Actions.CreateWorkflowDispatchEventByID(ctx, "o", "r", 72844, event)
if got != nil {
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
}
return resp, err
})
}

Expand All @@ -279,43 +296,126 @@ func TestActionsService_CreateWorkflowDispatchEventByFileName(t *testing.T) {
client, mux, _ := setup(t)

event := CreateWorkflowDispatchEventRequest{
Ref: "d4cfb6e7",
Ref: "d4cfb6e7",
ReturnRunDetails: Ptr(true),
Inputs: map[string]any{
"key": "value",
},
}
mux.HandleFunc("/repos/o/r/actions/workflows/main.yml/dispatches", func(_ http.ResponseWriter, r *http.Request) {
mux.HandleFunc("/repos/o/r/actions/workflows/main.yml/dispatches", func(w http.ResponseWriter, r *http.Request) {
var v CreateWorkflowDispatchEventRequest
assertNilError(t, json.NewDecoder(r.Body).Decode(&v))

testMethod(t, r, "POST")
if !cmp.Equal(v, event) {
t.Errorf("Request body = %+v, want %+v", v, event)
}

w.WriteHeader(http.StatusOK)
fmt.Fprint(w, `{"workflow_run_id":1,"run_url":"https://api.github.com/repos/o/r/actions/runs/1","html_url":"https://github.com/o/r/actions/runs/1"}`)
})

ctx := t.Context()
_, err := client.Actions.CreateWorkflowDispatchEventByFileName(ctx, "o", "r", "main.yml", event)
dispatchResponse, _, err := client.Actions.CreateWorkflowDispatchEventByFileName(ctx, "o", "r", "main.yml", event)
if err != nil {
t.Errorf("Actions.CreateWorkflowDispatchEventByFileName returned error: %v", err)
}

want := &WorkflowDispatchRunDetails{
WorkflowRunID: Ptr(int64(1)),
RunURL: Ptr("https://api.github.com/repos/o/r/actions/runs/1"),
HTMLURL: Ptr("https://github.com/o/r/actions/runs/1"),
}
if !cmp.Equal(dispatchResponse, want) {
t.Errorf("Actions.CreateWorkflowDispatchEventByFileName = %+v, want %+v", dispatchResponse, want)
}

// Test s.client.NewRequest failure
client.BaseURL.Path = ""
_, err = client.Actions.CreateWorkflowDispatchEventByFileName(ctx, "o", "r", "main.yml", event)
_, _, err = client.Actions.CreateWorkflowDispatchEventByFileName(ctx, "o", "r", "main.yml", event)
if err == nil {
t.Error("client.BaseURL.Path='' CreateWorkflowDispatchEventByFileName err = nil, want error")
}

const methodName = "CreateWorkflowDispatchEventByFileName"
testBadOptions(t, methodName, func() (err error) {
_, err = client.Actions.CreateWorkflowDispatchEventByFileName(ctx, "o", "r", "main.yml", event)
_, _, err = client.Actions.CreateWorkflowDispatchEventByFileName(ctx, "o", "r", "main.yml", event)
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
return client.Actions.CreateWorkflowDispatchEventByFileName(ctx, "o", "r", "main.yml", event)
got, resp, err := client.Actions.CreateWorkflowDispatchEventByFileName(ctx, "o", "r", "main.yml", event)
if got != nil {
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
}
return resp, err
})
}

func TestActionsService_CreateWorkflowDispatchEventByID_noRunDetails(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

event := CreateWorkflowDispatchEventRequest{
Ref: "d4cfb6e7",
Inputs: map[string]any{
"key": "value",
},
}
mux.HandleFunc("/repos/o/r/actions/workflows/72844/dispatches", func(w http.ResponseWriter, r *http.Request) {
var v CreateWorkflowDispatchEventRequest
assertNilError(t, json.NewDecoder(r.Body).Decode(&v))

testMethod(t, r, "POST")
if !cmp.Equal(v, event) {
t.Errorf("Request body = %+v, want %+v", v, event)
}

w.WriteHeader(http.StatusNoContent)
})

ctx := t.Context()
dispatchResponse, _, err := client.Actions.CreateWorkflowDispatchEventByID(ctx, "o", "r", 72844, event)
if err != nil {
t.Errorf("Actions.CreateWorkflowDispatchEventByID returned error: %v", err)
}

if dispatchResponse != nil {
t.Errorf("Actions.CreateWorkflowDispatchEventByID = %+v, want nil", dispatchResponse)
}
}

func TestActionsService_CreateWorkflowDispatchEventByFileName_noRunDetails(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

event := CreateWorkflowDispatchEventRequest{
Ref: "d4cfb6e7",
Inputs: map[string]any{
"key": "value",
},
}
mux.HandleFunc("/repos/o/r/actions/workflows/main.yml/dispatches", func(w http.ResponseWriter, r *http.Request) {
var v CreateWorkflowDispatchEventRequest
assertNilError(t, json.NewDecoder(r.Body).Decode(&v))

testMethod(t, r, "POST")
if !cmp.Equal(v, event) {
t.Errorf("Request body = %+v, want %+v", v, event)
}

w.WriteHeader(http.StatusNoContent)
})

ctx := t.Context()
dispatchResponse, _, err := client.Actions.CreateWorkflowDispatchEventByFileName(ctx, "o", "r", "main.yml", event)
if err != nil {
t.Errorf("Actions.CreateWorkflowDispatchEventByFileName returned error: %v", err)
}

if dispatchResponse != nil {
t.Errorf("Actions.CreateWorkflowDispatchEventByFileName = %+v, want nil", dispatchResponse)
}
}

func TestActionsService_EnableWorkflowByID(t *testing.T) {
Expand Down
32 changes: 32 additions & 0 deletions github/github-accessors.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

44 changes: 44 additions & 0 deletions github/github-accessors_test.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading