@catladder/pipeline 1.146.2 → 1.148.0

package/src/pipeline/generatePipelineFiles.ts

@@ -3,6 +3,7 @@ import { writeYamlfile } from "../utils/writeFiles";
 import { createChildPipeline } from "./createChildPipeline";
 import { createMainPipeline } from "./createMainPipeline";
 import { getPipelineTriggerForGitlabChildPipeline } from "./gitlab/getPipelineTriggerForGitlabChildPipeline";
+import { sortGitLabJobDefProps } from "./gitlab/sortGitLabJobDefProps";
 export async function generatePipelineFiles<T extends PipelineType>(
   config: Config,
   pipelineType: T,
@@ -11,28 +12,40 @@ export async function generatePipelineFiles<T extends PipelineType>(
   if (mode === "childpipeline") {
     const trigger = getPipelineTriggerForGitlabChildPipeline();
 
-    const { jobs, image, stages, variables, workflow, ...mainPipeline } =
+    const { jobs, image, stages, variables, workflow, ...pipelineRest } =
       await createChildPipeline(pipelineType, trigger, config);
-    // need to spread out the jobs, forgot why
+    const jobsWithSortedProps = Object.fromEntries(
+      Object.entries(jobs).map(([jobName, job]) => [
+        jobName,
+        sortGitLabJobDefProps(job),
+      ]),
+    );
     await writeYamlfile(`__pipeline.yml`, {
       image,
       stages,
       variables,
       workflow,
-      ...mainPipeline,
-      ...jobs,
+      ...pipelineRest,
+      // jobs need to be spread into main YAML, because GitLab pipeline YAML has no jobs key - jobs are top level with their key as their name
+      ...jobsWithSortedProps,
     });
   } else {
-    const { jobs, image, stages, variables, workflow, ...mainPipeline } =
+    const { jobs, image, stages, variables, workflow, ...pipelineRest } =
       await createMainPipeline(pipelineType, config);
-    // need to spread out the jobs, forgot why
+    const jobsWithSortedProps = Object.fromEntries(
+      Object.entries(jobs).map(([jobName, job]) => [
+        jobName,
+        sortGitLabJobDefProps(job),
+      ]),
+    );
     await writeYamlfile(`.gitlab-ci.yml`, {
       image,
       stages,
       variables,
       workflow,
-      ...mainPipeline,
-      ...jobs,
+      ...pipelineRest,
+      // jobs need to be spread into main YAML, because GitLab pipeline YAML has no jobs key - jobs are top level with their key as their name
+      ...jobsWithSortedProps,
     });
   }
 }

package/src/pipeline/gitlab/createGitlabJobs.ts

@@ -11,6 +11,7 @@ import type { CatladderJob, CatladderJobNeed } from "../../types/jobs";
 import { notNil } from "../../utils";
 import { collapseableSection } from "../../utils/gitlab";
 import type { AllCatladderJobs } from "../createAllJobs";
+import { removeUndefined } from "../../utils/removeUndefined";
 
 export type AllGitlabJobs = {
   name: string;
@@ -20,10 +21,6 @@ export type AllGitlabJobs = {
 }[];
 
 export const GITLAB_ENVIRONMENT_URL_VARIABLE = "CL_GITLAB_ENVIRONMENT_URL";
-const removeUndefined = (obj: GitlabJobDef): GitlabJobDef =>
-  Object.fromEntries(
-    Object.entries(obj).filter(([, value]) => value !== undefined),
-  ) as GitlabJobDef;
 const getFullJobName = (
   name: string,
   componentName: string,
@@ -197,9 +194,7 @@ export const makeGitlabJob = (
     allJobs,
   );
 
-  const gitlabJob: GitlabJobDef = removeUndefined(modified);
-
-  return [fullJobName, gitlabJob];
+  return [fullJobName, removeUndefined(modified)];
 };
 
 const addGitlabEnvironment = (

package/src/pipeline/gitlab/sortGitLabJobDefProps.ts

@@ -0,0 +1,59 @@
+import type { GitlabJobDef } from "../../types";
+
+type GitlabJobDefKey = keyof GitlabJobDef;
+
+/**
+ * The desired order of GitLab job definition keys.
+ */
+const jobDefOrder: GitlabJobDefKey[] = [
+  "stage",
+  "tags",
+  "image",
+  "services",
+  "variables",
+  "before_script",
+  "script",
+  "after_script",
+  "cache",
+  "coverage",
+  "environment",
+  "release",
+  "artifacts",
+  "rules",
+  "only",
+  "except",
+  "needs",
+  "dependencies",
+  "trigger",
+  "retry",
+  "interruptible",
+  "allow_failure",
+  "parallel",
+  "hooks",
+  "resource_group",
+];
+
+const sortGitLabJobDefKeys = (jobDef: GitlabJobDef): GitlabJobDefKey[] =>
+  (Object.keys(jobDef) as GitlabJobDefKey[]).sort((a, b) =>
+    jobDefOrder.indexOf(a) === -1 && jobDefOrder.indexOf(b) === -1
+      ? 0
+      : jobDefOrder.indexOf(a) === -1
+        ? 1
+        : jobDefOrder.indexOf(b) === -1
+          ? -1
+          : jobDefOrder.indexOf(a) - jobDefOrder.indexOf(b),
+  );
+
+/**
+ * Sorts the properties of a GitLab job definition based on the desired order.
+ *
+ * This is only useful when generating a GitLab pipeline YAML file.
+ */
+export const sortGitLabJobDefProps = (jobDef: GitlabJobDef): GitlabJobDef =>
+  sortGitLabJobDefKeys(jobDef).reduce(
+    (acc, key) =>
+      jobDef[key] !== undefined
+        ? Object.assign(acc, { [key]: jobDef[key] })
+        : acc,
+    {} as GitlabJobDef,
+  );

package/src/types/config.ts

@@ -151,7 +151,9 @@ export type ComponentConfig<C extends ConfigProps = never> = {
    * to let us know about why you need to use custom jobs.
    * This feedback will help us to generalize use cases
    */
-  customJobs?: CatladderJob[] | ((context: ComponentContext) => CatladderJob[]);
+  customJobs?:
+    | CatladderJob[]
+    | ((context: Omit<ComponentContext, "customJobs">) => CatladderJob[]);
 
   /**
    * whether to create a .env

package/src/types/context.ts

@@ -1,6 +1,7 @@
 import type { StringOrBashExpression } from "../bash/BashExpression";
 import type { BuildConfig } from "../build";
 import type { PredefinedVariables, SecretEnvVar } from "../context";
+import type { DeployConfig } from "../deploy";
 import type {
   PipelineTrigger,
   ComponentConfig,
@@ -89,10 +90,22 @@ export type BuildContext = {
   packageManagerInfo?: PackageManagerInfo;
   config: BuildConfig;
 };
+
+export type DeployContext = {
+  config: DeployConfig;
+};
 export type ComponentContext = {
   componentName: string;
+
+  /**
+   * the merged component config.
+   *
+   * use build.config and deploy.config instead if you need something from there
+   *
+   */
   componentConfig: ComponentConfig;
-  buildContext: BuildContext;
+  build: BuildContext;
+  deploy?: DeployContext | null;
   fullConfig: Config;
   environment: Environment;
 
@@ -102,6 +115,8 @@ export type ComponentContext = {
    * @deprecated use buildContext.packageManagerInfo instead
    */
   packageManagerInfo?: PackageManagerInfo;
+
+  customJobs?: CatladderJob[];
 };
 
 /**

package/src/utils/removeUndefined.ts

@@ -0,0 +1,4 @@
+export const removeUndefined = <T extends object>(obj: T): T =>
+  Object.fromEntries(
+    Object.entries(obj).filter(([, value]) => value !== undefined),
+  ) as T;