refactor!: Pass release params by value and rename `EditRelease` to `UpdateRelease` by JamBalaya56562 · Pull Request #4329 · google/go-github

JamBalaya56562 · 2026-06-24T17:56:16Z

BREAKING CHANGE: CreateRelease & UpdateRelease now take RepositoryRelease by value; EditRelease is renamed to UpdateRelease.

Towards #3644.

Passes the request body of RepositoriesService.CreateRelease and RepositoriesService.UpdateRelease by value instead of by pointer, and renames EditRelease to UpdateRelease for naming consistency.

This continues the value-parameter conversion from the merged #3654, #3794 and #4320, and follows the Edit -> Update rename done for GistsService in #4320.

Changes

CreateRelease(ctx, owner, repo string, release *RepositoryRelease) -> release RepositoryRelease
EditRelease(ctx, owner, repo string, id int64, release *RepositoryRelease) -> UpdateRelease(..., release RepositoryRelease)
Removed the runtime release == nil checks, which the value signature now makes unnecessary.
No deprecated wrappers are added (clean break), consistent with the review consensus on refactor!: Refactor GistsService to use value parameters #3680/refactor!: Pass GistsService required params by value #4320.

Breaking changes

CreateRelease / UpdateRelease now take RepositoryRelease by value.
EditRelease is renamed to UpdateRelease.

The remaining body-pointer methods in repos_releases.go (EditReleaseAsset, GenerateReleaseNotes) are intentionally left for a follow-up, since they also involve allow-list and type-name changes.

Generated files are unchanged (no struct fields changed).

codecov · 2026-06-24T18:07:57Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.48%. Comparing base (642da7d) to head (419cb63).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4329      +/-   ##
==========================================
- Coverage   97.48%   97.48%   -0.01%     
==========================================
  Files         193      193              
  Lines       19400    19377      -23     
==========================================
- Hits        18912    18889      -23     
  Misses        270      270              
  Partials      218      218

☔ 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, @JamBalaya56562!
LGTM.
Awaiting second LGTM+Approval from any other contributor to this repo before merging.

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

alexandear

As we are making breaking changes, I propose creating separate structs for creating and updating a repository release. These structs have slightly different fields.

alexandear · 2026-06-24T21:13:55Z

