@catladder/pipeline 1.10.2 → 1.13.0

package/src/types/context.ts

@@ -22,17 +22,28 @@ export type CommitInfo = {
   trigger: PipelineTrigger;
 };
 
-export type YarnInfo = {
+type Workspace = {
+  name: string;
+  location: string;
+  workspaceDependencies: string[];
+  mismatchedWorkspaceDependencies: string[];
+};
+export type YarnPackageManagerInfo = {
+  type: "yarn";
   version: string;
-  workspaces: { location: string }[];
+  workspaces: Workspace[];
+  currentWorkspace?: Workspace;
   isClassic: boolean;
   componentIsInWorkspace: boolean;
+  pathsToCopyInDocker: string[];
 };
+
+export type PackageManagerInfo = YarnPackageManagerInfo;
 export type Context = {
   componentName: string;
   componentConfig: ComponentConfig;
   fullConfig: Config;
   environment: Environment;
   commitInfo?: CommitInfo;
-  yarnInfo?: YarnInfo;
+  packageManagerInfo?: PackageManagerInfo;
 };

package/src/types/gitlab-types.ts

@@ -56,39 +56,19 @@ export type GitlabJobDef = {
   };
 };
 
-export const GITLAB_BASE_STAGES = [
-  "setup",
-  "test",
-  "build",
-  "deploy",
-  "verify",
-  "stop",
-] as const;
-export type GitlabBaseStage = typeof GITLAB_BASE_STAGES[number];
 export type GitlabVariables = Record<string, string | undefined>;
 
-export type GitlabJob = {
-  /**
-   * the name of the job (without any env or app prefix and suffix)
-   */
-  name: string;
-  /**
-   * envMode sets the behavior of the job regarding multiple envs:
-   * - none: the job does not run per env, but once for all envs
-   * - jobPerEnv: the job runs once per env
-   * - stagePerEnv: the job runs once per env and is organized in its own stage. This mproves usability in gitlab, but works the same as `jobPerEnv`
-   */
-  envMode: "jobPerEnv" | "stagePerEnv" | "none";
-  job: GitlabJobDef;
-  needsStages?: {
-    stage: GitlabBaseStage;
-    artifacts?: boolean;
-  }[];
-};
-export type GitlabJobs = GitlabJob[];
-
+/**
+ * this is not precicily the type of a gitlab-pipeline
+ * the jobs nee to be merge into the object.
+ * Problem is, that this type cannot be represented properly with typescript, see https://github.com/microsoft/TypeScript/issues/17867
+ */
 export type GitlabPipeline = {
+  image: string;
   variables: GitlabVariables;
+  workflow?: {
+    rules: GitlabRule[];
+  };
   stages: string[];
-  jobs: GitlabJobs;
+  jobs: Record<string, GitlabJobDef>;
 };

package/src/types/index.ts

@@ -1,3 +1,4 @@
 export * from "./config";
 export * from "./gitlab-types";
 export * from "./context";
+export * from "./pipeline";

package/src/types/jobs.ts

@@ -0,0 +1,88 @@
+import {
+  Artifacts,
+  GitlabEnvironment,
+  GitlabJobCache,
+  GitlabRule,
+  GitlabVariables,
+  Service,
+} from "./gitlab-types";
+
+export const BASE_STAGES = [
+  "setup",
+  "test",
+  "build",
+  "deploy",
+  "verify",
+  "stop",
+] as const;
+export type BaseStage = typeof BASE_STAGES[number];
+
+export type CatladderJob<S = BaseStage> = {
+  /**
+   * the name of the job (without any env or app prefix and suffix)
+   */
+  name: string;
+  /**
+   * envMode sets the behavior of the job regarding multiple envs:
+   * - none: the job does not run per env, but once for all envs
+   * - jobPerEnv: the job runs once per env
+   * - stagePerEnv: the job runs once per env and is organized in its own stage. This mproves usability in gitlab, but works the same as `jobPerEnv`
+   */
+  envMode: "jobPerEnv" | "stagePerEnv" | "none";
+
+  /**
+   * the stage of the job
+   */
+  stage: S;
+  /**
+   * does this require another stage?
+   */
+
+  /**
+   * script to run
+   */
+  script: (string | undefined)[];
+
+  needsStages?: {
+    stage: S;
+    artifacts?: boolean;
+  }[];
+
+  /**
+   * does this require another job?
+   */
+  needs?: Array<string | { job: string; artifacts: boolean }>;
+  /**
+   * cache config, we use here the same shape as gitlab itself
+   */
+  cache?: GitlabJobCache | GitlabJobCache[];
+
+  /**
+   * job artifacts, we also use gitlab shape here
+   */
+  artifacts?: Artifacts;
+
+  /**
+   * additional services, mainly used for docker
+   */
+  services?: Service[];
+
+  /**
+   * image to use
+   */
+  image?: string;
+
+  /**
+   * variables to pass
+   */
+  variables: GitlabVariables;
+
+  /**
+   * whether failures are allowed
+   */
+  allow_failure?: boolean;
+
+  environment?: GitlabEnvironment;
+
+  rules?: GitlabRule[];
+};

package/src/types/pipeline.ts

@@ -0,0 +1,11 @@
+import { GitlabJobDef, GitlabPipeline } from "./gitlab-types";
+
+export type PipelineType = "gitlab";
+
+export type PipelineJob<T extends PipelineType> = T extends "gitlab"
+  ? GitlabJobDef
+  : never;
+
+export type Pipeline<T extends PipelineType> = T extends "gitlab"
+  ? GitlabPipeline
+  : never;

package/dist/pipeline/yarnInfo.d.ts

@@ -1,2 +0,0 @@
-import { Config, YarnInfo } from "../types";
-export declare const getYarnInfo: (config: Config, componentName: string) => Promise<YarnInfo>;

package/src/pipeline/yarnInfo.ts

@@ -1,54 +0,0 @@
-import { exec } from "child-process-promise";
-import { Config, YarnInfo } from "../types";
-import { pathEqual } from "path-equal";
-import memoizee from "memoizee";
-
-const execOrFail = async (cmd: string, onFail: string): Promise<string> => {
-  try {
-    return await exec(cmd).then((r) => r.stdout);
-  } catch (e) {
-    return onFail ?? null;
-  }
-};
-
-const getYarnVersion = memoizee(
-  async () => {
-    return await execOrFail("yarn --version", "");
-  },
-  { promise: true }
-);
-
-const getWorkspaces = memoizee(
-  async (isClassic: boolean): Promise<YarnInfo["workspaces"]> => {
-    return isClassic
-      ? Object.values(
-          JSON.parse(
-            JSON.parse(await execOrFail("yarn workspaces --json info", "{}"))
-              ?.data ?? "{}"
-          )
-        )
-      : JSON.parse(`[${await execOrFail("yarn workspaces list --json", "")}]`);
-  },
-  { promise: true }
-);
-export const getYarnInfo = async (
-  config: Config,
-  componentName: string
-): Promise<YarnInfo> => {
-  const version = await getYarnVersion();
-  if (!version) throw new Error("could not get yarn version");
-  const isClassic = version.startsWith("1");
-
-  const component = config.components[componentName];
-  const workspaces = await getWorkspaces(isClassic);
-  const componentIsInWorkspace = workspaces.some((w) =>
-    pathEqual(component.dir, w.location)
-  );
-
-  return {
-    workspaces,
-    version,
-    isClassic,
-    componentIsInWorkspace,
-  };
-};