Skip to content

feat: Support explicit custom property values #4560

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

Closed
devantler wants to merge 2 commits into from
Closed

feat: Support explicit custom property values #4560

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
9f33643
feat: Support explicit custom property values
devantler Sep 16, 2026
dac265e
fix: Use omitzero for explicit values
devantler Sep 16, 2026
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
1 change: 1 addition & 0 deletions .golangci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,7 @@ linters:
- CreateTag.Object # TODO: Git
- CreateTag.Tag # TODO: Git
- CreateTag.Type # TODO: Git
- CustomProperty.RequireExplicitValues
- DismissalRestrictionsRequest.Apps # TODO: Repositories
- DismissalRestrictionsRequest.Teams # TODO: Repositories
- DismissalRestrictionsRequest.Users # TODO: Repositories
Expand Down
8 changes: 8 additions & 0 deletions github/github-accessors.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions github/github-accessors_test.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions github/orgs_properties.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ type CustomProperty struct {
ValueType PropertyValueType `json:"value_type"`
// Whether the property is required.
Required *bool `json:"required,omitempty"`
// Whether setting property values is mandatory.
RequireExplicitValues *bool `json:"require_explicit_values,omitzero"`
// Default value of the property.
DefaultValue any `json:"default_value,omitempty"`
// Short description of the property.
Expand Down
96 changes: 67 additions & 29 deletions github/orgs_properties_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ func TestOrganizationsService_GetAllCustomProperties(t *testing.T) {
"property_name": "name",
"value_type": "single_select",
"required": true,
"require_explicit_values": true,
"default_value": "production",
"description": "Prod or dev environment",
"allowed_values":[
Expand Down Expand Up @@ -76,13 +77,14 @@ func TestOrganizationsService_GetAllCustomProperties(t *testing.T) {

want := []*CustomProperty{
{
PropertyName: new("name"),
ValueType: PropertyValueTypeSingleSelect,
Required: new(true),
DefaultValue: "production",
Description: new("Prod or dev environment"),
AllowedValues: []string{"production", "development"},
ValuesEditableBy: new("org_actors"),
PropertyName: new("name"),
ValueType: PropertyValueTypeSingleSelect,
Required: new(true),
RequireExplicitValues: new(true),
DefaultValue: "production",
Description: new("Prod or dev environment"),
AllowedValues: []string{"production", "development"},
ValuesEditableBy: new("org_actors"),
},
{
PropertyName: new("test"),
Expand Down Expand Up @@ -135,9 +137,10 @@ func TestOrganizationsService_CreateOrUpdateCustomProperties(t *testing.T) {
}{
Properties: []*CustomProperty{
{
PropertyName: new("name"),
ValueType: PropertyValueTypeSingleSelect,
Required: new(true),
PropertyName: new("name"),
ValueType: PropertyValueTypeSingleSelect,
Required: new(true),
RequireExplicitValues: new(false),
},
{
PropertyName: new("service"),
Expand All @@ -153,7 +156,8 @@ func TestOrganizationsService_CreateOrUpdateCustomProperties(t *testing.T) {
{
"property_name": "name",
"value_type": "single_select",
"required": true
"required": true,
"require_explicit_values": false
},
{
"property_name": "service",
Expand All @@ -170,9 +174,10 @@ func TestOrganizationsService_CreateOrUpdateCustomProperties(t *testing.T) {

want := []*CustomProperty{
{
PropertyName: new("name"),
ValueType: PropertyValueTypeSingleSelect,
Required: new(true),
PropertyName: new("name"),
ValueType: PropertyValueTypeSingleSelect,
Required: new(true),
RequireExplicitValues: new(false),
},
{
PropertyName: new("service"),
Expand Down Expand Up @@ -249,12 +254,24 @@ func TestOrganizationsService_CreateOrUpdateCustomProperty(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

input := &CustomProperty{
ValueType: PropertyValueTypeSingleSelect,
Required: new(true),
RequireExplicitValues: new(false),
DefaultValue: "production",
Description: new("Prod or dev environment"),
AllowedValues: []string{"production", "development"},
ValuesEditableBy: new("org_actors"),
}

mux.HandleFunc("/orgs/o/properties/schema/name", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "PUT")
testJSONBody(t, r, input)
fmt.Fprint(w, `{
"property_name": "name",
"value_type": "single_select",
"required": true,
"require_explicit_values": false,
"default_value": "production",
"description": "Prod or dev environment",
"allowed_values":[
Expand All @@ -266,26 +283,20 @@ func TestOrganizationsService_CreateOrUpdateCustomProperty(t *testing.T) {
})

ctx := t.Context()
property, _, err := client.Organizations.CreateOrUpdateCustomProperty(ctx, "o", "name", &CustomProperty{
ValueType: PropertyValueTypeSingleSelect,
Required: new(true),
DefaultValue: "production",
Description: new("Prod or dev environment"),
AllowedValues: []string{"production", "development"},
ValuesEditableBy: new("org_actors"),
})
property, _, err := client.Organizations.CreateOrUpdateCustomProperty(ctx, "o", "name", input)
if err != nil {
t.Errorf("Organizations.CreateOrUpdateCustomProperty returned error: %v", err)
}

want := &CustomProperty{
PropertyName: new("name"),
ValueType: PropertyValueTypeSingleSelect,
Required: new(true),
DefaultValue: "production",
Description: new("Prod or dev environment"),
AllowedValues: []string{"production", "development"},
ValuesEditableBy: new("org_actors"),
PropertyName: new("name"),
ValueType: PropertyValueTypeSingleSelect,
Required: new(true),
RequireExplicitValues: new(false),
DefaultValue: "production",
Description: new("Prod or dev environment"),
AllowedValues: []string{"production", "development"},
ValuesEditableBy: new("org_actors"),
}
if !cmp.Equal(property, want) {
t.Errorf("Organizations.CreateOrUpdateCustomProperty returned %+v, want %+v", property, want)
Expand All @@ -302,6 +313,33 @@ func TestOrganizationsService_CreateOrUpdateCustomProperty(t *testing.T) {
})
}

func TestCustomProperty_RequireExplicitValuesJSON(t *testing.T) {
t.Parallel()
tests := map[string]struct {
property *CustomProperty
want string
}{
"omitted": {
property: &CustomProperty{ValueType: PropertyValueTypeString},
want: `{"value_type":"string"}`,
},
"explicit false": {
property: &CustomProperty{
ValueType: PropertyValueTypeString,
RequireExplicitValues: new(false),
},
want: `{"value_type":"string","require_explicit_values":false}`,
},
}

for name, test := range tests {
t.Run(name, func(t *testing.T) {
t.Parallel()
testJSONMarshal(t, test.property, test.want)
})
}
}

func TestOrganizationsService_RemoveCustomProperty(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)
Expand Down
Loading