You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/r/branch_protection.html.markdown
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ The following arguments are supported:
92
92
*`dismiss_stale_reviews`: (Optional) Dismiss approved reviews automatically when a new commit is pushed. Defaults to `false`.
93
93
*`dismissal_restrictions`: (Optional) The list of actor IDs with dismissal access.
94
94
*`require_code_owner_reviews`: (Optional) Require an approved review in pull requests including files with a designated code owner. Defaults to `false`.
95
-
*`required_approving_review_count`: (Optional) Require x number of approvals to satisfy branch protection requirements. If this is specified it must be a number between 1-6. This requirement matches Github's API, see the upstream [documentation](https://developer.github.com/v3/repos/branches/#parameters-1) for more information.
95
+
*`required_approving_review_count`: (Optional) Require x number of approvals to satisfy branch protection requirements. If this is specified it must be a number between 1-6. This requirement matches GitHub's API, see the upstream [documentation](https://developer.github.com/v3/repos/branches/#parameters-1) for more information.
Copy file name to clipboardExpand all lines: website/docs/r/branch_protection_v3.html.markdown
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ description: |-
7
7
8
8
# github\_branch\_protection
9
9
10
-
Protects a GitHub branch.
10
+
Protects a GitHub branch.
11
11
12
12
The `github_branch_protection` resource has moved to the GraphQL API, while this resource will continue to leverage the REST API.
13
13
@@ -93,7 +93,7 @@ The following arguments are supported:
93
93
*`dismissal_teams`: (Optional) The list of team slugs with dismissal access.
94
94
Always use `slug` of the team, **not** its name. Each team already **has** to have access to the repository.
95
95
*`require_code_owner_reviews`: (Optional) Require an approved review in pull requests including files with a designated code owner. Defaults to `false`.
96
-
*`required_approving_review_count`: (Optional) Require x number of approvals to satisfy branch protection requirements. If this is specified it must be a number between 1-6. This requirement matches Github's API, see the upstream [documentation](https://developer.github.com/v3/repos/branches/#parameters-1) for more information.
96
+
*`required_approving_review_count`: (Optional) Require x number of approvals to satisfy branch protection requirements. If this is specified it must be a number between 1-6. This requirement matches GitHub's API, see the upstream [documentation](https://developer.github.com/v3/repos/branches/#parameters-1) for more information.
@@ -56,7 +56,7 @@ The following arguments are supported:
56
56
57
57
*`private` - (Optional) Set to `true` to create a private repository.
58
58
Repositories are created as public (e.g. open source) by default.
59
-
59
+
60
60
*`visibility` - (Optional) Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be `internal`. The `visibility` parameter overrides the `private` parameter.
61
61
62
62
*`has_issues` - (Optional) Set to `true` to enable the GitHub Issues features
@@ -66,7 +66,7 @@ The following arguments are supported:
66
66
67
67
*`has_wiki` - (Optional) Set to `true` to enable the GitHub Wiki features on
68
68
the repository.
69
-
69
+
70
70
*`is_template` - (Optional) Set to `true` to tell GitHub that this is a template repository.
71
71
72
72
*`allow_merge_commit` - (Optional) Set to `false` to disable merge commits on the repository.
@@ -93,23 +93,23 @@ initial repository creation and create the target branch inside of the repositor
93
93
94
94
*`archive_on_destroy` - (Optional) Set to `true` to archive the repository instead of deleting on destroy.
95
95
96
-
*`pages` - (Optional) The repository's Github Pages configuration. See [Github Pages Configuration](#github-pages-configuration) below for details.
96
+
*`pages` - (Optional) The repository's GitHub Pages configuration. See [GitHub Pages Configuration](#github-pages-configuration) below for details.
97
97
98
98
*`topics` - (Optional) The list of topics of the repository.
99
99
100
100
*`template` - (Optional) Use a template repository to create this resource. See [Template Repositories](#template-repositories) below for details.
101
101
102
-
*`vulnerability_alerts` (Optional) - Set to `true` to enable security alerts for vulnerable dependencies. Enabling requires alerts to be enabled on the owner level. (Note for importing: GitHub enables the alerts on public repos but disables them on private repos by default.) See [GitHub Documentation](https://help.github.com/en/github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies) for details.
102
+
*`vulnerability_alerts` (Optional) - Set to `true` to enable security alerts for vulnerable dependencies. Enabling requires alerts to be enabled on the owner level. (Note for importing: GitHub enables the alerts on public repos but disables them on private repos by default.) See [GitHub Documentation](https://help.github.com/en/github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies) for details.
103
103
104
-
### Github Pages Configuration
104
+
### GitHub Pages Configuration
105
105
106
106
The `pages` block supports the following:
107
107
108
-
*`source` - (Required) The source branch and directory for the rendered Pages site. See [Github Pages Source](#github-pages-source) below for details.
108
+
*`source` - (Required) The source branch and directory for the rendered Pages site. See [GitHub Pages Source](#github-pages-source) below for details.
109
109
110
110
*`cname` - (Optional) The custom domain for the repository. This can only be set after the repository has been created.
111
111
112
-
#### Github Pages Source ####
112
+
#### GitHub Pages Source ####
113
113
114
114
The `source` block supports the following:
115
115
@@ -144,12 +144,12 @@ The following additional attributes are exported:
144
144
145
145
*`node_id` - GraphQL global node id for use with v4 API
146
146
147
-
*`repo_id` - Github ID for the repository
147
+
*`repo_id` - GitHub ID for the repository
148
148
149
-
*`pages` - The block consisting of the repository's Github Pages configuration with the following additional attributes:
150
-
*`custom_404` - Whether the rendered Github Pages site has a custom 404 page.
151
-
*`html_url` - The absolute URL (including scheme) of the rendered Github Pages site e.g. `https://username.github.io`.
152
-
*`status` - The Github Pages site's build status e.g. `building` or `built`.
149
+
*`pages` - The block consisting of the repository's GitHub Pages configuration with the following additional attributes:
150
+
*`custom_404` - Whether the rendered GitHub Pages site has a custom 404 page.
151
+
*`html_url` - The absolute URL (including scheme) of the rendered GitHub Pages site e.g. `https://username.github.io`.
152
+
*`status` - The GitHub Pages site's build status e.g. `building` or `built`.
0 commit comments