@catladder/pipeline 1.110.0 → 1.110.2

package/src/build/types.ts

@@ -1,4 +1,9 @@
-import type { EnvVars, GitlabJobImage, GitlabJobService } from "../types";
+import type {
+  Artifacts,
+  EnvVars,
+  GitlabJobImage,
+  GitlabJobService,
+} from "../types";
 
 import type { CatladderJob } from "../types/jobs";
 
@@ -12,6 +17,22 @@ export type BuildConfigArtifactsReports = {
   junit?: string[];
 };
 
+export type TestJobCustom = {
+  command?: string | string[];
+  jobImage?: GitlabJobImage;
+  /**
+   * additional CI/CD artifacts reports,
+   * use to display information in merge requests, pipeline views and security dashboards.
+   */
+  artifactsReports?: BuildConfigArtifactsReports;
+  /**
+   * GitLab {@link Artifacts} configuration.
+   *
+   * {@link TestJobCustom.artifacts}.reports.junit is merged with {@link TestJobCustom.artifactsReports} in case both given.
+   */
+  artifacts?: Artifacts;
+};
+
 export type BuildConfigBase = {
   /**
    * command to run on the image to start the app (e.g. yarn start)
@@ -38,39 +59,38 @@ export type BuildConfigBase = {
    * customize docker build
    */
   docker?: {
+    /**
+     * Custom Dockerfile lines integrated in the generated Dockerfile before the standard build steps.
+     *
+     * - [runner-images/docker-build/scripts/ensureNodeDockerfile](https://git.panter.ch/catladder/catladder/-/tree/main/runner-images/docker-build/scripts/ensureNodeDockerfile)
+     * - [runner-images/docker-build/scripts/ensureNginxDockerfile](https://git.panter.ch/catladder/catladder/-/tree/main/runner-images/docker-build/scripts/ensureNginxDockerfile)
+     * - [runner-images/docker-build/scripts/ensureMeteorDockerfile](https://git.panter.ch/catladder/catladder/-/tree/main/runner-images/docker-build/scripts/ensureMeteorDockerfile)
+     */
     additionsBegin?: string[];
+    /**
+     * Custom Dockerfile lines integrated in the generated Dockerfile after the standard build steps.
+     *
+     * - [runner-images/docker-build/scripts/ensureNodeDockerfile](https://git.panter.ch/catladder/catladder/-/tree/main/runner-images/docker-build/scripts/ensureNodeDockerfile)
+     * - [runner-images/docker-build/scripts/ensureNginxDockerfile](https://git.panter.ch/catladder/catladder/-/tree/main/runner-images/docker-build/scripts/ensureNginxDockerfile)
+     * - [runner-images/docker-build/scripts/ensureMeteorDockerfile](https://git.panter.ch/catladder/catladder/-/tree/main/runner-images/docker-build/scripts/ensureMeteorDockerfile)
+     */
     additionsEnd?: string[];
   };
 
   /**
    * customize lint, set false to disable
    */
-  lint?:
-    | false
-    | {
-        command?: string | string[];
-        jobImage?: GitlabJobImage;
-      };
+  lint?: false | TestJobCustom;
 
   /**
    * customize test, set false to disable
    */
-  test?:
-    | false
-    | {
-        command?: string | string[];
-        jobImage?: GitlabJobImage;
-      };
+  test?: false | TestJobCustom;
 
   /**
    * customize audit, set false to disable
    */
-  audit?:
-    | false
-    | {
-        command?: string | string[];
-        jobImage?: GitlabJobImage;
-      };
+  audit?: false | TestJobCustom;
 
   /**
    * additional paths for artifacts,
@@ -147,6 +167,9 @@ export type BuildConfigCustom = Omit<
 > & {
   type: "custom";
   jobImage: GitlabJobImage;
+  /**
+   * {@link GitlabJobService}s used in lint, test, audit, and build jobs.
+   */
   jobServices?: GitlabJobService[];
 
   docker: BuildConfigCustomDocker;
@@ -154,41 +177,17 @@ export type BuildConfigCustom = Omit<
   /**
    * custom lint, disabled when not set
    */
-  lint?: {
-    command?: string | string[];
-    jobImage?: GitlabJobImage;
-    /**
-     * additional CI/CD artifacts reports,
-     * use to display information in merge requests, pipeline views and security dashboards.
-     */
-    artifactsReports?: BuildConfigArtifactsReports;
-  };
+  lint?: TestJobCustom;
 
   /**
    * custom test, disabled when not set
    */
-  test?: {
-    command?: string | string[];
-    jobImage?: GitlabJobImage;
-    /**
-     * additional CI/CD artifacts reports,
-     * use to display information in merge requests, pipeline views and security dashboards.
-     */
-    artifactsReports?: BuildConfigArtifactsReports;
-  };
+  test?: TestJobCustom;
 
   /**
    * custom audit, disabled when not set
    */
-  audit?: {
-    command?: string | string[];
-    jobImage?: GitlabJobImage;
-    /**
-     * additional CI/CD artifacts reports,
-     * use to display information in merge requests, pipeline views and security dashboards.
-     */
-    artifactsReports?: BuildConfigArtifactsReports;
-  };
+  audit?: TestJobCustom;
 
   /**
    * custom sbom (software bill of materials), set false to disable

package/src/types/gitlab-types.ts

@@ -2,19 +2,19 @@ export type Artifacts = {
   paths: string[];
   expire_in?: string;
   when?: "always" | "on_success" | "on_failure";
-  reports?: ArtifactReports;
+  // 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;
+  };
 };
-// Reports won't show up on MRs until https://gitlab.com/groups/gitlab-org/-/epics/8205
-export type ArtifactReports =
-  | { 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;