feat!: Add enterprise security configurations, update API fields #3812
+826
−12
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
gmlewis
changed the title
Author
|
sorry forgot to add the generated files after my latest change.. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3812 +/- ##
==========================================
+ Coverage 92.27% 92.32% +0.05%
==========================================
Files 192 193 +1
Lines 13896 13988 +92
==========================================
+ Hits 12823 12915 +92
Misses 884 884
Partials 189 189 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
gmlewis
changed the title
gmlewis
added
the
Breaking API Change
gmlewis
requested changes
Nov 7, 2025
Collaborator
gmlewis
left a comment
gmlewis
left a comment
There was a problem hiding this comment.
please let me know if I should drop the commit with breaking changes and what you think about the other commits
I think that is fine, thanks. Please address the few minor suggestions I've made, then we should be ready for a second LGTM+Approval from any other contributor to this repo before merging.
cc: @stevehipwell - @alexandear - @zyfy29
| // GitHub API docs: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise | ||
| // | ||
| //meta:operation POST /enterprises/{enterprise}/code-security/configurations | ||
| func (s *EnterpriseService) CreateCodeSecurityConfiguration(ctx context.Context, enterprise string, c *CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) { |
Collaborator
There was a problem hiding this comment.
Suggested change
| func (s *EnterpriseService) CreateCodeSecurityConfiguration(ctx context.Context, enterprise string, c *CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) { | |
| func (s *EnterpriseService) CreateCodeSecurityConfiguration(ctx context.Context, enterprise string, config CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) { |
Contributor
There was a problem hiding this comment.
I think should be a separate struct (fields name and description are required):
Suggested change
| func (s *EnterpriseService) CreateCodeSecurityConfiguration(ctx context.Context, enterprise string, c *CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) { | |
| func (s *EnterpriseService) CreateCodeSecurityConfiguration(ctx context.Context, enterprise string, config CreateCodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) { |
type CreateCodeSecurityConfiguration struct {
Name string `json:"name"`
Desription string `json:"description"`
// all other optional fields
}| // GitHub API docs: https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise | ||
| // | ||
| //meta:operation PATCH /enterprises/{enterprise}/code-security/configurations/{configuration_id} | ||
| func (s *EnterpriseService) UpdateCodeSecurityConfiguration(ctx context.Context, enterprise string, id int64, c *CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) { |
Collaborator
There was a problem hiding this comment.
Suggested change
| func (s *EnterpriseService) UpdateCodeSecurityConfiguration(ctx context.Context, enterprise string, id int64, c *CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) { | |
| func (s *EnterpriseService) UpdateCodeSecurityConfiguration(ctx context.Context, enterprise string, id int64, config CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) { |
| } | ||
|
|
||
| // AttachCodeSecurityConfigurationToRepositories attaches an enterprise code security configuration to repositories. | ||
| // |
Collaborator
There was a problem hiding this comment.
Suggested change
| // | |
| // `scope` is the type of repositories to attach the configuration to. | |
| // Can be one of: `all`, `all_without_configurations`. | |
| // |
| } | ||
|
|
||
| // SetDefaultCodeSecurityConfiguration sets a code security configuration as a default for an enterprise. | ||
| // |
Collaborator
There was a problem hiding this comment.
Suggested change
| // | |
| // `defaultForNewRepos` specifies which types of repository this security configuration should be applied to by default. | |
| // Can be one of: `all`, `none`, `private_and_internal, public`. | |
| // |
| // GitHub API docs: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise | ||
| // | ||
| //meta:operation PUT /enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults | ||
| func (s *EnterpriseService) SetDefaultCodeSecurityConfiguration(ctx context.Context, enterprise string, id int64, newReposParam string) (*CodeSecurityConfigurationWithDefaultForNewRepos, *Response, error) { |
Collaborator
There was a problem hiding this comment.
Suggested change
| func (s *EnterpriseService) SetDefaultCodeSecurityConfiguration(ctx context.Context, enterprise string, id int64, newReposParam string) (*CodeSecurityConfigurationWithDefaultForNewRepos, *Response, error) { | |
| func (s *EnterpriseService) SetDefaultCodeSecurityConfiguration(ctx context.Context, enterprise string, id int64, defaultForNewRepos string) (*CodeSecurityConfigurationWithDefaultForNewRepos, *Response, error) { |
alexandear
suggested changes
Nov 8, 2025
| // GitHub API docs: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise | ||
| // | ||
| //meta:operation GET /enterprises/{enterprise}/code-security/configurations | ||
| func (s *EnterpriseService) GetCodeSecurityConfigurations(ctx context.Context, enterprise string) ([]*CodeSecurityConfiguration, *Response, error) { |
Contributor
There was a problem hiding this comment.
Please add query options according to the doc:
| // GitHub API docs: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise | ||
| // | ||
| //meta:operation POST /enterprises/{enterprise}/code-security/configurations | ||
| func (s *EnterpriseService) CreateCodeSecurityConfiguration(ctx context.Context, enterprise string, c *CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) { |
Contributor
There was a problem hiding this comment.
I think should be a separate struct (fields name and description are required):
Suggested change
| func (s *EnterpriseService) CreateCodeSecurityConfiguration(ctx context.Context, enterprise string, c *CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) { | |
| func (s *EnterpriseService) CreateCodeSecurityConfiguration(ctx context.Context, enterprise string, config CreateCodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) { |
type CreateCodeSecurityConfiguration struct {
Name string `json:"name"`
Desription string `json:"description"`
// all other optional fields
}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
BREAKING CHANGE:
AttachCodeSecurityConfigurationsToRepositoriesis nowAttachCodeSecurityConfigurationToRepositories.please let me know if I should drop the commit with breaking changes and what you think about the other commits