GitMetadata

Populates initial git metadata for different git providers.

Example Usage

import { GitMetadata } from "@vercel/sdk/models/createdeploymentmissingdeploymentstype.js";

let value: GitMetadata = {
  remoteUrl: "https://github.com/vercel/next.js",
  commitAuthorName: "kyliau",
  commitAuthorEmail: "kyliau@example.com",
  commitMessage:
    "add method to measure Interaction to Next Paint (INP) (#36490)",
  commitRef: "main",
  commitSha: "dc36199b2234c6586ebe05ec94078a895c707e29",
  dirty: true,
  ci: true,
  ciType: "github-actions",
  ciGitProviderUsername: "rauchg",
  ciGitRepoVisibility: "private",
  rootDirectory: "apps/web",
};

Fields

Field	Type	Required	Description	Example
remoteUrl	string	:heavy_minus_sign:	The git repository's remote origin url	https://github.com/vercel/next.js
commitAuthorName	string	:heavy_minus_sign:	The name of the author of the commit	kyliau
commitAuthorEmail	string	:heavy_minus_sign:	The email of the author of the commit	kyliau@example.com
commitMessage	string	:heavy_minus_sign:	The commit message	add method to measure Interaction to Next Paint (INP) (#36490)
commitRef	string	:heavy_minus_sign:	The branch on which the commit was made	main
commitSha	string	:heavy_minus_sign:	The hash of the commit	dc36199b2234c6586ebe05ec94078a895c707e29
dirty	boolean	:heavy_minus_sign:	Whether or not there have been modifications to the working tree since the latest commit	true
ci	boolean	:heavy_minus_sign:	True if process.env.CI was set when deploying	true
ciType	string	:heavy_minus_sign:	The type of CI system used	github-actions
ciGitProviderUsername	string	:heavy_minus_sign:	The username used for the Git Provider (e.g. GitHub) if their CI (e.g. GitHub Actions) was used, if available	rauchg
ciGitRepoVisibility	string	:heavy_minus_sign:	The visibility of the Git repository if their CI (e.g. GitHub Actions) was used, if available	private
rootDirectory	string	:heavy_minus_sign:	Path of the deployed directory relative to the detected git repository root. Empty string when deploying from the repository root.	apps/web