@catladder/pipeline 1.147.0 → 1.148.1

package/examples/__snapshots__/rails-k8s-with-worker.ts.snap

@@ -328,7 +328,7 @@ EOF
           "echo -e "\\e[0Ksection_end:$(date +%s):writeallvalues\\r\\e[0K"",
           "kubernetesCreateSecret",
           "kubernetesDeploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/app" "https://app.dev.test-app.pan.panter.cloud" "__sbom.json" vex.json || true",
           "echo deployment successful 😻",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://app.dev.test-app.pan.panter.cloud" >> gitlab_environment.env",
@@ -404,7 +404,7 @@ EOF
           "kubectl config set-context "kube-pan-test-app-dev-app" --cluster="kube-pan-test-app-dev-app" --user="kube-pan-test-app-dev-app" --namespace="pan-test-app-dev"",
           "kubectl config use-context "kube-pan-test-app-dev-app"",
           "kubernetesDelete",
-          "echo Disabling component in Dependency Track",
+          "echo 'Disabling component in Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" disable "pan-test-app/app" "https://app.dev.test-app.pan.panter.cloud" || true",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://app.dev.test-app.pan.panter.cloud" >> gitlab_environment.env",
         ],
@@ -902,7 +902,7 @@ EOF
           "echo -e "\\e[0Ksection_end:$(date +%s):writeallvalues\\r\\e[0K"",
           "kubernetesCreateSecret",
           "kubernetesDeploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/app" "https://app.$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; }).review.test-app.pan.panter.cloud" "__sbom.json" vex.json || true",
           "echo deployment successful 😻",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://app.$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; }).review.test-app.pan.panter.cloud" >> gitlab_environment.env",
@@ -978,7 +978,7 @@ EOF
           "kubectl config set-context "kube-pan-test-app-review-$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; })-app" --cluster="kube-pan-test-app-review-$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; })-app" --user="kube-pan-test-app-review-$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; })-app" --namespace="pan-test-app-review"",
           "kubectl config use-context "kube-pan-test-app-review-$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; })-app"",
           "kubernetesDelete",
-          "echo Disabling component in Dependency Track",
+          "echo 'Disabling component in Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" disable "pan-test-app/app" "https://app.$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; }).review.test-app.pan.panter.cloud" || true",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://app.$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; }).review.test-app.pan.panter.cloud" >> gitlab_environment.env",
         ],
