@catladder/pipeline 1.1.2 → 1.2.0

package/src/deploy/types.ts

@@ -2,24 +2,77 @@
 export type DeployConfigBase = {};
 type AllowUnknownProps<T extends Record<string, unknown>> = T &
   Record<string, unknown>;
+
+export type DeployConfigKubernetesClusterGCloud = {
+  type: "gcloud";
+  /**
+   * gcoud name of the cluster
+   */
+  name: string;
+  /**
+   * google cloud project id
+   */
+  projectId: string;
+  /**
+   * region
+   */
+  region: string;
+  /**
+   * domain of the cluster, for canonical domains without custom hostnames (e.g. review and dev apps)
+   */
+  domainCanonical?: string;
+};
+export type DeployConfigKubernetesCluster = DeployConfigKubernetesClusterGCloud; // currently only this
 export type DeployConfigKubernetes = {
   type: "kubernetes";
-  cluster?: string;
+  /**
+   * cluster config to use.
+   */
+  cluster?: DeployConfigKubernetesCluster;
+  /**
+   * prints out debug info (helm --debug)
+   */
+  debug?: boolean;
   additionalHelmArgs?: string[];
+  /**
+   * values to configure the app
+   */
   values?: AllowUnknownProps<{
+    /**
+     * enable cloudsql db. Currently you have to manually set it up
+     */
     cloudsql?: {
       enabled: boolean;
       instanceId?: string;
       projectId?: string;
       region?: string;
     };
+    /**
+     * enable mongodb. The mongodb is deployed using a helm chart.
+     * Consider using external services instead of this.
+     */
     mongodb?: AllowUnknownProps<{
       enabled: boolean;
     }>;
+    /**
+     * enable mailhog. Mailhog is a virtual mail server that catches all outgoing mailsl and show them in a mailbox.
+     * This is great for development as it prevents to accidentially send out real emails and helps with debugging outgoing mails.
+     *
+     * It will automaticaly inject a MAIL_URL env var.
+     *
+     * Turn it of for production.
+     */
     mailhog?: {
       enabled: boolean;
     };
+    /**
+     * post-install/upgrade jobs. These use the app image and have all env vars available.
+     * Typically used for migrations and seeds
+     */
     jobs?: Record<string, AllowUnknownProps<{ command: string }>>;
+    /**
+     * cronjobs that run periodically. These use the app image have all env vars available.
+     */
     cronjobs?: Record<
       string,
       AllowUnknownProps<{
@@ -28,9 +81,21 @@ export type DeployConfigKubernetes = {
         concurrencyPolicy?: "Forbid" | "Allow" | "Replace";
       }>
     >;
+    /**
+     * configuration for the application ("Deployment" in kubernetes)
+     */
     application?: AllowUnknownProps<{
+      /**
+       * redirects
+       */
       redirects?: AllowUnknownProps<{ host: string }>[];
+      /**
+       * how many pods will be started
+       */
       replicas?: number;
+      /**
+       * kubernetes resources
+       */
       resources?: {
         limits?: {
           cpu?: string;

package/src/deploy/utils.ts

@@ -0,0 +1,17 @@
+import { Config } from "../types";
+import type { DeployConfigKubernetesCluster } from "./types";
+
+export const getFullKubernetesClusterName = (
+  cluster: DeployConfigKubernetesCluster
+) => {
+  if (cluster.type === "gcloud") {
+    return `gke_${cluster.projectId}_${cluster.region}_${cluster.name}`;
+  }
+};
+
+export const getKubernetesNamespace = (
+  config: Pick<Config, "customerName" | "appName">,
+  env: string
+) => {
+  return `${config.customerName}-${config.appName}-${env}`;
+};

package/src/pipeline/createChildPipeline.ts

@@ -39,7 +39,10 @@ export const createChildPipeline = async (
   );
 
   const childPipeline = {
-    image: getRunnerImage("jobs"), // default image
+    image: getRunnerImage("jobs-default"), // default image
+    variables: {
+      FF_USE_FASTZIP: "true",
+    },
     workflow: {
       rules: RULES_ALWAYS,
     },

package/src/pipeline/createJobs.ts

@@ -1,3 +1,4 @@
+import { exec } from "child-process-promise";
 import { isObject } from "lodash";
 import { BUILD_TYPES } from "../build";
 import { createContext } from "../context";
@@ -126,6 +127,10 @@ export const createJobs = async (
   const commitInfo: CommitInfo = {
     refName: process.env.CI_COMMIT_REF_NAME ?? "unknown",
     refSlug: process.env.CI_COMMIT_REF_SLUG ?? "unknown",
+    buildTime: new Date().toISOString(),
+    buildId: await exec("git describe --tags || git rev-parse HEAD").then((s) =>
+      s.stdout.trim()
+    ),
     trigger,
   };
 

package/src/runner/index.ts

@@ -1,7 +1,9 @@
 import { PIPELINE_IMAGE_TAG, DOCKER_REGISTRY } from "../constants";
 
 type RunnerImageName =
-  | "jobs"
+  | "jobs-default"
+  | "jobs-meteor"
+  | "jobs-testing-chrome"
   | "kubernetes"
   | "base-pipeline"
   | "docker-build"

package/src/types/config.ts

@@ -46,16 +46,34 @@ export const isKnowEnvType = (env: string): env is EnvType => {
 };
 
 export type EnvVars = {
+  /**
+   * public env vars (means: they are checked in the repo)
+   */
   public?: Record<string, any>;
+  /**
+   * secret env vars. These vars can be managed with catladder/cli
+   */
   secret?: string[];
+  /**
+   * With fromComponents you can inject env vars from other components.
+   */
   fromComponents?: {
     [otherApp: string]: Record<string, string>;
   };
 };
 
 export type DefaultEnvConfig = {
+  /**
+   * how the app is deployed
+   */
   deploy: DeployConfig | false;
+  /**
+   * how the app is built and its runtime
+   */
   build: BuildConfig;
+  /**
+   * environment variables
+   */
   vars?: EnvVars;
 };
 
@@ -64,12 +82,22 @@ export type DevLocalEnvConfig = {
   port?: number;
 };
 export type EnvConfig<E extends EnvType = EnvType> = {
+  /**
+   * type of the env (stage, prod, review, dev)
+   */
   type?: E;
+  /**
+   * hostname that is used. If not set, a "canonical" url is created
+   */
   hostname?: string;
 } & PartialDeep<DefaultEnvConfig>;
 
 export type Env = {
+  /**
+   * local is a special env that is only used in local development
+   */
   local?: DevLocalEnvConfig;
+
   dev?: EnvConfig<"dev"> | false;
   stage?: EnvConfig<"stage"> | false;
   review?: EnvConfig<"review"> | false;
@@ -77,12 +105,33 @@ export type Env = {
 } & Record<string, EnvConfig | false>;
 
 export type ComponentConfig = {
+  /**
+   * specify environment configurations
+   */
   env?: Env;
+  /**
+   * the directory of the component (e.g. where the package.json or similar is located). You can set "." if you only have one app.
+   */
   dir: string;
 } & DefaultEnvConfig;
 
 export type Config = {
+  /**
+   * name of the customer or group
+   */
   customerName: string;
+  /**
+   * name of the app / project
+   */
   appName: string;
+  /**
+   * if a env does not define a hostname, it will generate a canonical one (e.g. for review, dev and stage).
+   * This prop specifies the domain that is used for these urls.
+   *
+   */
+  domainCanonical?: string;
+  /**
+   * components (sub apps)
+   */
   components: Record<string, ComponentConfig>;
 };

package/src/types/context.ts

@@ -17,6 +17,8 @@ export type Environment = {
 export type CommitInfo = {
   refName: string;
   refSlug: string;
+  buildTime: string;
+  buildId: string;
   trigger: PipelineTrigger;
 };