Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation for dismissal_restrictions #569

Merged

Conversation

woodb
Copy link
Contributor

@woodb woodb commented Oct 15, 2020

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.

This differs from the parameter name dismissal_restrictions as defined: https://github.com/terraform-providers/terraform-provider-github/blob/9c532df8193907ff250481be9060290f65bedd66/github/util_v4_consts.go#L15

This 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 was dismissal_restrictions rather than dismissal_actors.

Relates to #337 and comments in #566

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 ghost added size/XS Type: Documentation Improvements or additions to documentation labels Oct 15, 2020
@woodb
Copy link
Contributor Author

woodb commented Oct 15, 2020

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.

@jcudit
Copy link
Contributor

jcudit commented Oct 17, 2020

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.

@woodb
Copy link
Contributor Author

woodb commented Oct 19, 2020

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 #566 before proceeding here. Will keep an 👀 out for suggested next steps.

Sounds good, thanks @jcudit!

@jcudit jcudit merged commit 6096068 into integrations:master Nov 4, 2020
@jcudit jcudit added this to the v4.0.0 milestone Nov 4, 2020
@woodb woodb deleted the fix-docs-branch-protection-dismissal branch November 6, 2020 15:51
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
Labels
size/XS Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants