Skip to content

Commit d902d85

Browse files
committed
Clarify GHA installation arguments
1 parent 8e8ac79 commit d902d85

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

website/docs/d/github_installation.html.markdown

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,29 @@ Use this data source to get information about the Github App Installation.
1515

1616
```hcl
1717
data "tfe_github_app_installation" "gha_installation" {
18-
installation_id = 12345
18+
installation_id = 12345678
1919
}
2020
```
2121

2222
### Finding a Github App Installation by its name
2323

2424
```hcl
2525
data "tfe_github_app_installation" "gha_installation" {
26-
name = "installation_name"
26+
name = "github_username_or_organization"
2727
}
2828
```
2929

3030
## Argument Reference
3131

32-
The following arguments are supported. At least one of `name`, `installation_id` must be set.
32+
The following arguments are supported. At least one of `name`, `installation_id` must be set.
33+
34+
* `installation_id` - (Optional) ID of the Github Installation. The installation ID can be found in the URL slug when visiting the installation's configuration page, e.g `https://github.com/settings/installations/12345678`.
35+
* `name` - (Optional) Name of the Github user or organization account that installed the app.
3336

34-
* `installation_id` - (Optional) ID of the Github Installation as shown in Github.
35-
* `name` - (Optional) Name of the Github Installation as shown in Github.
36-
3737
Must be one of: `installation_id` or `name`.
3838

3939
## Attributes Reference
4040

4141
In addition to all arguments above, the following attributes are exported:
4242

43-
* `id` - The internal ID of the Github Installation. This is different from the `installation_id`.
43+
* `id` - The internal ID of the Github Installation. This is different from the `installation_id`.

0 commit comments

Comments
 (0)