Skip to content

docs: Fix default permission value for team block in repository_collaborators#3318

Open
sinsoku wants to merge 1 commit intointegrations:mainfrom
sinsoku:docs-fix-team-permission-default
Open

docs: Fix default permission value for team block in repository_collaborators#3318
sinsoku wants to merge 1 commit intointegrations:mainfrom
sinsoku:docs-fix-team-permission-default

Conversation

@sinsoku
Copy link
Copy Markdown

@sinsoku sinsoku commented Apr 2, 2026

Before the change?

  • The team block's permission field documented "Defaults to pull" but the implementation uses push (Default: "push" in schema definition).
  • "Must be push for personal repositories" was documented, but teams are only applicable to organization repositories.

"team": {
Type: schema.TypeSet,
Optional: true,
Description: "List of teams.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"permission": {
Type: schema.TypeString,
Optional: true,
Default: "push",
},

After the change?

  • Updated to "Defaults to push" to match the implementation.
  • Removed "Must be push for personal repositories" since teams are only applicable to organization repositories.

Pull request checklist

  • [ ] Schema migrations have been created if needed (example)
  • [ ] Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

…borators

The team block's permission description stated "Defaults to pull" but
the implementation uses "push" (Default: "push" in schema definition).
Update the documentation to match the implementation. Also remove
"Must be push for personal repositories" as teams are only applicable
to organization repositories.
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 2, 2026

👋 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 Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

@github-actions github-actions bot added the Type: Documentation Improvements or additions to documentation label Apr 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant