From 2f478d27952994608f0269c19faea70ceb3776ce Mon Sep 17 00:00:00 2001 From: Ihor Hrytskiv Date: Mon, 21 Oct 2024 19:51:45 +0300 Subject: [PATCH 1/2] feat!: rename code scanning params from plural to singular --- github/orgs_rules_test.go | 12 ++++++------ github/repos_rules.go | 6 +++--- github/repos_rules_test.go | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/github/orgs_rules_test.go b/github/orgs_rules_test.go index 353705febad..ac391dae531 100644 --- a/github/orgs_rules_test.go +++ b/github/orgs_rules_test.go @@ -301,7 +301,7 @@ func TestOrganizationsService_CreateOrganizationRuleset_RepoNames(t *testing.T) Pattern: "github", }), NewRequiredCodeScanningRule(&RequiredCodeScanningRuleParameters{ - RequiredCodeScanningTools: []*RuleRequiredCodeScanningTools{ + RequiredCodeScanningTools: []*RuleRequiredCodeScanningTool{ { Tool: "CodeQL", SecurityAlertsThreshold: "high_or_higher", @@ -396,7 +396,7 @@ func TestOrganizationsService_CreateOrganizationRuleset_RepoNames(t *testing.T) Pattern: "github", }), NewRequiredCodeScanningRule(&RequiredCodeScanningRuleParameters{ - RequiredCodeScanningTools: []*RuleRequiredCodeScanningTools{ + RequiredCodeScanningTools: []*RuleRequiredCodeScanningTool{ { Tool: "CodeQL", SecurityAlertsThreshold: "high_or_higher", @@ -660,7 +660,7 @@ func TestOrganizationsService_CreateOrganizationRuleset_RepoProperty(t *testing. Pattern: "github", }), NewRequiredCodeScanningRule(&RequiredCodeScanningRuleParameters{ - RequiredCodeScanningTools: []*RuleRequiredCodeScanningTools{ + RequiredCodeScanningTools: []*RuleRequiredCodeScanningTool{ { Tool: "CodeQL", SecurityAlertsThreshold: "high_or_higher", @@ -762,7 +762,7 @@ func TestOrganizationsService_CreateOrganizationRuleset_RepoProperty(t *testing. Pattern: "github", }), NewRequiredCodeScanningRule(&RequiredCodeScanningRuleParameters{ - RequiredCodeScanningTools: []*RuleRequiredCodeScanningTools{ + RequiredCodeScanningTools: []*RuleRequiredCodeScanningTool{ { Tool: "CodeQL", SecurityAlertsThreshold: "high_or_higher", @@ -1009,7 +1009,7 @@ func TestOrganizationsService_CreateOrganizationRuleset_RepoIDs(t *testing.T) { Pattern: "github", }), NewRequiredCodeScanningRule(&RequiredCodeScanningRuleParameters{ - RequiredCodeScanningTools: []*RuleRequiredCodeScanningTools{ + RequiredCodeScanningTools: []*RuleRequiredCodeScanningTool{ { Tool: "CodeQL", SecurityAlertsThreshold: "high_or_higher", @@ -1102,7 +1102,7 @@ func TestOrganizationsService_CreateOrganizationRuleset_RepoIDs(t *testing.T) { Pattern: "github", }), NewRequiredCodeScanningRule(&RequiredCodeScanningRuleParameters{ - RequiredCodeScanningTools: []*RuleRequiredCodeScanningTools{ + RequiredCodeScanningTools: []*RuleRequiredCodeScanningTool{ { Tool: "CodeQL", SecurityAlertsThreshold: "high_or_higher", diff --git a/github/repos_rules.go b/github/repos_rules.go index bb8aa121f81..1b4baedb686 100644 --- a/github/repos_rules.go +++ b/github/repos_rules.go @@ -159,8 +159,8 @@ type RequiredWorkflowsRuleParameters struct { RequiredWorkflows []*RuleRequiredWorkflow `json:"workflows"` } -// RuleRequiredCodeScanningTools represents the RequiredCodeScanningTools for the RequiredCodeScanningParameters object. -type RuleRequiredCodeScanningTools struct { +// RuleRequiredCodeScanningTool represents the RequiredCodeScanningTools for the RequiredCodeScanningParameters object. +type RuleRequiredCodeScanningTool struct { AlertsThreshold string `json:"alerts_threshold"` SecurityAlertsThreshold string `json:"security_alerts_threshold"` Tool string `json:"tool"` @@ -168,7 +168,7 @@ type RuleRequiredCodeScanningTools struct { // RequiredCodeScanningRuleParameters represents the code_scanning rule parameters. type RequiredCodeScanningRuleParameters struct { - RequiredCodeScanningTools []*RuleRequiredCodeScanningTools `json:"code_scanning_tools"` + RequiredCodeScanningTools []*RuleRequiredCodeScanningTool `json:"code_scanning_tools"` } // RepositoryRule represents a GitHub Rule. diff --git a/github/repos_rules_test.go b/github/repos_rules_test.go index 4af486aaa86..3f7f6721dbf 100644 --- a/github/repos_rules_test.go +++ b/github/repos_rules_test.go @@ -316,7 +316,7 @@ func TestRepositoryRule_UnmarshalJSON(t *testing.T) { "Valid Required code_scanning params": { data: `{"type":"code_scanning","parameters":{"code_scanning_tools":[{"tool": "CodeQL", "security_alerts_threshold": "high_or_higher", "alerts_threshold": "errors"}]}}`, want: NewRequiredCodeScanningRule(&RequiredCodeScanningRuleParameters{ - RequiredCodeScanningTools: []*RuleRequiredCodeScanningTools{ + RequiredCodeScanningTools: []*RuleRequiredCodeScanningTool{ { Tool: "CodeQL", SecurityAlertsThreshold: "high_or_higher", From cf59fc6eda71719e08ad7c567cd6b0427b7153f7 Mon Sep 17 00:00:00 2001 From: ihor-hrytskiv <39990360+ihor-hrytskiv@users.noreply.github.com> Date: Mon, 21 Oct 2024 20:16:43 +0300 Subject: [PATCH 2/2] Update github/repos_rules.go Co-authored-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com> --- github/repos_rules.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/github/repos_rules.go b/github/repos_rules.go index 1b4baedb686..07e8afad0ed 100644 --- a/github/repos_rules.go +++ b/github/repos_rules.go @@ -159,7 +159,7 @@ type RequiredWorkflowsRuleParameters struct { RequiredWorkflows []*RuleRequiredWorkflow `json:"workflows"` } -// RuleRequiredCodeScanningTool represents the RequiredCodeScanningTools for the RequiredCodeScanningParameters object. +// RuleRequiredCodeScanningTool represents a single required code-scanning tool for the RequiredCodeScanningParameters object. type RuleRequiredCodeScanningTool struct { AlertsThreshold string `json:"alerts_threshold"` SecurityAlertsThreshold string `json:"security_alerts_threshold"`