@@ -1543,7 +1543,7 @@ EOF
           "echo -e "\\e[0Ksection_end:$(date +%s):writeallvalues\\r\\e[0K"",
           "kubernetesCreateSecret",
           "kubernetesDeploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/app" "https://my-fancy-website.com" "__sbom.json" vex.json || true",
           "echo deployment successful 😻",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://my-fancy-website.com" >> gitlab_environment.env",
@@ -1715,7 +1715,7 @@ EOF
           "echo -e "\\e[0Ksection_end:$(date +%s):writeallvalues\\r\\e[0K"",
           "kubernetesCreateSecret",
           "kubernetesDeploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/app" "https://app.stage.test-app.pan.panter.cloud" "__sbom.json" vex.json || true",
           "echo deployment successful 😻",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://app.stage.test-app.pan.panter.cloud" >> gitlab_environment.env",
@@ -1791,7 +1791,7 @@ EOF
           "kubectl config set-context "kube-pan-test-app-prod-app" --cluster="kube-pan-test-app-prod-app" --user="kube-pan-test-app-prod-app" --namespace="pan-test-app-prod"",
           "kubectl config use-context "kube-pan-test-app-prod-app"",
           "kubernetesDelete",
-          "echo Disabling component in Dependency Track",
+          "echo 'Disabling component in Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" disable "pan-test-app/app" "https://my-fancy-website.com" || true",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://my-fancy-website.com" >> gitlab_environment.env",
         ],
@@ -1867,7 +1867,7 @@ EOF
           "kubectl config set-context "kube-pan-test-app-stage-app" --cluster="kube-pan-test-app-stage-app" --user="kube-pan-test-app-stage-app" --namespace="pan-test-app-stage"",
           "kubectl config use-context "kube-pan-test-app-stage-app"",
           "kubernetesDelete",
-          "echo Disabling component in Dependency Track",
+          "echo 'Disabling component in Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" disable "pan-test-app/app" "https://app.stage.test-app.pan.panter.cloud" || true",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://app.stage.test-app.pan.panter.cloud" >> gitlab_environment.env",
         ],
@@ -2338,7 +2338,7 @@ EOF
           "echo -e "\\e[0Ksection_end:$(date +%s):writeallvalues\\r\\e[0K"",
           "kubernetesCreateSecret",
           "kubernetesDeploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/app" "https://app.dev.test-app.pan.panter.cloud" "__sbom.json" vex.json || true",
           "echo deployment successful 😻",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://app.dev.test-app.pan.panter.cloud" >> gitlab_environment.env",
@@ -2414,7 +2414,7 @@ EOF
           "kubectl config set-context "kube-pan-test-app-dev-app" --cluster="kube-pan-test-app-dev-app" --user="kube-pan-test-app-dev-app" --namespace="pan-test-app-dev"",
           "kubectl config use-context "kube-pan-test-app-dev-app"",
           "kubernetesDelete",
-          "echo Disabling component in Dependency Track",
+          "echo 'Disabling component in Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" disable "pan-test-app/app" "https://app.dev.test-app.pan.panter.cloud" || true",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://app.dev.test-app.pan.panter.cloud" >> gitlab_environment.env",
         ],
@@ -2916,7 +2916,7 @@ EOF
           "echo -e "\\e[0Ksection_end:$(date +%s):writeallvalues\\r\\e[0K"",
           "kubernetesCreateSecret",
           "kubernetesDeploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/app" "https://app.$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; }).review.test-app.pan.panter.cloud" "__sbom.json" vex.json || true",
           "echo deployment successful 😻",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://app.$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; }).review.test-app.pan.panter.cloud" >> gitlab_environment.env",
@@ -2992,7 +2992,7 @@ EOF
           "kubectl config set-context "kube-pan-test-app-review-$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; })-app" --cluster="kube-pan-test-app-review-$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; })-app" --user="kube-pan-test-app-review-$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; })-app" --namespace="pan-test-app-review"",
           "kubectl config use-context "kube-pan-test-app-review-$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; })-app"",
           "kubernetesDelete",
-          "echo Disabling component in Dependency Track",
+          "echo 'Disabling component in Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" disable "pan-test-app/app" "https://app.$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; }).review.test-app.pan.panter.cloud" || true",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://app.$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; }).review.test-app.pan.panter.cloud" >> gitlab_environment.env",
         ],
