Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
40 lines
1.4 KiB
Plaintext
40 lines
1.4 KiB
Plaintext
import { RestCommand } from "../../types.cjs";
|
|
|
|
//#region src/rest/commands/utils/deployment.d.ts
|
|
interface TriggerDeploymentResult {
|
|
id: string;
|
|
external_id: string;
|
|
project: string;
|
|
target: string;
|
|
status: 'building' | 'ready' | 'error' | 'canceled';
|
|
url?: string;
|
|
date_created: string;
|
|
}
|
|
interface TriggerDeploymentOptions {
|
|
preview?: boolean;
|
|
clear_cache?: boolean;
|
|
}
|
|
/**
|
|
* Trigger a new deployment for a project.
|
|
*
|
|
* @param provider The provider type (e.g. 'vercel')
|
|
* @param projectId The project ID to deploy
|
|
* @param options Deployment options (preview, clear_cache)
|
|
*
|
|
* @returns The deployment trigger result with deployment ID and status.
|
|
* @throws Will throw if provider or projectId is empty
|
|
*/
|
|
declare const triggerDeployment: <Schema>(provider: string, projectId: string, options?: TriggerDeploymentOptions) => RestCommand<TriggerDeploymentResult, Schema>;
|
|
/**
|
|
* Cancel a deployment run.
|
|
*
|
|
* @param provider The provider type (e.g. 'vercel')
|
|
* @param runId The run ID to cancel
|
|
*
|
|
* @returns The updated run object.
|
|
* @throws Will throw if provider or runId is empty
|
|
*/
|
|
declare const cancelDeployment: <Schema>(provider: string, runId: string) => RestCommand<TriggerDeploymentResult, Schema>;
|
|
//#endregion
|
|
export { TriggerDeploymentOptions, TriggerDeploymentResult, cancelDeployment, triggerDeployment };
|
|
//# sourceMappingURL=deployment.d.cts.map |