Skip to content

Commit 458f672

Browse files
committed
Update docs
Signed-off-by: Timo Sand <timo.sand@f-secure.com>
1 parent 4f71413 commit 458f672

4 files changed

Lines changed: 7 additions & 5 deletions

File tree

docs/resources/repository_autolink_reference.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ resource "github_repository" "repo" {
1515
name = "my-repo"
1616
description = "GitHub repo managed by Terraform"
1717
18-
private = false
18+
visibility = "public"
1919
}
2020
2121
resource "github_repository_autolink_reference" "autolink" {
@@ -31,7 +31,7 @@ resource "github_repository_autolink_reference" "autolink" {
3131

3232
The following arguments are supported:
3333

34-
- `repository` - (Required) The repository of the autolink reference.
34+
- `repository` - (Required) The repository name. If the repository is renamed, the autolink reference will be updated in-place rather than recreated.
3535

3636
- `key_prefix` - (Required) This prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.
3737

@@ -44,6 +44,7 @@ The following arguments are supported:
4444
The following additional attributes are exported:
4545

4646
- `etag` - An etag representing the autolink reference object.
47+
- `repository_id` - The ID of the repository.
4748

4849
## Import
4950

examples/resources/repository_autolink_reference/example_1.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ resource "github_repository" "repo" {
22
name = "my-repo"
33
description = "GitHub repo managed by Terraform"
44

5-
private = false
5+
visibility = "public"
66
}
77

88
resource "github_repository_autolink_reference" "autolink" {

github/resource_github_repository_autolink_reference.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ func resourceGithubRepositoryAutolinkReference() *schema.Resource {
7575
"repository": {
7676
Type: schema.TypeString,
7777
Required: true,
78-
Description: "The repository name",
78+
Description: "The repository name. If the repository is renamed, the autolink reference will be updated in-place rather than recreated.",
7979
},
8080
"repository_id": {
8181
Type: schema.TypeInt,

templates/resources/repository_autolink_reference.md.tmpl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This resource allows you to create and manage an autolink reference for a single
1616

1717
The following arguments are supported:
1818

19-
- `repository` - (Required) The repository of the autolink reference.
19+
- `repository` - (Required) The repository name. If the repository is renamed, the autolink reference will be updated in-place rather than recreated.
2020

2121
- `key_prefix` - (Required) This prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.
2222

@@ -29,6 +29,7 @@ The following arguments are supported:
2929
The following additional attributes are exported:
3030

3131
- `etag` - An etag representing the autolink reference object.
32+
- `repository_id` - The ID of the repository.
3233

3334
## Import
3435

0 commit comments

Comments
 (0)