docs: mark private attribute as deprecated in github_repository#3298
docs: mark private attribute as deprecated in github_repository#3298mvanhorn wants to merge 1 commit intointegrations:mainfrom
Conversation
|
👋 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 |
|
@deiga - friendly ping. Approved a while back, no merge activity - let me know if anything else is needed. |
|
@mvanhorn your branch has conflicts. Please make sure that you're branch is directly mergeable before requesting work from maintainers. |
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>
94976ac to
1beca71
Compare
|
Apologies for the noise. Rebased on main, resolved the conflict, pushed as 1beca71. Should be directly mergeable now. |
|
@mvanhorn Please stop pinging people. We will get to your PR when there is capacity for it. We really appreciate that you are contributing and value that. At the same time it's important to remember that we are hobby maintainers. It is our free time we use here. |
|
Understood, sorry for the noise. I'll leave this one alone - no more pings. Appreciate the maintenance work, this is my last comment on it. |
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).