Skip to content

Commit a31fc9f

Browse files
committed
Updates docs
Signed-off-by: Timo Sand <timo.sand@f-secure.com>
1 parent b289a5d commit a31fc9f

1 file changed

Lines changed: 14 additions & 8 deletions

File tree

website/docs/r/branch_default.html.markdown

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ description: |-
99

1010
Provides a GitHub branch default resource.
1111

12-
This resource allows you to set the default branch for a given repository.
12+
This resource allows you to set the default branch for a given repository.
1313

14-
Note that use of this resource is incompatible with the `default_branch` option of the `github_repository` resource. Using both will result in plans always showing a diff.
14+
Note that use of this resource is incompatible with the `default_branch` option of the `github_repository` resource. Using both will result in plans always showing a diff.
1515

1616
## Example Usage
1717

@@ -55,14 +55,20 @@ resource "github_branch_default" "default"{
5555

5656
The following arguments are supported:
5757

58-
* `repository` - (Required) The GitHub repository
59-
* `branch` - (Required) The branch (e.g. `main`)
60-
* `rename` - (Optional) Indicate if it should rename the branch rather than use an existing branch. Defaults to `false`.
58+
- `repository` - (Required) The GitHub repository
59+
- `branch` - (Required) The branch (e.g. `main`)
60+
- `rename` - (Optional) Indicate if it should rename the branch rather than use an existing branch. Defaults to `false`.
61+
62+
## Attribute Reference
63+
64+
The following attributes are exported:
65+
66+
- `repository_id` - The GitHub repository ID.
6167

6268
## Import
6369

64-
GitHub Branch Defaults can be imported using an ID made up of `repository`, e.g.
70+
GitHub Branch Defaults can be imported using the repository name, e.g.
6571

66-
```
67-
$ terraform import github_branch_default.branch_default my-repo
72+
```text
73+
terraform import github_branch_default.branch_default my-repo
6874
```

0 commit comments

Comments
 (0)