Skip to content

Commit

Permalink
Clarify GHA installation arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
sebasslash committed Dec 22, 2023
1 parent 8e8ac79 commit d902d85
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions website/docs/d/github_installation.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -15,29 +15,29 @@ Use this data source to get information about the Github App Installation.

```hcl
data "tfe_github_app_installation" "gha_installation" {
installation_id = 12345
installation_id = 12345678
}
```

### Finding a Github App Installation by its name

```hcl
data "tfe_github_app_installation" "gha_installation" {
name = "installation_name"
name = "github_username_or_organization"
}
```

## Argument Reference

The following arguments are supported. At least one of `name`, `installation_id` must be set.
The following arguments are supported. At least one of `name`, `installation_id` must be set.

* `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`.
* `name` - (Optional) Name of the Github user or organization account that installed the app.

* `installation_id` - (Optional) ID of the Github Installation as shown in Github.
* `name` - (Optional) Name of the Github Installation as shown in Github.

Must be one of: `installation_id` or `name`.

## Attributes Reference

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

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

0 comments on commit d902d85

Please sign in to comment.