docs: mark private attribute as deprecated in github_repository#3298
Open
mvanhorn wants to merge 1 commit intointegrations:mainfrom
Open
docs: mark private attribute as deprecated in github_repository#3298mvanhorn wants to merge 1 commit intointegrations:mainfrom
mvanhorn wants to merge 1 commit intointegrations:mainfrom
Conversation
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 integrations#3297 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with |
github-actions
bot
added
the
Type: Documentation
deiga
approved these changes
Mar 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Marks the
privateattribute as deprecated in thegithub_repositoryresource docs and updates the GitHub Pages example to usevisibilityinstead.Why this matters
The
privateattribute triggers a Terraform deprecation warning at plan time ("use visibility instead"), but the docs page doesn't mention this deprecation. Users see the warning with no guidance in the documentation.The Go source at
resource_github_repository.go:60hasDeprecated: "use visibility instead"on theprivateschema field, but this was never reflected in the markdown docs.Changes
website/docs/r/repository.html.markdown:(**DEPRECATED**)marker toprivateattribute description, with "Usevisibilityinstead." guidanceprivate = falsewithvisibility = "public"in the GitHub Pages example (the first example already usesvisibility)Testing
Verified the change matches the deprecation patterns already used for
has_downloads(line 117) andignore_vulnerability_alerts_during_read(line 145) in the same docs file.Fixes #3297
This contribution was developed with AI assistance (Claude Code).