@catladder/cli 2.9.2 → 2.10.0

package/dist/pipeline/src/deploy/cloudRun/utils/jobName.js.map

@@ -1 +1 @@
-{"version":3,"file":"jobName.js","sourceRoot":"","sources":["../../../../../../../pipeline/src/deploy/cloudRun/utils/jobName.ts"],"names":[],"mappings":";;;AAEO,MAAM,kBAAkB,GAAG,CAChC,WAAmC,EACnC,OAAe,EACS,EAAE,CAC1B,WAAW,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;AAJnD,QAAA,kBAAkB,sBAIiC"}
+{"version":3,"file":"jobName.js","sourceRoot":"","sources":["../../../../../../../pipeline/src/deploy/cloudRun/utils/jobName.ts"],"names":[],"mappings":";;;AAGO,MAAM,kBAAkB,GAAG,CAChC,WAAmC,EACnC,OAA+B,EACP,EAAE,CAC1B,WAAW,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;AAJnD,QAAA,kBAAkB,sBAIiC;AAEzD,MAAM,cAAc,GAAG,CAC5B,OAAyB,EACzB,IAA4B,EAC5B,EAAE,CAAC,IAAA,0BAAkB,EAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AAH/C,QAAA,cAAc,kBAGiC;AAErD,MAAM,wBAAwB,GAAG,CACtC,WAAmC,EACnC,aAAqB,EACG,EAAE,CAC1B,WAAW,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;AAJzD,QAAA,wBAAwB,4BAIiC;AAE/D,MAAM,oBAAoB,GAAG,CAAC,OAAyB,EAAE,IAAY,EAAE,EAAE,CAC9E,IAAA,gCAAwB,EAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AADlD,QAAA,oBAAoB,wBAC8B"}

package/dist/pipeline/src/deploy/types/googleCloudRun.d.ts

@@ -137,6 +137,10 @@ export type DeployConfigCloudRunJobBase = {
      * command
      */
     command: string | string[];
+    /**
+     * optional, specify args. Those get overwritten by job executions if specified there
+     */
+    args?: string[];
     /**
      * custom image to use. Defaults to the image from the build
      */
@@ -166,24 +170,38 @@ type DayOfMonth = string;
 type DayOfWeek = string;
 type Month = string;
 export type DeployConfigCloudRunJobWithSchedule = DeployConfigCloudRunJobBase & {
+    /**
+     * @deprecated use `execute` instead
+     */
     when: "schedule";
+    /**
+     * @deprecated use `run` instead
+     */
     schedule: `${Minute} ${Hour} ${DayOfMonth} ${Month} ${DayOfWeek}`;
     /**
      * Max number of retries of the cloud scheduler.
      * Note: the task itself is never retried.
      *
      * defaults to 0 (no retries)
+     *
+     *  @deprecated use `run` instead
      */
     maxRetryAttempts?: 0 | 1 | 2 | 3 | 4 | 5;
 };
 export type DeployConfigCloudRunJobNormal = DeployConfigCloudRunJobBase & {
-    when: "manual" | "preDeploy" | "postDeploy" | "preStop" | "postStop";
     /**
      * wait for completion of the job on preDeploy and postDeploy
      *
      * has no effect on preStop and postStop (which always wait for completion)
+     *
+     *
+     * @deprecated use `run` instead
      */
     waitForCompletion?: boolean;
+    /**
+     * @deprecated use `run` instead
+     */
+    when?: "manual" | "preDeploy" | "postDeploy" | "preStop" | "postStop";
 };
 export type DeployConfigCloudRunWithVolumes = {
     /**
@@ -227,6 +245,10 @@ export type DeployConfigCloudRun = {
      * add cloudSql
      */
     cloudSql?: DeployConfigCloudRunCloudSql | false;
+    /**
+     * execute jobs on deploy or execute jobs and http requests on a schedule
+     */
+    execute?: Record<string, DeployConfigCloudRunExecute | null>;
     debug?: boolean;
 } & DeployConfigBase;
 export type DeployConfigCloudRunVolumes = Record<string, DeployConfigCloudRunVolume>;
@@ -236,4 +258,76 @@ export type DeployConfigCloudRunVolume = {
     mountPath: string;
     readonly?: boolean;
 };
+export type DeployConfigCloudRunExecuteJobBase = {
+    /**
+     * set to "job" to run a cloud run job
+     */
+    type: "job";
+    /**
+     * the cloud run job to run
+     */
+    job: string;
+    /**
+     * additional args to pass to the job
+     */
+    args?: string[];
+};
+type WithSchedule = {
+    /**
+     * run the job on a schedule
+     */
+    when: "schedule";
+    /**
+     * the cron schedule. See https://crontab.guru/
+     */
+    schedule: `${Minute} ${Hour} ${DayOfMonth} ${Month} ${DayOfWeek}`;
+    /**
+     * Max number of retries of the cloud scheduler.
+     * Note: the task itself is never retried.
+     *
+     * defaults to 0 (no retries)
+     */
+    maxRetryAttempts?: 0 | 1 | 2 | 3 | 4 | 5;
+};
+export type DeployConfigCloudRunExecuteJobScheduled = DeployConfigCloudRunExecuteJobBase & WithSchedule;
+export type DeployConfigCloudRunExecuteOnDeploy = DeployConfigCloudRunExecuteJobBase & ({
+    /**
+     * run the job before or after the deploy
+     */
+    when: "preDeploy" | "postDeploy";
+    /**
+     * whether to wait for completion of the job
+     */
+    waitForCompletion?: boolean;
+} | {
+    /**
+     * run the job before or after the environment is stopped
+     */
+    when: "preStop" | "postStop";
+});
+export type DeployConfigCloudRunExecuteJob = DeployConfigCloudRunExecuteJobScheduled | DeployConfigCloudRunExecuteOnDeploy;
+export type DeployConfigCloudRunExecuteHttp = {
+    /**
+     * set to "http" to run a http request
+     */
+    type: "http";
+    /**
+     * the url to call
+     */
+    url: string;
+    /**
+     * the http-method to use. Defaults to "POST" (as specified by google cloud scheduler)
+     */
+    method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+    /**
+     * the body to send
+     */
+    body?: string;
+    /**
+     * the headers to send
+     */
+    headers?: Record<string, string>;
+} & WithSchedule;
+export type DeployConfigCloudRunExecute = DeployConfigCloudRunExecuteJob | DeployConfigCloudRunExecuteHttp;
+export type DeployConfigCloudRunExecuteWithSchedule = Extract<DeployConfigCloudRunExecute, WithSchedule>;
 export {};