Skip to content

Commit de43fdf

Browse files
committed
docs: update organization_custom_properties documentation
1 parent fa01ee8 commit de43fdf

1 file changed

Lines changed: 16 additions & 3 deletions

File tree

website/docs/r/organization_custom_properties.html.markdown

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,21 +65,34 @@ resource "github_organization_custom_properties" "archived" {
6565
}
6666
```
6767

68+
~> **Note:** This resource requires the provider to be configured with an organization owner. Individual user accounts are not supported.
69+
70+
## Argument Reference
71+
72+
```hcl
73+
resource "github_organization_custom_properties" "docs_link" {
74+
property_name = "docs_link"
75+
value_type = "url"
76+
required = false
77+
description = "Link to the documentation for this repository"
78+
}
79+
```
80+
6881
## Argument Reference
6982

7083
The following arguments are supported:
7184

72-
* `property_name` - (Required) The name of the custom property.
85+
* `property_name` - (Required) The name of the custom property. Changing this will force the resource to be recreated.
7386

74-
* `value_type` - (Optional) The type of the custom property. Can be one of `string`, `single_select`, `multi_select`, or `true_false`. Defaults to `string`.
87+
* `value_type` - (Required) The type of the custom property. Can be one of `string`, `single_select`, `multi_select`, `true_false`, or `url`. Changing this will force the resource to be recreated.
7588

7689
* `required` - (Optional) Whether the custom property is required. Defaults to `false`.
7790

7891
* `description` - (Optional) The description of the custom property.
7992

8093
* `default_value` - (Optional) The default value of the custom property.
8194

82-
* `allowed_values` - (Optional) List of allowed values for the custom property. Only applicable when `value_type` is `single_select` or `multi_select`.
95+
* `allowed_values` - (Optional) List of allowed values for the custom property. Required when `value_type` is `single_select` or `multi_select`, and must not be set for other value types.
8396

8497
* `values_editable_by` - (Optional) Who can edit the values of the custom property. Can be one of `org_actors` or `org_and_repo_actors`. When set to `org_actors` (the default), only organization owners can edit the property values on repositories. When set to `org_and_repo_actors`, both organization owners and repository administrators with the custom properties permission can edit the values.
8598

0 commit comments

Comments
 (0)