@catladder/pipeline 1.54.0 → 1.55.1

package/src/deploy/index.ts

@@ -1,39 +1,27 @@
-import type { Config, EnvType } from "../types";
-import type { CommitInfo, Context } from "../types/context";
+import type { Context } from "../types/context";
+import type { EnvironmentContext } from "../types/environmentContext";
 import type { CatladderJob } from "../types/jobs";
-import { GCLOUD_RUN_DEPLOY_TYPES } from "./cloudRun";
+import { GCLOUD_RUN_DEPLOY_TYPE } from "./cloudRun";
 import { CUSTOM_DEPLOY_TYPE } from "./custom";
 import { DOCKER_TAG_DEPLOY_TYPE } from "./dockerTag";
 import { KUBERNETES_DEPLOY_TYPE } from "./kubernetes";
 import type { DeployConfigGeneric, DeployConfigType } from "./types";
+export * from "./cloudRun";
+export * from "./cloudSql";
 export * from "./kubernetes";
 export * from "./types";
 export * from "./utils";
 
-export type EnvVarContext<D extends DeployConfigType> = {
-  deployConfig: false | DeployConfigGeneric<D>;
-  commitInfo?: CommitInfo;
-  env: string;
-  envType: EnvType;
-  componentName: string;
-  fullName: string;
-
-  /**
-   * the full catladder config
-   */
-  fullConfig: Config;
-};
-
 export type DeployTypeDefinition<T extends DeployConfigType> = {
   jobs: (context: Context) => CatladderJob[];
-  defaults: () => Partial<DeployConfigGeneric<T>>;
-  additionalSecretKeys: (envVarContext: EnvVarContext<T>) => string[];
+  defaults: (
+    envContext: EnvironmentContext<any, T>
+  ) => Partial<DeployConfigGeneric<T>>;
+  additionalSecretKeys: (envContext: EnvironmentContext<any, T>) => string[];
   getAdditionalEnvVars: (
-    envVarContext: EnvVarContext<T>
+    envContext: EnvironmentContext<any, T>
   ) => Record<string, string | undefined | null>;
 };
-export * from "./cloudSql";
-export * from "./cloudRun";
 export type DeployTypes = {
   [T in DeployConfigType]: DeployTypeDefinition<T>;
 };
@@ -42,5 +30,5 @@ export const DEPLOY_TYPES: DeployTypes = {
   kubernetes: KUBERNETES_DEPLOY_TYPE,
   custom: CUSTOM_DEPLOY_TYPE,
   dockerTag: DOCKER_TAG_DEPLOY_TYPE,
-  ...GCLOUD_RUN_DEPLOY_TYPES,
+  "google-cloudrun": GCLOUD_RUN_DEPLOY_TYPE,
 };

package/src/deploy/kubernetes/additionalSecretKeys.ts

