@catladder/pipeline 1.111.4 → 1.112.1

package/src/types/gitlab-types.ts

@@ -1,105 +1,68 @@
-export type Artifacts = {
-  paths: string[];
-  expire_in?: string;
-  when?: "always" | "on_success" | "on_failure";
-  // Reports won't show up on MRs until https://gitlab.com/groups/gitlab-org/-/epics/8205
-  reports?: {
-    accessibility?: string | string[];
-    coverage_report?: { coverage_format: string; path: string };
-    codequality?: string | string[];
-    cyclonedx?: string | string[];
-    dotenv?: string | string[];
-    junit?: string | string[];
-    sast?: string;
-    secret_detection?: string;
-    terraform?: string;
-  };
-};
-export type GitlabJobCache = {
-  key: GitlabJobCacheKey;
-  policy?: string;
-  paths: string[];
-};
-export type GitlabJobCacheKey =
-  | string
-  | {
-      files: string[];
-      prefix?: string;
-    };
-export type GitlabRule = {
-  if?: string;
-  when?: "always" | "on_success" | "manual" | "never"; // todo
-  allow_failure?: boolean;
-};
-export type Retry = {
-  max: number;
-  when: string[];
-};
+import type {
+  Artifacts as GitlabCiArtifacts,
+  JobTemplate,
+  Cache,
+  Rules,
+} from "./gitlab-ci-yml";
 
-export type GitlabJobService = {
-  name: string;
-  command?: string[];
-  entrypoint?: string[];
-  alias?: string;
-};
+export { Retry, Image as GitlabJobImage } from "./gitlab-ci-yml";
 
-export type GitlabJobImage =
-  | string
-  | {
-      name: string;
-      entrypoint?: string[];
-    };
+// Reports won't show up on MRs until https://gitlab.com/groups/gitlab-org/-/epics/8205
+export interface Artifacts extends Omit<GitlabCiArtifacts, "paths"> {
+  paths: string[];
+}
+export type GitlabJobCache = Cache;
+export type GitlabRule = Exclude<Rules, null>[number];
+export type GitlabEnvironment = Omit<
+  Exclude<JobTemplate["environment"], undefined | string>,
+  "deployment_tier"
+>;
 
-export type GitlabEnvironment = {
-  url: string;
-  name: string;
-  kubernetes?: {
-    namespace?: string;
-  };
-  action?: "stop" | "start" | "prepare" | "access"; // defaults to start
-  on_stop?: string; // other job to run on stop
-  auto_stop_in?: string;
-};
-export type GitlabJobDef = {
-  stage: string;
-  before_script?: string[];
-  script: (string | undefined)[];
-  interruptible?: boolean;
-  needs?: Array<string | { job: string; artifacts: boolean }>;
+export interface GitlabJobDef
+  extends Pick<
+    JobTemplate,
+    | "after_script"
+    | "allow_failure"
+    | "artifacts"
+    | "before_script"
+    | "coverage"
+    | "dependencies"
+    | "environment"
+    | "except"
+    | "hooks"
+    | "image"
+    | "interruptible"
+    | "needs"
+    | "only"
+    | "parallel"
+    | "release"
+    | "resource_group"
+    | "retry"
+    | "rules"
+    | "script"
+    | "services"
+    | "stage"
+    | "tags"
+    | "trigger"
+    | "variables"
+  > {
+  stage: JobTemplate["stage"];
   rules?: GitlabRule[];
   cache?: GitlabJobCache | GitlabJobCache[];
   artifacts?: Artifacts;
-  retry?: Retry;
-  services?: GitlabJobService[];
-  image?: GitlabJobImage;
-  variables?: GitlabVariables;
-  dependencies?: string[];
-  environment?: GitlabEnvironment;
-  allow_failure?: boolean;
-  parallel?: number;
   tags?: string[];
-  trigger?: {
-    strategy: "depend";
-    include: Array<{
-      artifact: string;
-      job: string;
-    }>;
-  };
-};
-
-export type GitlabVariables = Record<string, string | undefined>;
+}
 
 /**
  * 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 = {
+export interface GitlabPipeline extends Pick<JobTemplate, "variables"> {
   image: string;
-  variables: GitlabVariables;
   workflow?: {
     rules: GitlabRule[];
   };
   stages: string[];
   jobs: Record<string, GitlabJobDef>;
-};
+}

package/src/types/jobs.ts

@@ -3,9 +3,8 @@ import type {
   GitlabEnvironment,
   GitlabJobCache,
   GitlabRule,
-  GitlabVariables,
-  GitlabJobService,
   GitlabJobImage,
+  GitlabJobDef,
 } from "./gitlab-types";
 
 export const BASE_STAGES = [
@@ -82,7 +81,7 @@ export type CatladderJob<S = BaseStage> = {
   /**
    * additional services, mainly used for docker
    */
-  services?: GitlabJobService[];
+  services?: GitlabJobDef["services"];
 
   /**
    * image to use
@@ -92,7 +91,7 @@ export type CatladderJob<S = BaseStage> = {
   /**
    * variables to pass
    */
-  variables: GitlabVariables;
+  variables: GitlabJobDef["variables"];
 
   /**
    * whether failures are allowed

package/dist/build/base/createBuildJob.d.ts

@@ -1,7 +0,0 @@
-import type { Context } from "../..";
-import type { CatladderJob } from "../../types/jobs";
-export declare const createBuildJob: (context: Context, {
-  script,
-  variables,
-  ...def
-}: Partial<CatladderJob>) => CatladderJob;