Skip to content

Commit 94976ac

Browse files
mvanhornclaude
andcommitted
docs: mark private attribute as deprecated in github_repository
The private attribute has been deprecated in code since the introduction of visibility, but the docs didn't reflect this. Users see a Terraform deprecation warning with no explanation in the provider documentation. - Add DEPRECATED marker to private attribute description - Update GitHub Pages example to use visibility instead of private Fixes #3297 Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
1 parent 636eff4 commit 94976ac

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

website/docs/r/repository.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ resource "github_repository" "example" {
3636
name = "example"
3737
description = "My awesome web page"
3838
39-
private = false
39+
visibility = "public"
4040
4141
pages {
4242
source {
@@ -75,8 +75,8 @@ The following arguments are supported:
7575

7676
* `source_repo` - (Optional) The name of the repository to fork. Required when `fork` is `true`.
7777

78-
* `private` - (Optional) Set to `true` to create a private repository.
79-
Repositories are created as public (e.g. open source) by default.
78+
* `private` - (**DEPRECATED**) (Optional) Set to `true` to create a private repository.
79+
Repositories are created as public (e.g. open source) by default. Use `visibility` instead.
8080

8181
* `visibility` - (Optional) Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be `internal`. The `visibility` parameter overrides the `private` parameter.
8282

0 commit comments

Comments
 (0)