@@ -3565,7 +3565,7 @@ EOF
           "echo -e "\\e[0Ksection_end:$(date +%s):writeallvalues\\r\\e[0K"",
           "kubernetesCreateSecret",
           "kubernetesDeploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/app" "https://my-fancy-website.com" "__sbom.json" vex.json || true",
           "echo deployment successful 😻",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://my-fancy-website.com" >> gitlab_environment.env",
@@ -3737,7 +3737,7 @@ EOF
           "echo -e "\\e[0Ksection_end:$(date +%s):writeallvalues\\r\\e[0K"",
           "kubernetesCreateSecret",
           "kubernetesDeploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/app" "https://app.stage.test-app.pan.panter.cloud" "__sbom.json" vex.json || true",
           "echo deployment successful 😻",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://app.stage.test-app.pan.panter.cloud" >> gitlab_environment.env",
@@ -3813,7 +3813,7 @@ EOF
           "kubectl config set-context "kube-pan-test-app-prod-app" --cluster="kube-pan-test-app-prod-app" --user="kube-pan-test-app-prod-app" --namespace="pan-test-app-prod"",
           "kubectl config use-context "kube-pan-test-app-prod-app"",
           "kubernetesDelete",
-          "echo Disabling component in Dependency Track",
+          "echo 'Disabling component in Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" disable "pan-test-app/app" "https://my-fancy-website.com" || true",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://my-fancy-website.com" >> gitlab_environment.env",
         ],
@@ -3889,7 +3889,7 @@ EOF
           "kubectl config set-context "kube-pan-test-app-stage-app" --cluster="kube-pan-test-app-stage-app" --user="kube-pan-test-app-stage-app" --namespace="pan-test-app-stage"",
           "kubectl config use-context "kube-pan-test-app-stage-app"",
           "kubernetesDelete",
-          "echo Disabling component in Dependency Track",
+          "echo 'Disabling component in Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" disable "pan-test-app/app" "https://app.stage.test-app.pan.panter.cloud" || true",
           "echo "CL_GITLAB_ENVIRONMENT_URL=https://app.stage.test-app.pan.panter.cloud" >> gitlab_environment.env",
         ],

package/examples/__snapshots__/wait-for-other-deploy.ts.snap

@@ -196,7 +196,7 @@ exports[`matches snapshot 1`] = `
           "echo -e "\\e[0Ksection_end:$(date +%s):injectvars\\r\\e[0K"",
           "cd api",
           "yarn deploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy dev",
@@ -504,7 +504,7 @@ exports[`matches snapshot 1`] = `
           "echo -e "\\e[0Ksection_end:$(date +%s):injectvars\\r\\e[0K"",
           "cd www",
           "yarn deploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy dev",
@@ -885,7 +885,7 @@ exports[`matches snapshot 1`] = `
           "echo -e "\\e[0Ksection_end:$(date +%s):injectvars\\r\\e[0K"",
           "cd api",
           "yarn deploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy review",
@@ -1193,7 +1193,7 @@ exports[`matches snapshot 1`] = `
           "echo -e "\\e[0Ksection_end:$(date +%s):injectvars\\r\\e[0K"",
           "cd www",
           "yarn deploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy review",
@@ -1593,7 +1593,7 @@ exports[`matches snapshot 1`] = `
           "echo -e "\\e[0Ksection_end:$(date +%s):injectvars\\r\\e[0K"",
           "cd api",
           "yarn deploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy prod",
@@ -1647,7 +1647,7 @@ exports[`matches snapshot 1`] = `
           "echo -e "\\e[0Ksection_end:$(date +%s):injectvars\\r\\e[0K"",
           "cd api",
           "yarn deploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy stage",
@@ -1921,7 +1921,7 @@ exports[`matches snapshot 1`] = `
           "echo -e "\\e[0Ksection_end:$(date +%s):injectvars\\r\\e[0K"",
           "cd www",
           "yarn deploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy prod",
@@ -1979,7 +1979,7 @@ exports[`matches snapshot 1`] = `
           "echo -e "\\e[0Ksection_end:$(date +%s):injectvars\\r\\e[0K"",
           "cd www",
           "yarn deploy",
-          "echo Uploading SBOM to Dependency Track",
+          "echo 'Uploading SBOM to Dependency Track'",
           "/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "https://unknown-host.example.com" "__sbom.json" vex.json || true",
         ],
         "stage": "deploy stage",

package/package.json

@@ -52,7 +52,7 @@
     }
   ],
   "license": "MIT",
-  "version": "1.147.0",
+  "version": "1.148.1",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables && yarn build:bundle",

package/src/deploy/cloudRun/createJobs/common.ts

@@ -21,7 +21,7 @@ export const setGoogleProjectNumberScript = (
   `export GCLOUD_PROJECT_NUMBER=$(${gcloudCmd()} projects describe ${
     deployConfig.projectId
   } --format="value(projectNumber)")`,
-  `echo "GCLOUD_PROJECT_NUMBER: $GCLOUD_PROJECT_NUMBER"`,
+  'echo "GCLOUD_PROJECT_NUMBER: $GCLOUD_PROJECT_NUMBER"',
 ];
 
 export const makeLabelString = (obj: Record<string, unknown>) =>

package/src/deploy/sbom.ts

@@ -10,7 +10,7 @@ export const getDependencyTrackUploadScript = (
   return sbomDeactivated(context)
     ? []
     : [
-        "echo Uploading SBOM to Dependency Track",
+        "echo 'Uploading SBOM to Dependency Track'",
         `/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "${context.fullConfig.customerName}-${context.fullConfig.appName}/${context.componentName}" "${context.environment.url}" "${SBOM_FILE}" vex.json || true`,
       ];
 };
@@ -21,7 +21,7 @@ export const getDependencyTrackDeleteScript = (
   return sbomDeactivated(context)
     ? []
     : [
-        "echo Disabling component in Dependency Track",
+        "echo 'Disabling component in Dependency Track'",
         `/dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" disable "${context.fullConfig.customerName}-${context.fullConfig.appName}/${context.componentName}" "${context.environment.url}" || true`,
       ];
 };

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/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;