-		return nil, nil, errors.New("release must be provided")
-	}
-
+func (s *RepositoriesService) CreateRelease(ctx context.Context, owner, repo string, release RepositoryRelease) (*RepositoryRelease, *Response, error) {


Suggested change

func (s *RepositoriesService) CreateRelease(ctx context.Context, owner, repo string, release RepositoryRelease) (*RepositoryRelease, *Response, error) {

func (s *RepositoriesService) CreateRelease(ctx context.Context, owner, repo string, body CreateReleaseRequest) (*RepositoryRelease, *Response, error) {

Done in 69f00c3 — added a dedicated CreateReleaseRequest and CreateRelease now takes it by value. Thanks!

alexandear · 2026-06-24T21:14:16Z

-		return nil, nil, errors.New("release must be provided")
-	}
-
+func (s *RepositoriesService) UpdateRelease(ctx context.Context, owner, repo string, id int64, release RepositoryRelease) (*RepositoryRelease, *Response, error) {


Suggested change

func (s *RepositoriesService) UpdateRelease(ctx context.Context, owner, repo string, id int64, release RepositoryRelease) (*RepositoryRelease, *Response, error) {

func (s *RepositoriesService) UpdateRelease(ctx context.Context, owner, repo string, id int64, body UpdateReleaseRequest) (*RepositoryRelease, *Response, error) {

Done — UpdateRelease now takes UpdateReleaseRequest by value. It omits GenerateReleaseNotes, since the update endpoint does not accept it.

alexandear · 2026-06-24T21:17:19Z

We can remove this after introducing CreateReleaseRequest and UpdateReleaseRequest

Removed — the internal repositoryReleaseRequest is gone now that CreateReleaseRequest/UpdateReleaseRequest carry the request fields directly and are serialized as-is.

alexandear · 2026-06-25T05:36:39Z

Suggested change

testJSONBody(t, r, input)

Done — dropped the duplicated want and pass input directly (the handler closure captures it).

alexandear · 2026-06-25T05:37:05Z

Suggested change

testJSONBody(t, r, input)

Done — same here, using input directly.

alexandear · 2026-06-25T05:38:57Z

 	DiscussionCategoryName *string `json:"discussion_category_name,omitempty"`

-	// The following fields are not used in EditRelease:
+	// The following fields are not used in UpdateRelease:


This comment is no longer needed:

Suggested change

// The following fields are not used in UpdateRelease:

Done — removed the obsolete comment.

alexandear · 2026-06-25T05:39:06Z

 	GenerateReleaseNotes *bool `json:"generate_release_notes,omitempty"`

-	// The following fields are not used in CreateRelease or EditRelease:
+	// The following fields are not used in CreateRelease or UpdateRelease:


This comment is no longer needed:

Suggested change

// The following fields are not used in CreateRelease or UpdateRelease:

Done — removed.

alexandear · 2026-06-25T05:39:50Z

-	Prerelease             *bool   `json:"prerelease,omitempty"`
+// CreateReleaseRequest represents a request to create a release in a repository.
+type CreateReleaseRequest struct {
+	TagName         *string `json:"tag_name,omitempty"`


Suggested change

TagName *string `json:"tag_name,omitempty"`

TagName string `json:"tag_name"`

Done in b2563e2 — TagName is now a required string (json:"tag_name", no omitempty), since the create endpoint requires it. UpdateReleaseRequest.TagName stays optional.

alexandear · 2026-06-25T05:43:05Z

 	client, mux, _ := setup(t)

-	input := &RepositoryRelease{
+	input := CreateReleaseRequest{


Please fill required TagName.

Done — set TagName: "v1.0" in the test input now that it is required.

…Release Introduce dedicated CreateReleaseRequest and UpdateReleaseRequest types for the bodies of RepositoriesService.CreateRelease and RepositoriesService.UpdateRelease, replacing the *RepositoryRelease parameter that also carried response-only fields. The new types are passed by value and serialized directly, dropping the internal repositoryReleaseRequest remap. EditRelease is renamed to UpdateRelease for naming consistency. This follows the value-parameter pattern established by the merged google#3654, google#3794 and google#4320, the Edit -> Update rename from google#4320, and the dedicated *Request body convention already used across the package (e.g. CreateHostedRunnerRequest). The runtime nil checks are removed since a value parameter makes them unnecessary. No deprecated wrappers are added (clean break). Updates google#3644.

alexandear · 2026-06-25T08:38:17Z

@@ -29,10 +29,8 @@
 	MakeLatest             *string `json:"make_latest,omitempty"`
 	DiscussionCategoryName *string `json:"discussion_category_name,omitempty"`



Suggested change

alexandear · 2026-06-25T08:38:24Z


-	// The following fields are not used in EditRelease:
 	GenerateReleaseNotes *bool `json:"generate_release_notes,omitempty"`



Suggested change

alexandear · 2026-06-25T08:39:30Z

 )

 // RepositoryRelease represents a GitHub release in a repository.
 type RepositoryRelease struct {


The struct should match the schema:

{ "title": "Release", "description": "A release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "assets_url": { "type": "string", "format": "uri" }, "upload_url": { "type": "string" }, "tarball_url": { "type": [ "string", "null" ], "format": "uri" }, "zipball_url": { "type": [ "string", "null" ], "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "tag_name": { "description": "The name of the tag.", "type": "string" }, "target_commitish": { "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, "name": { "type": [ "string", "null" ] }, "body": { "type": [ "string", "null" ] }, "draft": { "description": "true to create a draft (unpublished) release, false to create a published one.", "type": "boolean" }, "prerelease": { "description": "Whether to identify the release as a prerelease or a full release.", "type": "boolean" }, "immutable": { "description": "Whether or not the release is immutable.", "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "published_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string" }, "user_view_type": { "type": "string" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "browser_download_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "description": "The file name of the asset.", "type": "string" }, "label": { "type": [ "string", "null" ] }, "state": { "description": "State of the release asset.", "type": "string", "enum": [ "uploaded", "open" ] }, "content_type": { "type": "string" }, "size": { "type": "integer" }, "digest": { "type": [ "string", "null" ] }, "download_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string" }, "user_view_type": { "type": "string" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } ] } }, "required": [ "id", "name", "content_type", "size", "digest", "state", "url", "node_id", "download_count", "label", "uploader", "browser_download_url", "created_at", "updated_at" ] } }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "mentions_count": { "type": "integer" }, "discussion_url": { "description": "The URL of the release discussion.", "type": "string", "format": "uri" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assets_url", "upload_url", "tarball_url", "zipball_url", "created_at", "published_at", "draft", "id", "node_id", "author", "html_url", "name", "prerelease", "tag_name", "target_commitish", "assets", "url" ] }

JamBalaya56562 added a commit to JamBalaya56562/go-github that referenced this pull request Jun 24, 2026

docs: Add google#4329 (release value-param refactor for google#3644)

6fb6ff1

gmlewis added NeedsReview PR is awaiting a review before merging. Breaking API Change PR will require a bump to the major version num in next release. Look here to see the change(s). labels Jun 24, 2026

gmlewis changed the title ~~refactor!: Pass release params by value and rename EditRelease to UpdateRelease~~ refactor!: Pass release params by value and rename EditRelease to UpdateRelease Jun 24, 2026

gmlewis approved these changes Jun 24, 2026

View reviewed changes

alexandear suggested changes Jun 24, 2026

View reviewed changes

alexandear reviewed Jun 24, 2026

View reviewed changes

JamBalaya56562 force-pushed the refactor/3644-release-value-params branch 2 times, most recently from 69f00c3 to 419cb63 Compare June 25, 2026 02:06

JamBalaya56562 requested a review from alexandear June 25, 2026 02:07

alexandear reviewed Jun 25, 2026

View reviewed changes

JamBalaya56562 force-pushed the refactor/3644-release-value-params branch from 419cb63 to b2563e2 Compare June 25, 2026 06:17

JamBalaya56562 requested a review from alexandear June 25, 2026 06:22

alexandear suggested changes Jun 25, 2026

View reviewed changes

	func (s RepositoriesService) CreateRelease(ctx context.Context, owner, repo string, release RepositoryRelease) (RepositoryRelease, *Response, error) {
	func (s RepositoriesService) CreateRelease(ctx context.Context, owner, repo string, body CreateReleaseRequest) (RepositoryRelease, *Response, error) {

	func (s RepositoriesService) UpdateRelease(ctx context.Context, owner, repo string, id int64, release RepositoryRelease) (RepositoryRelease, *Response, error) {
	func (s RepositoriesService) UpdateRelease(ctx context.Context, owner, repo string, id int64, body UpdateReleaseRequest) (RepositoryRelease, *Response, error) {

	TagName *string `json:"tag_name,omitempty"`
	TagName string `json:"tag_name"`

		@@ -29,10 +29,8 @@
		MakeLatest *string `json:"make_latest,omitempty"`
		DiscussionCategoryName *string `json:"discussion_category_name,omitempty"`


		// The following fields are not used in EditRelease:
		GenerateReleaseNotes *bool `json:"generate_release_notes,omitempty"`

Uh oh!

Conversation

JamBalaya56562 commented Jun 24, 2026 • edited by gmlewis Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Breaking changes

Uh oh!

codecov Bot commented Jun 24, 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!

alexandear left a comment

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!

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!

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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

JamBalaya56562 commented Jun 24, 2026 •

edited by gmlewis

Loading

codecov Bot commented Jun 24, 2026 •

edited

Loading