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
This PR adds support on the `vercel_project` resource for...
** inhales **
- Preview Comments
- Git Comments
- Auto-assigning custom production domains (or disabling it)
- Git LFS
- Automatic function failover
- Customer Success Code Visibility
- Git Fork Protection
- Prioritising production builds
- Directory listing (wtf even is this)
- Skew protection
There's a lot of more advanced features among this set, so I think this
is a nice one to land.
Copy file name to clipboardExpand all lines: docs/data-sources/project.md
+20Lines changed: 20 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -42,20 +42,31 @@ output "project_id" {
42
42
43
43
### Read-Only
44
44
45
+
-`auto_assign_custom_domains` (Boolean) Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to `true`
45
46
-`automatically_expose_system_environment_variables` (Boolean) Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
46
47
-`build_command` (String) The build command for this project. If omitted, this value will be automatically detected.
48
+
-`customer_success_code_visibility` (Boolean) Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
47
49
-`dev_command` (String) The dev command for this project. If omitted, this value will be automatically detected.
50
+
-`directory_listing` (Boolean) If no index file is present within a directory, the directory contents will be displayed.
48
51
-`environment` (Attributes Set) A list of environment variables that should be configured for the project. (see [below for nested schema](#nestedatt--environment))
49
52
-`framework` (String) The framework that is being used for this project. If omitted, no framework is selected.
53
+
-`function_failover` (Boolean) Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
54
+
-`git_comments` (Attributes) Configuration for Git Comments. (see [below for nested schema](#nestedatt--git_comments))
55
+
-`git_fork_protection` (Boolean) Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json.
56
+
-`git_lfs` (Boolean) Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
50
57
-`git_repository` (Attributes) The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for [Github](https://vercel.com/docs/concepts/git/vercel-for-github), [Gitlab](https://vercel.com/docs/concepts/git/vercel-for-gitlab) or [Bitbucket](https://vercel.com/docs/concepts/git/vercel-for-bitbucket) plugins to be installed. (see [below for nested schema](#nestedatt--git_repository))
51
58
-`id` (String) The ID of this resource.
52
59
-`ignore_command` (String) When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
53
60
-`install_command` (String) The install command for this project. If omitted, this value will be automatically detected.
54
61
-`output_directory` (String) The output directory of the project. When null is used this value will be automatically detected.
55
62
-`password_protection` (Attributes) Ensures visitors of your Preview Deployments must enter a password in order to gain access. (see [below for nested schema](#nestedatt--password_protection))
63
+
-`preview_comments` (Boolean) Whether comments are enabled on your Preview Deployments.
64
+
-`prioritise_production_builds` (Boolean) If enabled, builds for the Production environment will be prioritized over Preview environments.
65
+
-`protection_bypass_for_automation` (Boolean) Allows automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named `x-vercel-protection-bypass`.
56
66
-`public_source` (Boolean) Specifies whether the source code and logs of the deployments for this project should be public or not.
57
67
-`root_directory` (String) The name of a directory or relative path to the source code of your project. When null is used it will default to the project root.
58
68
-`serverless_function_region` (String) The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see [Vercel's documentation](https://vercel.com/docs/concepts/edge-network/regions) for a full list of regions.
69
+
-`skew_protection` (String) Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
59
70
-`trusted_ips` (Attributes) Ensures only visitors from an allowed IP address can access your deployment. (see [below for nested schema](#nestedatt--trusted_ips))
60
71
-`vercel_authentication` (Attributes) Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team. (see [below for nested schema](#nestedatt--vercel_authentication))
61
72
@@ -72,6 +83,15 @@ Read-Only:
72
83
-`value` (String) The value of the environment variable.
73
84
74
85
86
+
<aid="nestedatt--git_comments"></a>
87
+
### Nested Schema for `git_comments`
88
+
89
+
Required:
90
+
91
+
-`on_commit` (Boolean) Whether Commit comments are enabled
92
+
-`on_pull_request` (Boolean) Whether Pull Request comments are enabled
-`auto_assign_custom_domains` (Boolean) Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to `true`
58
59
-`automatically_expose_system_environment_variables` (Boolean) Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
59
60
-`build_command` (String) The build command for this project. If omitted, this value will be automatically detected.
61
+
-`customer_success_code_visibility` (Boolean) Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
60
62
-`dev_command` (String) The dev command for this project. If omitted, this value will be automatically detected.
63
+
-`directory_listing` (Boolean) If no index file is present within a directory, the directory contents will be displayed.
61
64
-`environment` (Attributes Set) A set of Environment Variables that should be configured for the project. (see [below for nested schema](#nestedatt--environment))
62
65
-`framework` (String) The framework that is being used for this project. If omitted, no framework is selected.
66
+
-`function_failover` (Boolean) Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
67
+
-`git_comments` (Attributes) Configuration for Git Comments. (see [below for nested schema](#nestedatt--git_comments))
68
+
-`git_fork_protection` (Boolean) Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json. Defaults to `true`.
69
+
-`git_lfs` (Boolean) Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
63
70
-`git_repository` (Attributes) The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for [Github](https://vercel.com/docs/concepts/git/vercel-for-github), [Gitlab](https://vercel.com/docs/concepts/git/vercel-for-gitlab) or [Bitbucket](https://vercel.com/docs/concepts/git/vercel-for-bitbucket) plugins to be installed. (see [below for nested schema](#nestedatt--git_repository))
64
71
-`ignore_command` (String) When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
65
72
-`install_command` (String) The install command for this project. If omitted, this value will be automatically detected.
66
73
-`output_directory` (String) The output directory of the project. If omitted, this value will be automatically detected.
67
74
-`password_protection` (Attributes) Ensures visitors of your Preview Deployments must enter a password in order to gain access. (see [below for nested schema](#nestedatt--password_protection))
75
+
-`preview_comments` (Boolean) Whether to enable comments on your Preview Deployments. If omitted, comments are controlled at the team level (default behaviour).
76
+
-`prioritise_production_builds` (Boolean) If enabled, builds for the Production environment will be prioritized over Preview environments.
68
77
-`protection_bypass_for_automation` (Boolean) Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named `x-vercel-protection-bypass` with a value of the `password_protection_for_automation_secret` field.
69
78
-`public_source` (Boolean) By default, visitors to the `/_logs` and `/_src` paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting `public_source` to `true` disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
70
79
-`root_directory` (String) The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
71
80
-`serverless_function_region` (String) The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see [Vercel's documentation](https://vercel.com/docs/concepts/edge-network/regions) for a full list of regions.
81
+
-`skew_protection` (String) Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
72
82
-`team_id` (String) The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
73
83
-`trusted_ips` (Attributes) Ensures only visitors from an allowed IP address can access your deployment. (see [below for nested schema](#nestedatt--trusted_ips))
74
84
-`vercel_authentication` (Attributes) Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team. (see [below for nested schema](#nestedatt--vercel_authentication))
@@ -97,6 +107,15 @@ Read-Only:
97
107
-`id` (String) The ID of the Environment Variable.
98
108
99
109
110
+
<aid="nestedatt--git_comments"></a>
111
+
### Nested Schema for `git_comments`
112
+
113
+
Required:
114
+
115
+
-`on_commit` (Boolean) Whether Commit comments are enabled
116
+
-`on_pull_request` (Boolean) Whether Pull Request comments are enabled
0 commit comments