1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. DeploymentSettingsGitHubRequest

DeploymentSettingsGitHubRequest

    DeploymentSettingsGitHubRequest is the request body for updating GitHub-specific deployment settings.

    Properties

    • repository string optional
      The GitHub repository in the format owner/repo.
    • deployCommits boolean optional
      Whether to automatically deploy commits pushed to the target branch.
    • previewPullRequests boolean optional
      Whether to automatically preview pull requests.
    • pullRequestTemplate boolean required
      Whether to use a pull request template for deployment previews.
    • deployPullRequest integer optional
      The pull request number to deploy, if targeting a specific pull request.
    • paths array[string] optional
      The list of file paths to filter deployment triggers.
    • installationId string optional
      The GitHub App installation ID.