Skip to content

Commit a547cae

Browse files
austenstoneaustenstone
committed
Remove pointers and omitempty from required API fields per review
All fields in HostedRunnerCustomImage and HostedRunnerCustomImageVersion are marked as required in the API schema, so they should be non-pointer types without omitempty.
1 parent 5981414 commit a547cae

5 files changed

Lines changed: 369 additions & 91 deletions

‎github/actions_hosted_runners.go‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -162,14 +162,14 @@ func (s *ActionsService) CreateHostedRunner(ctx context.Context, org string, req
162162

163163
// HostedRunnerCustomImage represents a custom image definition for GitHub-hosted runners.
164164
type HostedRunnerCustomImage struct {
165-
ID *int64 `json:"id,omitempty"`
166-
Platform *string `json:"platform,omitempty"`
167-
Name *string `json:"name,omitempty"`
168-
Source *string `json:"source,omitempty"`
169-
VersionsCount *int `json:"versions_count,omitempty"`
170-
TotalVersionsSize *int `json:"total_versions_size,omitempty"`
171-
LatestVersion *string `json:"latest_version,omitempty"`
172-
State *string `json:"state,omitempty"`
165+
ID int64 `json:"id"`
166+
Platform string `json:"platform"`
167+
Name string `json:"name"`
168+
Source string `json:"source"`
169+
VersionsCount int `json:"versions_count"`
170+
TotalVersionsSize int `json:"total_versions_size"`
171+
LatestVersion string `json:"latest_version"`
172+
State string `json:"state"`
173173
}
174174

175175
// HostedRunnerCustomImages represents a collection of custom images for GitHub-hosted runners.
@@ -180,11 +180,11 @@ type HostedRunnerCustomImages struct {
180180

181181
// HostedRunnerCustomImageVersion represents a version of a custom image for GitHub-hosted runners.
182182
type HostedRunnerCustomImageVersion struct {
183-
Version *string `json:"version,omitempty"`
184-
SizeGB *int `json:"size_gb,omitempty"`
185-
State *string `json:"state,omitempty"`
186-
StateDetails *string `json:"state_details,omitempty"`
187-
CreatedOn *Timestamp `json:"created_on,omitempty"`
183+
Version string `json:"version"`
184+
SizeGB int `json:"size_gb"`
185+
State string `json:"state"`
186+
StateDetails string `json:"state_details"`
187+
CreatedOn Timestamp `json:"created_on"`
188188
}
189189

190190
// HostedRunnerCustomImageVersions represents a collection of versions of a custom image.

‎github/actions_hosted_runners_test.go‎

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -902,24 +902,24 @@ func TestActionsService_ListHostedRunnerCustomImages(t *testing.T) {
902902
TotalCount: 2,
903903
Images: []*HostedRunnerCustomImage{
904904
{
905-
ID: Ptr(int64(1)),
906-
Platform: Ptr("linux-x64"),
907-
Name: Ptr("CustomImage1"),
908-
Source: Ptr("custom"),
909-
VersionsCount: Ptr(4),
910-
TotalVersionsSize: Ptr(200),
911-
LatestVersion: Ptr("1.3.0"),
912-
State: Ptr("Ready"),
905+
ID: 1,
906+
Platform: "linux-x64",
907+
Name: "CustomImage1",
908+
Source: "custom",
909+
VersionsCount: 4,
910+
TotalVersionsSize: 200,
911+
LatestVersion: "1.3.0",
912+
State: "Ready",
913913
},
914914
{
915-
ID: Ptr(int64(2)),
916-
Platform: Ptr("linux-x64"),
917-
Name: Ptr("CustomImage2"),
918-
Source: Ptr("custom"),
919-
VersionsCount: Ptr(2),
920-
TotalVersionsSize: Ptr(150),
921-
LatestVersion: Ptr("1.0.0"),
922-
State: Ptr("Ready"),
915+
ID: 2,
916+
Platform: "linux-x64",
917+
Name: "CustomImage2",
918+
Source: "custom",
919+
VersionsCount: 2,
920+
TotalVersionsSize: 150,
921+
LatestVersion: "1.0.0",
922+
State: "Ready",
923923
},
924924
},
925925
}
@@ -968,14 +968,14 @@ func TestActionsService_GetHostedRunnerCustomImage(t *testing.T) {
968968
}
969969

970970
want := &HostedRunnerCustomImage{
971-
ID: Ptr(int64(1)),
972-
Platform: Ptr("linux-x64"),
973-
Name: Ptr("CustomImage"),
974-
Source: Ptr("custom"),
975-
VersionsCount: Ptr(4),
976-
TotalVersionsSize: Ptr(200),
977-
LatestVersion: Ptr("1.3.0"),
978-
State: Ptr("Ready"),
971+
ID: 1,
972+
Platform: "linux-x64",
973+
Name: "CustomImage",
974+
Source: "custom",
975+
VersionsCount: 4,
976+
TotalVersionsSize: 200,
977+
LatestVersion: "1.3.0",
978+
State: "Ready",
979979
}
980980

981981
if !cmp.Equal(image, want) {
@@ -1059,18 +1059,18 @@ func TestActionsService_ListHostedRunnerCustomImageVersions(t *testing.T) {
10591059
TotalCount: 2,
10601060
ImageVersions: []*HostedRunnerCustomImageVersion{
10611061
{
1062-
Version: Ptr("1.1.0"),
1063-
SizeGB: Ptr(75),
1064-
State: Ptr("Ready"),
1065-
StateDetails: Ptr("None"),
1066-
CreatedOn: &Timestamp{time.Date(2024, 11, 9, 23, 39, 1, 0, time.UTC)},
1062+
Version: "1.1.0",
1063+
SizeGB: 75,
1064+
State: "Ready",
1065+
StateDetails: "None",
1066+
CreatedOn: Timestamp{time.Date(2024, 11, 9, 23, 39, 1, 0, time.UTC)},
10671067
},
10681068
{
1069-
Version: Ptr("1.0.0"),
1070-
SizeGB: Ptr(75),
1071-
State: Ptr("Ready"),
1072-
StateDetails: Ptr("None"),
1073-
CreatedOn: &Timestamp{time.Date(2024, 11, 8, 20, 39, 1, 0, time.UTC)},
1069+
Version: "1.0.0",
1070+
SizeGB: 75,
1071+
State: "Ready",
1072+
StateDetails: "None",
1073+
CreatedOn: Timestamp{time.Date(2024, 11, 8, 20, 39, 1, 0, time.UTC)},
10741074
},
10751075
},
10761076
}
@@ -1116,11 +1116,11 @@ func TestActionsService_GetHostedRunnerCustomImageVersion(t *testing.T) {
11161116
}
11171117

11181118
want := &HostedRunnerCustomImageVersion{
1119-
Version: Ptr("1.0.0"),
1120-
SizeGB: Ptr(75),
1121-
State: Ptr("Ready"),
1122-
StateDetails: Ptr("None"),
1123-
CreatedOn: &Timestamp{time.Date(2024, 11, 8, 20, 39, 1, 0, time.UTC)},
1119+
Version: "1.0.0",
1120+
SizeGB: 75,
1121+
State: "Ready",
1122+
StateDetails: "None",
1123+
CreatedOn: Timestamp{time.Date(2024, 11, 8, 20, 39, 1, 0, time.UTC)},
11241124
}
11251125

11261126
if !cmp.Equal(version, want) {

‎github/enterprise_actions_hosted_runners_test.go‎

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -901,24 +901,24 @@ func TestEnterpriseService_ListHostedRunnerCustomImages(t *testing.T) {
901901
TotalCount: 2,
902902
Images: []*HostedRunnerCustomImage{
903903
{
904-
ID: Ptr(int64(1)),
905-
Platform: Ptr("linux-x64"),
906-
Name: Ptr("CustomImage1"),
907-
Source: Ptr("custom"),
908-
VersionsCount: Ptr(4),
909-
TotalVersionsSize: Ptr(200),
910-
LatestVersion: Ptr("1.3.0"),
911-
State: Ptr("Ready"),
904+
ID: 1,
905+
Platform: "linux-x64",
906+
Name: "CustomImage1",
907+
Source: "custom",
908+
VersionsCount: 4,
909+
TotalVersionsSize: 200,
910+
LatestVersion: "1.3.0",
911+
State: "Ready",
912912
},
913913
{
914-
ID: Ptr(int64(2)),
915-
Platform: Ptr("linux-x64"),
916-
Name: Ptr("CustomImage2"),
917-
Source: Ptr("custom"),
918-
VersionsCount: Ptr(2),
919-
TotalVersionsSize: Ptr(150),
920-
LatestVersion: Ptr("1.0.0"),
921-
State: Ptr("Ready"),
914+
ID: 2,
915+
Platform: "linux-x64",
916+
Name: "CustomImage2",
917+
Source: "custom",
918+
VersionsCount: 2,
919+
TotalVersionsSize: 150,
920+
LatestVersion: "1.0.0",
921+
State: "Ready",
922922
},
923923
},
924924
}
@@ -967,14 +967,14 @@ func TestEnterpriseService_GetHostedRunnerCustomImage(t *testing.T) {
967967
}
968968

969969
want := &HostedRunnerCustomImage{
970-
ID: Ptr(int64(1)),
971-
Platform: Ptr("linux-x64"),
972-
Name: Ptr("CustomImage"),
973-
Source: Ptr("custom"),
974-
VersionsCount: Ptr(4),
975-
TotalVersionsSize: Ptr(200),
976-
LatestVersion: Ptr("1.3.0"),
977-
State: Ptr("Ready"),
970+
ID: 1,
971+
Platform: "linux-x64",
972+
Name: "CustomImage",
973+
Source: "custom",
974+
VersionsCount: 4,
975+
TotalVersionsSize: 200,
976+
LatestVersion: "1.3.0",
977+
State: "Ready",
978978
}
979979

980980
if !cmp.Equal(image, want) {
@@ -1058,18 +1058,18 @@ func TestEnterpriseService_ListHostedRunnerCustomImageVersions(t *testing.T) {
10581058
TotalCount: 2,
10591059
ImageVersions: []*HostedRunnerCustomImageVersion{
10601060
{
1061-
Version: Ptr("1.1.0"),
1062-
SizeGB: Ptr(75),
1063-
State: Ptr("Ready"),
1064-
StateDetails: Ptr("None"),
1065-
CreatedOn: &Timestamp{time.Date(2024, 11, 9, 23, 39, 1, 0, time.UTC)},
1061+
Version: "1.1.0",
1062+
SizeGB: 75,
1063+
State: "Ready",
1064+
StateDetails: "None",
1065+
CreatedOn: Timestamp{time.Date(2024, 11, 9, 23, 39, 1, 0, time.UTC)},
10661066
},
10671067
{
1068-
Version: Ptr("1.0.0"),
1069-
SizeGB: Ptr(75),
1070-
State: Ptr("Ready"),
1071-
StateDetails: Ptr("None"),
1072-
CreatedOn: &Timestamp{time.Date(2024, 11, 8, 20, 39, 1, 0, time.UTC)},
1068+
Version: "1.0.0",
1069+
SizeGB: 75,
1070+
State: "Ready",
1071+
StateDetails: "None",
1072+
CreatedOn: Timestamp{time.Date(2024, 11, 8, 20, 39, 1, 0, time.UTC)},
10731073
},
10741074
},
10751075
}
@@ -1115,11 +1115,11 @@ func TestEnterpriseService_GetHostedRunnerCustomImageVersion(t *testing.T) {
11151115
}
11161116

11171117
want := &HostedRunnerCustomImageVersion{
1118-
Version: Ptr("1.0.0"),
1119-
SizeGB: Ptr(75),
1120-
State: Ptr("Ready"),
1121-
StateDetails: Ptr("None"),
1122-
CreatedOn: &Timestamp{time.Date(2024, 11, 8, 20, 39, 1, 0, time.UTC)},
1118+
Version: "1.0.0",
1119+
SizeGB: 75,
1120+
State: "Ready",
1121+
StateDetails: "None",
1122+
CreatedOn: Timestamp{time.Date(2024, 11, 8, 20, 39, 1, 0, time.UTC)},
11231123
}
11241124

11251125
if !cmp.Equal(version, want) {

0 commit comments

Comments
 (0)