Skip to content

feat!: Rename code scanning params from plural to singular #3331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 22, 2024
Merged

feat!: Rename code scanning params from plural to singular #3331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f478d2
feat!: rename code scanning params from plural to singular
ihor-hrytskiv Oct 21, 2024
cf59fc6
Update github/repos_rules.go
ihor-hrytskiv Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions github/orgs_rules_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -660,7 +660,7 @@ func TestOrganizationsService_CreateOrganizationRuleset_RepoProperty(t *testing.
Pattern: "github",
}),
NewRequiredCodeScanningRule(&RequiredCodeScanningRuleParameters{
RequiredCodeScanningTools: []*RuleRequiredCodeScanningTools{
RequiredCodeScanningTools: []*RuleRequiredCodeScanningTool{
{
Tool: "CodeQL",
SecurityAlertsThreshold: "high_or_higher",
Expand Down Expand Up @@ -762,7 +762,7 @@ func TestOrganizationsService_CreateOrganizationRuleset_RepoProperty(t *testing.
Pattern: "github",
}),
NewRequiredCodeScanningRule(&RequiredCodeScanningRuleParameters{
RequiredCodeScanningTools: []*RuleRequiredCodeScanningTools{
RequiredCodeScanningTools: []*RuleRequiredCodeScanningTool{
{
Tool: "CodeQL",
SecurityAlertsThreshold: "high_or_higher",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
6 changes: 3 additions & 3 deletions github/repos_rules.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,16 +159,16 @@ type RequiredWorkflowsRuleParameters struct {
RequiredWorkflows []*RuleRequiredWorkflow `json:"workflows"`
}

// RuleRequiredCodeScanningTools represents the RequiredCodeScanningTools for the RequiredCodeScanningParameters object.
type RuleRequiredCodeScanningTools struct {
// 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"`
Tool string `json:"tool"`
}

// 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.
Expand Down
2 changes: 1 addition & 1 deletion github/repos_rules_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading