Skip to content

Commit 9ff3461

Browse files
committed
chore(release data source): add 'Description' fields
This adds `Description` fields to the release data source, per request of @deiga via #2515 (comment) Signed-off-by: Mike Ball <mikedball@gmail.com>
1 parent e83bbf3 commit 9ff3461

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

github/data_source_github_release.go

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,38 @@ import (
1414

1515
func dataSourceGithubRelease() *schema.Resource {
1616
return &schema.Resource{
17-
Read: dataSourceGithubReleaseRead,
18-
17+
Read: dataSourceGithubReleaseRead,
18+
Description: "Use this data source to retrieve information about a GitHub release in a specific repository.",
1919
Schema: map[string]*schema.Schema{
2020
"repository": {
21-
Type: schema.TypeString,
22-
Required: true,
21+
Type: schema.TypeString,
22+
Required: true,
23+
Description: "Name of the repository to retrieve the release from.",
2324
},
2425
"owner": {
25-
Type: schema.TypeString,
26-
Required: true,
26+
Type: schema.TypeString,
27+
Required: true,
28+
Description: "Owner of the repository.",
2729
},
2830
"retrieve_by": {
29-
Type: schema.TypeString,
30-
Required: true,
31+
Type: schema.TypeString,
32+
Required: true,
33+
Description: "Describes how to fetch the release. Valid values are `id`, `tag`, `latest`.",
3134
ValidateDiagFunc: toDiagFunc(validation.StringInSlice([]string{
3235
"latest",
3336
"id",
3437
"tag",
3538
}, false), "retrieve_by"),
3639
},
3740
"release_tag": {
38-
Type: schema.TypeString,
39-
Optional: true,
41+
Type: schema.TypeString,
42+
Optional: true,
43+
Description: "ID of the release to retrieve. Must be specified when `retrieve_by` = `tag`.",
4044
},
4145
"release_id": {
42-
Type: schema.TypeInt,
43-
Optional: true,
46+
Type: schema.TypeInt,
47+
Optional: true,
48+
Description: "ID of the release to retrieve. Must be specified when `retrieve_by` = `id`.",
4449
},
4550
"target_commitish": {
4651
Type: schema.TypeString,

0 commit comments

Comments
 (0)