Git Configuration
Learn how to configure Git for your project through the vercel.json file.The following configuration options can be used through a vercel.json
file like the Project Configuration.
Type: Object
of key branch identifier String
and value Boolean
, or Boolean
.
Specify the branches that will not trigger an auto-deployment when committing to them. Any non specified branch is true
by default.
Property's default value is true
. In case you want to turn auto-deployments off for every branch, property value must be set to false
.
{
"git": {
"deploymentEnabled": {
"main": false
}
}
}
Type: Boolean
.
When set to false
, Vercel for GitHub will not apply the alias upon merge.
{
"github": {
"autoAlias": false
}
}
Type: Boolean
.
When set to false, Vercel for GitHub will always build pushes in sequence without cancelling a build for the most recent commit.
{
"github": {
"autoJobCancelation": false
}
}
The github.silent
property has been deprecated in favor of the new settings in the dashboard, which allow for more fine-grained control over which comments appear on your connected Git repositories. These settings can be found in the Git section of your project's settings.
Type: Boolean
.
When set to true
, Vercel for GitHub will stop commenting on pull requests and commits.
{
"github": {
"silent": true
}
}
The github.enabled
property has been deprecated in favor of git.deploymentEnabled, which allows you to disable auto-deployments for your project.
Type: Boolean
.
When set to false
, Vercel for GitHub will not deploy the given project regardless of the GitHub app being installed.
{
"github": {
"enabled": false
}
}
Was this helpful?