Skip to content

Commit d11391c

Browse files
refactor!: Pass release-notes and asset params by value and rename EditReleaseAsset to UpdateReleaseAsset (#4336)
BREAKING CHANGE: `GenerateReleaseNotes` now takes `GenerateNotesRequest` by value (renamed from `GenerateNotesOptions`); `EditReleaseAsset` is renamed to `UpdateReleaseAsset` and takes `UpdateReleaseAssetRequest` by value.
1 parent c9f5330 commit d11391c

5 files changed

Lines changed: 97 additions & 36 deletions

File tree

‎.golangci.yml‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,6 @@ linters:
229229
- EnterpriseSecurityAnalysisSettings
230230
- ExternalGroup
231231
- GenerateJITConfigRequest
232-
- GenerateNotesOptions
233232
- Hook
234233
- HookConfig
235234
- ImpersonateUserOptions
@@ -258,7 +257,6 @@ linters:
258257
- PullRequestReviewDismissalRequest
259258
- PullRequestReviewRequest
260259
- PullRequestReviewsEnforcementUpdate
261-
- ReleaseAsset
262260
- RepoMergeUpstreamRequest
263261
- Repository
264262
- RepositoryAddCollaboratorOptions
@@ -300,7 +298,6 @@ linters:
300298
- CreateOrUpdateCustomRepoRoleOptions
301299
- CreateOrUpdateIssueTypesOptions
302300
- CreateOrgInvitationOptions
303-
- GenerateNotesOptions
304301
- ImpersonateUserOptions
305302
- InstallationTokenListRepoOptions
306303
- InstallationTokenOptions

‎github/github-accessors.go‎

Lines changed: 28 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎github/github-accessors_test.go‎

Lines changed: 44 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎github/repos_releases.go‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ type RepositoryReleaseNotes struct {
5656
Body string `json:"body"`
5757
}
5858

59-
// GenerateNotesOptions represents the options to generate release notes.
60-
type GenerateNotesOptions struct {
59+
// GenerateNotesRequest represents the request to generate release notes.
60+
type GenerateNotesRequest struct {
6161
TagName string `json:"tag_name"`
6262
PreviousTagName *string `json:"previous_tag_name,omitempty"`
6363
TargetCommitish *string `json:"target_commitish,omitempty"`
@@ -82,6 +82,13 @@ type ReleaseAsset struct {
8282
Digest *string `json:"digest,omitempty"`
8383
}
8484

85+
// UpdateReleaseAssetRequest represents the request to update a release asset.
86+
type UpdateReleaseAssetRequest struct {
87+
Name *string `json:"name,omitempty"`
88+
Label *string `json:"label,omitempty"`
89+
State *string `json:"state,omitempty"`
90+
}
91+
8592
func (r ReleaseAsset) String() string {
8693
return Stringify(r)
8794
}
@@ -146,7 +153,7 @@ func (s *RepositoriesService) GetReleaseByTag(ctx context.Context, owner, repo,
146153
// GitHub API docs: https://docs.github.com/rest/releases/releases?apiVersion=2022-11-28#generate-release-notes-content-for-a-release
147154
//
148155
//meta:operation POST /repos/{owner}/{repo}/releases/generate-notes
149-
func (s *RepositoriesService) GenerateReleaseNotes(ctx context.Context, owner, repo string, body *GenerateNotesOptions) (*RepositoryReleaseNotes, *Response, error) {
156+
func (s *RepositoriesService) GenerateReleaseNotes(ctx context.Context, owner, repo string, body GenerateNotesRequest) (*RepositoryReleaseNotes, *Response, error) {
150157
u := fmt.Sprintf("repos/%v/%v/releases/generate-notes", owner, repo)
151158
req, err := s.client.NewRequest(ctx, "POST", u, body)
152159
if err != nil {
@@ -375,12 +382,12 @@ func (s *RepositoriesService) downloadReleaseAssetFromURL(ctx context.Context, f
375382
return resp.Body, nil
376383
}
377384

378-
// EditReleaseAsset edits a repository release asset.
385+
// UpdateReleaseAsset updates a repository release asset.
379386
//
380387
// GitHub API docs: https://docs.github.com/rest/releases/assets?apiVersion=2022-11-28#update-a-release-asset
381388
//
382389
//meta:operation PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}
383-
func (s *RepositoriesService) EditReleaseAsset(ctx context.Context, owner, repo string, id int64, body *ReleaseAsset) (*ReleaseAsset, *Response, error) {
390+
func (s *RepositoriesService) UpdateReleaseAsset(ctx context.Context, owner, repo string, id int64, body UpdateReleaseAssetRequest) (*ReleaseAsset, *Response, error) {
384391
u := fmt.Sprintf("repos/%v/%v/releases/assets/%v", owner, repo, id)
385392

386393
req, err := s.client.NewRequest(ctx, "PATCH", u, body)

‎github/repos_releases_test.go‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -56,18 +56,18 @@ func TestRepositoriesService_GenerateReleaseNotes(t *testing.T) {
5656
t.Parallel()
5757
client, mux, _ := setup(t)
5858

59-
opt := &GenerateNotesOptions{
59+
body := GenerateNotesRequest{
6060
TagName: "v1.0.0",
6161
}
6262

6363
mux.HandleFunc("/repos/o/r/releases/generate-notes", func(w http.ResponseWriter, r *http.Request) {
6464
testMethod(t, r, "POST")
65-
testJSONBody(t, r, opt)
65+
testJSONBody(t, r, body)
6666
fmt.Fprint(w, `{"name":"v1.0.0","body":"**Full Changelog**: https://github.com/o/r/compare/v0.9.0...v1.0.0"}`)
6767
})
6868

6969
ctx := t.Context()
70-
releases, _, err := client.Repositories.GenerateReleaseNotes(ctx, "o", "r", opt)
70+
releases, _, err := client.Repositories.GenerateReleaseNotes(ctx, "o", "r", body)
7171
if err != nil {
7272
t.Errorf("Repositories.GenerateReleaseNotes returned error: %v", err)
7373
}
@@ -81,12 +81,12 @@ func TestRepositoriesService_GenerateReleaseNotes(t *testing.T) {
8181

8282
const methodName = "GenerateReleaseNotes"
8383
testBadOptions(t, methodName, func() (err error) {
84-
_, _, err = client.Repositories.GenerateReleaseNotes(ctx, "\n", "\n", opt)
84+
_, _, err = client.Repositories.GenerateReleaseNotes(ctx, "\n", "\n", body)
8585
return err
8686
})
8787

8888
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
89-
got, resp, err := client.Repositories.GenerateReleaseNotes(ctx, "o", "r", opt)
89+
got, resp, err := client.Repositories.GenerateReleaseNotes(ctx, "o", "r", body)
9090
if got != nil {
9191
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
9292
}
@@ -564,11 +564,11 @@ func TestRepositoriesService_DownloadReleaseAsset_APIError(t *testing.T) {
564564
}
565565
}
566566

567-
func TestRepositoriesService_EditReleaseAsset(t *testing.T) {
567+
func TestRepositoriesService_UpdateReleaseAsset(t *testing.T) {
568568
t.Parallel()
569569
client, mux, _ := setup(t)
570570

571-
input := &ReleaseAsset{Name: Ptr("n")}
571+
input := UpdateReleaseAssetRequest{Name: Ptr("n")}
572572

573573
mux.HandleFunc("/repos/o/r/releases/assets/1", func(w http.ResponseWriter, r *http.Request) {
574574
testMethod(t, r, "PATCH")
@@ -577,23 +577,23 @@ func TestRepositoriesService_EditReleaseAsset(t *testing.T) {
577577
})
578578

579579
ctx := t.Context()
580-
asset, _, err := client.Repositories.EditReleaseAsset(ctx, "o", "r", 1, input)
580+
asset, _, err := client.Repositories.UpdateReleaseAsset(ctx, "o", "r", 1, input)
581581
if err != nil {
582-
t.Errorf("Repositories.EditReleaseAsset returned error: %v", err)
582+
t.Errorf("Repositories.UpdateReleaseAsset returned error: %v", err)
583583
}
584584
want := &ReleaseAsset{ID: Ptr(int64(1))}
585585
if !cmp.Equal(asset, want) {
586-
t.Errorf("Repositories.EditReleaseAsset returned = %+v, want %+v", asset, want)
586+
t.Errorf("Repositories.UpdateReleaseAsset returned = %+v, want %+v", asset, want)
587587
}
588588

589-
const methodName = "EditReleaseAsset"
589+
const methodName = "UpdateReleaseAsset"
590590
testBadOptions(t, methodName, func() (err error) {
591-
_, _, err = client.Repositories.EditReleaseAsset(ctx, "\n", "\n", 1, input)
591+
_, _, err = client.Repositories.UpdateReleaseAsset(ctx, "\n", "\n", 1, input)
592592
return err
593593
})
594594

595595
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
596-
got, resp, err := client.Repositories.EditReleaseAsset(ctx, "o", "r", 1, input)
596+
got, resp, err := client.Repositories.UpdateReleaseAsset(ctx, "o", "r", 1, input)
597597
if got != nil {
598598
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
599599
}

0 commit comments

Comments
 (0)