refactor!: Pass release-notes and asset params by value and rename EditReleaseAsset to UpdateReleaseAsset

.golangci.yml

@@ -229,7 +229,6 @@ linters:
             - EnterpriseSecurityAnalysisSettings
             - ExternalGroup
             - GenerateJITConfigRequest
-            - GenerateNotesOptions
             - Hook
             - HookConfig
             - ImpersonateUserOptions
@@ -258,7 +257,6 @@ linters:
             - PullRequestReviewDismissalRequest
             - PullRequestReviewRequest
             - PullRequestReviewsEnforcementUpdate
-            - ReleaseAsset
             - RepoMergeUpstreamRequest
             - Repository
             - RepositoryAddCollaboratorOptions
@@ -300,7 +298,6 @@ linters:
             - CreateOrUpdateCustomRepoRoleOptions
             - CreateOrUpdateIssueTypesOptions
             - CreateOrgInvitationOptions
-            - GenerateNotesOptions
             - ImpersonateUserOptions
             - InstallationTokenListRepoOptions
             - InstallationTokenOptions

github/repos_releases.go

@@ -56,8 +56,8 @@ type RepositoryReleaseNotes struct {
 	Body string `json:"body"`
 }
 
-// GenerateNotesOptions represents the options to generate release notes.
-type GenerateNotesOptions struct {
+// GenerateNotesRequest represents the request to generate release notes.
+type GenerateNotesRequest struct {
 	TagName               string  `json:"tag_name"`
 	PreviousTagName       *string `json:"previous_tag_name,omitempty"`
 	TargetCommitish       *string `json:"target_commitish,omitempty"`
@@ -82,6 +82,13 @@ type ReleaseAsset struct {
 	Digest             *string    `json:"digest,omitempty"`
 }
 
+// UpdateReleaseAssetRequest represents the request to update a release asset.
+type UpdateReleaseAssetRequest struct {
+	Name  *string `json:"name,omitempty"`
+	Label *string `json:"label,omitempty"`
+	State *string `json:"state,omitempty"`
+}
+
 func (r ReleaseAsset) String() string {
 	return Stringify(r)
 }
@@ -146,7 +153,7 @@ func (s *RepositoriesService) GetReleaseByTag(ctx context.Context, owner, repo,
 // GitHub API docs: https://docs.github.com/rest/releases/releases?apiVersion=2022-11-28#generate-release-notes-content-for-a-release
 //
 //meta:operation POST /repos/{owner}/{repo}/releases/generate-notes
-func (s *RepositoriesService) GenerateReleaseNotes(ctx context.Context, owner, repo string, body *GenerateNotesOptions) (*RepositoryReleaseNotes, *Response, error) {
+func (s *RepositoriesService) GenerateReleaseNotes(ctx context.Context, owner, repo string, body GenerateNotesRequest) (*RepositoryReleaseNotes, *Response, error) {
 	u := fmt.Sprintf("repos/%v/%v/releases/generate-notes", owner, repo)
 	req, err := s.client.NewRequest(ctx, "POST", u, body)
 	if err != nil {
@@ -375,12 +382,12 @@ func (s *RepositoriesService) downloadReleaseAssetFromURL(ctx context.Context, f
 	return resp.Body, nil
 }
 
-// EditReleaseAsset edits a repository release asset.
+// UpdateReleaseAsset updates a repository release asset.
 //
 // GitHub API docs: https://docs.github.com/rest/releases/assets?apiVersion=2022-11-28#update-a-release-asset
 //
 //meta:operation PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}
-func (s *RepositoriesService) EditReleaseAsset(ctx context.Context, owner, repo string, id int64, body *ReleaseAsset) (*ReleaseAsset, *Response, error) {
+func (s *RepositoriesService) UpdateReleaseAsset(ctx context.Context, owner, repo string, id int64, body UpdateReleaseAssetRequest) (*ReleaseAsset, *Response, error) {
 	u := fmt.Sprintf("repos/%v/%v/releases/assets/%v", owner, repo, id)
 
 	req, err := s.client.NewRequest(ctx, "PATCH", u, body)

github/repos_releases_test.go

@@ -56,18 +56,18 @@ func TestRepositoriesService_GenerateReleaseNotes(t *testing.T) {
 	t.Parallel()
 	client, mux, _ := setup(t)
 
-	opt := &GenerateNotesOptions{
+	body := GenerateNotesRequest{
 		TagName: "v1.0.0",
 	}
 
 	mux.HandleFunc("/repos/o/r/releases/generate-notes", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "POST")
-		testJSONBody(t, r, opt)
+		testJSONBody(t, r, body)
 		fmt.Fprint(w, `{"name":"v1.0.0","body":"**Full Changelog**: https://github.com/o/r/compare/v0.9.0...v1.0.0"}`)
 	})
 
 	ctx := t.Context()
-	releases, _, err := client.Repositories.GenerateReleaseNotes(ctx, "o", "r", opt)
+	releases, _, err := client.Repositories.GenerateReleaseNotes(ctx, "o", "r", body)
 	if err != nil {
 		t.Errorf("Repositories.GenerateReleaseNotes returned error: %v", err)
 	}
@@ -81,12 +81,12 @@ func TestRepositoriesService_GenerateReleaseNotes(t *testing.T) {
 
 	const methodName = "GenerateReleaseNotes"
 	testBadOptions(t, methodName, func() (err error) {
-		_, _, err = client.Repositories.GenerateReleaseNotes(ctx, "\n", "\n", opt)
+		_, _, err = client.Repositories.GenerateReleaseNotes(ctx, "\n", "\n", body)
 		return err
 	})
 
 	testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
-		got, resp, err := client.Repositories.GenerateReleaseNotes(ctx, "o", "r", opt)
+		got, resp, err := client.Repositories.GenerateReleaseNotes(ctx, "o", "r", body)
 		if got != nil {
 			t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
 		}
@@ -564,11 +564,11 @@ func TestRepositoriesService_DownloadReleaseAsset_APIError(t *testing.T) {
 	}
 }
 
-func TestRepositoriesService_EditReleaseAsset(t *testing.T) {
+func TestRepositoriesService_UpdateReleaseAsset(t *testing.T) {
 	t.Parallel()
 	client, mux, _ := setup(t)
 
-	input := &ReleaseAsset{Name: Ptr("n")}
+	input := UpdateReleaseAssetRequest{Name: Ptr("n")}
 
 	mux.HandleFunc("/repos/o/r/releases/assets/1", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "PATCH")
@@ -577,23 +577,23 @@ func TestRepositoriesService_EditReleaseAsset(t *testing.T) {
 	})
 
 	ctx := t.Context()
-	asset, _, err := client.Repositories.EditReleaseAsset(ctx, "o", "r", 1, input)
+	asset, _, err := client.Repositories.UpdateReleaseAsset(ctx, "o", "r", 1, input)
 	if err != nil {
-		t.Errorf("Repositories.EditReleaseAsset returned error: %v", err)
+		t.Errorf("Repositories.UpdateReleaseAsset returned error: %v", err)
 	}
 	want := &ReleaseAsset{ID: Ptr(int64(1))}
 	if !cmp.Equal(asset, want) {
-		t.Errorf("Repositories.EditReleaseAsset returned = %+v, want %+v", asset, want)
+		t.Errorf("Repositories.UpdateReleaseAsset returned = %+v, want %+v", asset, want)
 	}
 
-	const methodName = "EditReleaseAsset"
+	const methodName = "UpdateReleaseAsset"
 	testBadOptions(t, methodName, func() (err error) {
-		_, _, err = client.Repositories.EditReleaseAsset(ctx, "\n", "\n", 1, input)
+		_, _, err = client.Repositories.UpdateReleaseAsset(ctx, "\n", "\n", 1, input)
 		return err
 	})
 
 	testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
-		got, resp, err := client.Repositories.EditReleaseAsset(ctx, "o", "r", 1, input)
+		got, resp, err := client.Repositories.UpdateReleaseAsset(ctx, "o", "r", 1, input)
 		if got != nil {
 			t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
 		}