@@ -1,20 +1,20 @@
-import type { EnvVarContext } from "..";
+import type { EnvironmentContext } from "../../types/environmentContext";
 
 export const additionalKubernetesSecretKeys = ({
-  deployConfig,
-}: EnvVarContext<"kubernetes">) => {
-  if (!deployConfig) {
+  deployConfigRaw,
+}: EnvironmentContext<any, "kubernetes">) => {
+  if (!deployConfigRaw) {
     return [];
   }
   const keys = [];
-  if (deployConfig.values?.mongodb?.enabled) {
+  if (deployConfigRaw.values?.mongodb?.enabled) {
     keys.push("MONGODB_ROOT_PASSWORD");
-    if (deployConfig.values.mongodb.architecture === "replicaset") {
+    if (deployConfigRaw.values.mongodb.architecture === "replicaset") {
       keys.push("MONGODB_REPLICASET_KEY");
     }
   }
 
-  if (deployConfig.values?.cloudsql?.enabled) {
+  if (deployConfigRaw.values?.cloudsql?.enabled) {
     keys.push("POSTGRESQL_PASSWORD");
     keys.push("cloudsqlProxyCredentials");
   }

package/src/deploy/kubernetes/index.ts

@@ -11,7 +11,7 @@ export const KUBERNETES_DEPLOY_TYPE: DeployTypeDefinition<"kubernetes"> = {
   getAdditionalEnvVars: ({
     componentName,
     fullConfig,
-    deployConfig,
+    deployConfigRaw,
     env,
     envType,
     commitInfo,
@@ -27,7 +27,7 @@ export const KUBERNETES_DEPLOY_TYPE: DeployTypeDefinition<"kubernetes"> = {
         : env;
 
     const domainCanonical =
-      (deployConfig && deployConfig.cluster?.domainCanonical) || // for convenience, we allow clusters to define a canonical domain, because a cluster has a fixed ip and you will usually have a domain pointing to that cluster
+      (deployConfigRaw && deployConfigRaw.cluster?.domainCanonical) || // for convenience, we allow clusters to define a canonical domain, because a cluster has a fixed ip and you will usually have a domain pointing to that cluster
       fullConfig.domainCanonical ||
       "panter.cloud";
     const HOST_CANONICAL = `${componentSlug}.${envInUrl}.${fullConfig.appName}.${fullConfig.customerName}.${domainCanonical}`; // default for kubernetes and rest

package/src/deploy/types/googleCloudRun.ts

@@ -37,22 +37,22 @@ export type Gcloudregion =
   | "us-west3"
   | "us-west4";
 
-export type DeployConfigCloudRunBase = {
-  /**
-   * the google cloud porject id
-   */
-  projectId: string;
+export type DeployConfigCloudRunService = {
   /**
-   * the region. Set to europe-west6 for switzerland
+   * command / entrypoint, fallsback to buildConfig.startcommand
    */
-  region: Gcloudregion;
+  command?: string;
+};
 
+export type DeployConfigCloudRunJob = {
   /**
-   * command / entrypoint, fallsback to buildConfig.startcommand
+   * command
    */
-  command?: string;
-} & DeployConfigBase;
-export type DeployConfigCloudRunService = {
+  command: string;
+
+  when: "manual" | "postDeploy";
+};
+export type DeployConfigCloudRun = {
   /**
    * EXPERIMENTAL cloud run deployment.
    *
@@ -61,19 +61,21 @@ export type DeployConfigCloudRunService = {
    * Requires that cloud run is enabled on the project, as well as cloud run api and artifacts registry.
    */
   type: "google-cloudrun";
-} & DeployConfigCloudRunBase;
+  /**
+   * the google cloud porject id
+   */
+  projectId: string;
+  /**
+   * the region. Set to europe-west6 for switzerland
+   */
+  region: Gcloudregion;
 
-export type DeployConfigCloudRunJob = {
   /**
-   * EXPERIMENTAL cloud run job.
-   *
-   * This will deploy a cloud run job. This does not do much currently, but will be later used for cronjobs
-   *
-   * Requires that cloud run is enabled on the project, as well as cloud run api and artifacts registry.
+   * whether to enable the service, defaults to true
    */
-  type: "google-cloudrun-job";
-} & DeployConfigCloudRunBase;
+  service?: boolean | DeployConfigCloudRunService;
 
-export type DeployConfigCloudRun =
-  | DeployConfigCloudRunService
-  | DeployConfigCloudRunJob;
+  jobs?: {
+    [name: string]: DeployConfigCloudRunJob;
+  };
+} & DeployConfigBase;

package/src/types/config.ts

@@ -104,6 +104,8 @@ export type EnvConfig<E extends EnvType = EnvType> = {
   host?: string;
 } & PartialDeep<DefaultEnvConfig>;
 
+export type EnvConfigWithComponent = EnvConfig<EnvType> & ComponentConfig;
+
 export type Env = {
   /**
    * local is a special env that is only used in local development

package/src/types/environmentContext.ts

@@ -0,0 +1,26 @@
+import type { BuildConfigGeneric, BuildConfigType } from "../build";
+import type { DeployConfigGeneric } from "../deploy";
+import type { DeployConfigType } from "../deploy";
+import type { Config, EnvConfigWithComponent, EnvType } from "./config";
+import type { CommitInfo } from "./context";
+
+export type EnvironmentContext<
+  B extends BuildConfigType,
+  D extends DeployConfigType
+> = {
+  envConfigRaw: EnvConfigWithComponent;
+  buildConfigRaw: false | BuildConfigGeneric<B>;
+  deployConfigRaw: false | DeployConfigGeneric<D>;
+  commitInfo?: CommitInfo;
+  env: string;
+  envType: EnvType;
+  componentName: string;
+  fullName: string;
+  environmentSlug: string;
+  gitlabEnvironmentName: string;
+
+  /**
+   * the full catladder config
+   */
+  fullConfig: Config;
+};