Skip to content

Commit

Permalink
style(js): Minor formatting consistency cleanup in remove-preview-dep…
Browse files Browse the repository at this point in the history
…loyments (#7371)
  • Loading branch information
evanpurkhiser authored Jul 10, 2023
1 parent 7aca7eb commit d3b57af
Showing 1 changed file with 89 additions and 29 deletions.
118 changes: 89 additions & 29 deletions scripts/remove-preview-deployments.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,64 +32,116 @@ if (!VERCEL_PROJECT_ID) {
throw new Error('VERCEL_PROJECT_ID is not set');
}

/** This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data. */
/**
* This object contains information related to the pagination of the current
* request, including the necessary parameters to get the next or previous page
* of data.
*/
interface Pagination {
/** Amount of items in the current page. */
/**
* Amount of items in the current page.
*/
count: number;
/** Timestamp that must be used to request the next page. */
/**
* Timestamp that must be used to request the next page.
*/
next: number | null;
/** Timestamp that must be used to request the previous page. */
/**
* Timestamp that must be used to request the previous page.
*/
prev: number | null;
}

interface Response {
deployments: {
/** Timestamp of when the deployment got created. */
/**
* Timestamp of when the deployment got created.
* */
created: number;
/** Metadata information of the user who created the deployment. */
/**
* Metadata information of the user who created the deployment.
*/
creator: {
/** The unique identifier of the user. */
/**
* The unique identifier of the user.
*/
uid: string;
/** The email address of the user. */
/**
* The email address of the user.
*/
email?: string;
/** The GitHub login of the user. */
/**
* The GitHub login of the user.
*/
githubLogin?: string;
/** The GitLab login of the user. */
/**
* The GitLab login of the user.
*/
gitlabLogin?: string;
/** The username of the user. */
/**
* The username of the user.
*/
username?: string;
};
/** Vercel URL to inspect the deployment. */
/**
* Vercel URL to inspect the deployment.
*/
inspectorUrl: string | null;
/** The name of the deployment. */
/**
* The name of the deployment.
*/
name: string;
/** The type of the deployment. */
/**
* The type of the deployment.
*/
type: 'LAMBDAS';
/** The unique identifier of the deployment. */
/**
* The unique identifier of the deployment.
*/
uid: string;
/** The URL of the deployment. */
/**
* The URL of the deployment.
*/
url: string;
aliasAssigned?: (number | boolean) | null;
/** An error object in case aliasing of the deployment failed. */
/**
* An error object in case aliasing of the deployment failed.
*/
aliasError?: {
code: string;
message: string;
} | null;
/** Timestamp of when the deployment started building at. */
/**
* Timestamp of when the deployment started building at.
*/
buildingAt?: number;
/** Conclusion for checks */
/**
* Conclusion for checks
*/
checksConclusion?: 'succeeded' | 'failed' | 'skipped' | 'canceled';
/** State of all registered checks */
/**
* State of all registered checks
*/
checksState?: 'registered' | 'running' | 'completed';
/** The ID of Vercel Connect configuration used for this deployment */
/**
* The ID of Vercel Connect configuration used for this deployment
*/
connectConfigurationId?: string;
/** Timestamp of when the deployment got created. */
/**
* Timestamp of when the deployment got created.
*/
createdAt?: number;
/** Deployment can be used for instant rollback */
/**
* Deployment can be used for instant rollback
*/
isRollbackCandidate?: boolean | null;
/** An object containing the deployment's metadata */
/**
* An object containing the deployment's metadata
*/
meta?: {[key: string]: string};
/** The project settings which was used for this deployment */
/**
* The project settings which was used for this deployment
*/
projectSettings?: {
buildCommand?: string | null;
commandForIgnoringBuildStep?: string | null;
Expand Down Expand Up @@ -151,13 +203,21 @@ interface Response {
skipGitConnectDuringLink?: boolean;
sourceFilesOutsideRootDirectory?: boolean;
};
/** Timestamp of when the deployment got ready. */
/**
* Timestamp of when the deployment got ready.
*/
ready?: number;
/** The source of the deployment. */
/**
* The source of the deployment.
*/
source?: 'cli' | 'git' | 'import' | 'import/repo' | 'clone/repo';
/** In which state is the deployment. */
/**
* In which state is the deployment.
*/
state?: 'BUILDING' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY' | 'CANCELED';
/** On which environment has the deployment been deployed to. */
/**
* On which environment has the deployment been deployed to.
*/
target?: ('production' | 'staging') | null;
}[];
pagination: Pagination;
Expand Down

1 comment on commit d3b57af

@vercel
Copy link

@vercel vercel bot commented on d3b57af Jul 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

sentry-docs – ./

docs.sentry.io
sentry-docs.sentry.dev
sentry-docs-git-master.sentry.dev

Please sign in to comment.