Skip to content

Commit 83697c8

Browse files
authored
fix!: Change return type of GetDefaultCodeSecurityConfigurations (#3747)
BREAKING CHANGE: `GetDefaultCodeSecurityConfigurations` now returns `CodeSecurityConfigurationWithDefaultForNewRepos` instead of `CodeSecurityConfiguration`.
1 parent 32d0045 commit 83697c8

File tree

2 files changed

+19
-12
lines changed

2 files changed

+19
-12
lines changed

github/orgs_codesecurity_configurations.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,15 +106,15 @@ func (s *OrganizationsService) CreateCodeSecurityConfiguration(ctx context.Conte
106106
// GitHub API docs: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations
107107
//
108108
//meta:operation GET /orgs/{org}/code-security/configurations/defaults
109-
func (s *OrganizationsService) GetDefaultCodeSecurityConfigurations(ctx context.Context, org string) ([]*CodeSecurityConfiguration, *Response, error) {
109+
func (s *OrganizationsService) GetDefaultCodeSecurityConfigurations(ctx context.Context, org string) ([]*CodeSecurityConfigurationWithDefaultForNewRepos, *Response, error) {
110110
u := fmt.Sprintf("orgs/%v/code-security/configurations/defaults", org)
111111

112112
req, err := s.client.NewRequest("GET", u, nil)
113113
if err != nil {
114114
return nil, nil, err
115115
}
116116

117-
var configurations []*CodeSecurityConfiguration
117+
var configurations []*CodeSecurityConfigurationWithDefaultForNewRepos
118118
resp, err := s.client.Do(ctx, req, &configurations)
119119
if err != nil {
120120
return nil, resp, err

github/orgs_codesecurity_configurations_test.go

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -159,25 +159,32 @@ func TestOrganizationsService_GetDefaultCodeSecurityConfigurations(t *testing.T)
159159
testMethod(t, r, "GET")
160160
fmt.Fprint(w, `[
161161
{
162-
"id":1,
163-
"name":"config1",
164-
"code_scanning_default_setup": "enabled"
162+
"default_for_new_repos": "public",
163+
"configuration": {
164+
"id":1,
165+
"name":"config1",
166+
"code_scanning_default_setup": "enabled"
167+
}
165168
},
166169
{
167-
"id":2,
168-
"name":"config2",
169-
"private_vulnerability_reporting": "enabled"
170-
}]`)
170+
"default_for_new_repos": "private_and_internal",
171+
"configuration": {
172+
"id":2,
173+
"name":"config2",
174+
"private_vulnerability_reporting": "enabled"
175+
}
176+
}
177+
]`)
171178
})
172179

173180
configurations, _, err := client.Organizations.GetDefaultCodeSecurityConfigurations(ctx, "o")
174181
if err != nil {
175182
t.Errorf("Organizations.GetDefaultCodeSecurityConfigurations returned error: %v", err)
176183
}
177184

178-
want := []*CodeSecurityConfiguration{
179-
{ID: Ptr(int64(1)), Name: Ptr("config1"), CodeScanningDefaultSetup: Ptr("enabled")},
180-
{ID: Ptr(int64(2)), Name: Ptr("config2"), PrivateVulnerabilityReporting: Ptr("enabled")},
185+
want := []*CodeSecurityConfigurationWithDefaultForNewRepos{
186+
{DefaultForNewRepos: Ptr("public"), Configuration: &CodeSecurityConfiguration{ID: Ptr(int64(1)), Name: Ptr("config1"), CodeScanningDefaultSetup: Ptr("enabled")}},
187+
{DefaultForNewRepos: Ptr("private_and_internal"), Configuration: &CodeSecurityConfiguration{ID: Ptr(int64(2)), Name: Ptr("config2"), PrivateVulnerabilityReporting: Ptr("enabled")}},
181188
}
182189
if !cmp.Equal(configurations, want) {
183190
t.Errorf("Organizations.GetDefaultCodeSecurityConfigurations returned %+v, want %+v", configurations, want)

0 commit comments

Comments
 (0)