Skip to content

Commit fd72b8a

Browse files
authored
fix: Correct grammar errors in github_release data source docs (#2515)
* correct grammar errors in data.github_release docs This corrects grammar errors in the `github_release` data source documentation by correcting the contraction "it's" ("it is") to the possessive "its." Signed-off-by: Mike Ball <mikedball@gmail.com> * 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> --------- Signed-off-by: Mike Ball <mikedball@gmail.com>
1 parent a3b39ed commit fd72b8a

2 files changed

Lines changed: 19 additions & 14 deletions

File tree

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,

website/docs/d/release.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ data "github_release" "example" {
2020
}
2121
```
2222

23-
To retrieve a specific release from a repository based on it's ID:
23+
To retrieve a specific release from a repository based on its ID:
2424

2525
```hcl
2626
data "github_release" "example" {
@@ -31,7 +31,7 @@ data "github_release" "example" {
3131
}
3232
```
3333

34-
Finally, to retrieve a release based on it's tag:
34+
Finally, to retrieve a release based on its tag:
3535

3636
```hcl
3737
data "github_release" "example" {

0 commit comments

Comments
 (0)