Fix documentation for dismissal_restrictions
#569
Merged
Conversation
This file contains 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
In the current documentation for the resource `github_branch_protection`, it is noted under `required_pull_request_reviews` that: > `dismissal_actors`: (Optional) The list of actor IDs with dismissal access. The correct parameter name is `dismissal_restrictions` in `github/util_v4_consts.go`.
ghost
added
size/XS
Type: Documentation
|
I couldn't find contributing documentation, so I'm not sure why so many of these checks are failing. Please let me know how I can help resolve those. |
|
Thanks for this. All these failing checks are definitely confusing. Contributing docs are a great idea and will aim to follow up. Lets get some more feedback in https://github.com/terraform-providers/terraform-provider-github/issues/566 before proceeding here. Will keep an 👀 out for suggested next steps. |
jcudit
approved these changes
Nov 4, 2020
kfcampbell
pushed a commit
to kfcampbell/terraform-provider-github
that referenced
this pull request
Jul 26, 2022
In the current documentation for the resource `github_branch_protection`, it is noted under `required_pull_request_reviews` that: > `dismissal_actors`: (Optional) The list of actor IDs with dismissal access. The correct parameter name is `dismissal_restrictions` in `github/util_v4_consts.go`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In the current documentation for the resource
github_branch_protection, it is noted underrequired_pull_request_reviewsthat:This differs from the parameter name
dismissal_restrictionsas defined: https://github.com/terraform-providers/terraform-provider-github/blob/9c532df8193907ff250481be9060290f65bedd66/github/util_v4_consts.go#L15This PR updates the documentation to reflect the parameter name as defined in
github/util_v4_consts.go, under the assumption that the intended parameter name wasdismissal_restrictionsrather thandismissal_actors.Relates to #337 and comments in #566