GitProviderOptions
August 10, 2026 ยท View on GitHub
Example Usage
import { GitProviderOptions } from "@vercel/sdk/models/blockhistoryroute.js";
let value: GitProviderOptions = {
createDeployments: "enabled",
};
Fields
| Field | Type | Required | Description |
|---|---|---|---|
createDeployments | models.CreateProjectCreateDeployments | :heavy_check_mark: | Whether the Vercel bot should automatically create GitHub deployments https://docs.github.com/en/rest/deployments/deployments#about-deployments NOTE: repository-dispatch events should be used instead |
disableRepositoryDispatchEvents | boolean | :heavy_minus_sign: | Whether the Vercel bot should not automatically create GitHub repository-dispatch events on deployment events. https://vercel.com/docs/git/vercel-for-github#repository-dispatch-events - true: disable repository-dispatch events for this project (explicit override of the team setting). - false: enable repository-dispatch events for this project (explicit override of the team setting). - absent: inherit from team.disableRepositoryDispatchEvents. |
requireVerifiedCommits | boolean | :heavy_minus_sign: | Whether the project requires commits to be signed & verified before deployments will be created. - true: require verified commits for this project (explicit override of the team setting). - false: do not require verified commits (explicit override of the team setting). - absent: inherit from team.requireVerifiedCommits. |
gitCommitStatus | boolean | :heavy_minus_sign: | Whether Vercel should post commit statuses for this project. When omitted, commit statuses remain enabled. |
consolidatedGitCommitStatus | models.CreateProjectConsolidatedGitCommitStatus | :heavy_minus_sign: | Configuration for consolidated git commit status reporting. When enabled, Vercel will post a single consolidated commit status instead of individual statuses for each deployment. |