@catladder/pipeline 1.100.1 → 1.101.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@catladder/pipeline",
-  "version": "1.100.1",
+  "version": "1.101.0",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables && yarn build:bundle",

package/src/build/node/buildJob.ts

@@ -24,7 +24,11 @@ export const createNodeBuildJobs = (context: Context): CatladderJob[] => {
           variables: {
             ...NODE_RUNNER_BUILD_VARIABLES,
           },
-          cache: [...getNodeCache(context), ...getNextCache(context)],
+          cache: [
+            ...(ensureArray(buildConfig.jobCache) ?? []),
+            ...getNodeCache(context),
+            ...getNextCache(context),
+          ],
           script: [
             ...yarnInstall,
             ...(ensureArray(buildConfig.buildCommand) ?? []),
@@ -39,6 +43,7 @@ export const createNodeBuildJobs = (context: Context): CatladderJob[] => {
               ) ?? []),
             ],
           },
+          jobTags: buildConfig.jobTags,
         })
       : null;
   return [

package/src/build/node/yarn.ts

@@ -14,7 +14,8 @@ const getYarnInstallCommand = (context: Context) => {
 };
 
 export const ensureNodeVersion = (context: Context) => [
-  "if [ -f ./.nvmrc ]; then source /root/.nvm/nvm.sh && nvm install <<< .nvmrc; fi",
+  "if [ -f ~/.nvm/nvm.sh ];  then source ~/.nvm/nvm.sh; fi",
+  "if [ -f ./.nvmrc ]; then nvm install <<< .nvmrc; fi",
 ];
 
 export const getYarnInstall = (context: Context) => [

package/src/build/types.ts

@@ -75,6 +75,16 @@ export type BuildConfigBase = {
    * use to display information in merge requests, pipeline views and security dashboards.
    */
   artifactsReports?: BuildConfigArtifactsReports;
+
+  /**
+   * customize cache for the job
+   */
+  jobCache?: CatladderJob["cache"];
+
+  /**
+   * tags for the underlying job runner (e.g gitlab)
+   */
+  jobTags?: string[];
 };
 
 export type BuildConfigNodeBase = BuildConfigBase;
@@ -123,11 +133,6 @@ export type BuildConfigCustom = Omit<
 
   docker: BuildConfigCustomDocker;
 
-  /**
-   * customize cache for the job
-   */
-  jobCache?: CatladderJob["cache"];
-
   /**
    * custom lint, disabled when not set
    */

package/src/context/getEnvironmentVariables.ts

@@ -39,9 +39,12 @@ export const getEnvironmentVariables = async (
     ENV_SHORT: env,
     APP_DIR: envConfigRaw.dir,
     ENV_TYPE: envType,
+    BUILD_INFO_ID: commitInfo?.buildId,
+    BUILD_INFO_BUILD_TIME: commitInfo?.buildTime,
+    BUILD_INFO_CURRENT_VERSION: commitInfo?.currentVersion,
   };
 
-  let predefinedVariables: Record<string, string>;
+  let predefinedVariables: Record<string, string | undefined>;
   let host: string;
   let url: string;
 

package/src/deploy/base.ts

@@ -1,7 +1,6 @@
 import { getDockerImageVariables, requiresDockerBuild } from "../build/docker";
 import type { Context } from "../types";
 import type { CatladderJob } from "../types/jobs";
-import { isOfDeployType } from "./types";
 import { contextIsStoppable } from "./utils";
 
 export const DEPLOY_JOB_NAME = "🚀 Deploy";
@@ -12,7 +11,7 @@ const DEPLOY_RUNNER_VARIABLES = {
   KUBERNETES_CPU_REQUEST: "0.5",
   KUBERNETES_CPU_LIMIT: "1",
   KUBERNETES_MEMORY_REQUEST: "200Mi",
-  KUBERNETES_MEMORY_LIMIT: "500Mi",
+  KUBERNETES_MEMORY_LIMIT: "200Mi",
 };
 type JobWithoutScript = Omit<CatladderJob, "script">;
 export const getBaseDeploymentJob = (context: Context): JobWithoutScript => {
@@ -77,6 +76,9 @@ export const getBaseDeploymentJob = (context: Context): JobWithoutScript => {
       ...DEPLOY_RUNNER_VARIABLES,
       ...context.environment.envVars,
       ...(hasDocker ? getDockerImageVariables(context) : {}),
+      ...(context.componentConfig.deploy
+        ? context.componentConfig.deploy.extraVars ?? {}
+        : {}),
     },
     environment: {
       ...context.environment.gitlabEnvironment,
@@ -87,6 +89,9 @@ export const getBaseDeploymentJob = (context: Context): JobWithoutScript => {
           }
         : {}),
     },
+    jobTags: context.componentConfig.deploy
+      ? context.componentConfig.deploy.jobTags
+      : undefined,
   };
 };
 

package/src/deploy/types/base.ts

@@ -11,6 +11,16 @@ export type DeployConfigBase = {
    * wait for other components to deploy first, before doing this deployment
    */
   waitFor?: string[];
+
+  /**
+   * tags for the underlying job runner (e.g gitlab)
+   */
+  jobTags?: string[];
+
+  /**
+   * additional env vars for the deploy job
+   */
+  extraVars?: Record<string, string>;
 };
 
 export type AllowUnknownProps<T extends Record<string, unknown>> = T &

package/src/pipeline/commitInfo/getBuildId.ts

@@ -4,3 +4,14 @@ export const getBuildId = async () =>
   await exec("git describe --tags || git rev-parse HEAD").then((s) =>
     s.stdout.trim()
   );
+
+// thx chat gpt
+/**
+ * returns the last tagged version string Major.minor.patch
+ * returns 0.0.0 if there is no tag
+ */
+export const getCurrentVersionString = async () => {
+  return await exec(
+    'latest_tag=$(git describe --tags --abbrev=0 2>/dev/null); if [ -z "$latest_tag" ]; then echo "0.0.0"; else echo "${latest_tag#v}"; fi | cut -d "." -f 1-3'
+  ).then((s) => s.stdout.trim());
+};

package/src/pipeline/commitInfo/getCommitInfo.ts

@@ -1,5 +1,5 @@
 import type { CommitInfo } from "../../types";
-import { getBuildId } from "./getBuildId";
+import { getBuildId, getCurrentVersionString } from "./getBuildId";
 export const getBaseCommitInfo = async (): Promise<
   Omit<CommitInfo, "trigger">
 > => ({
@@ -9,4 +9,5 @@ export const getBaseCommitInfo = async (): Promise<
     : "unknown",
   buildTime: new Date().toISOString(),
   buildId: await getBuildId(),
+  currentVersion: await getCurrentVersionString(),
 });

package/src/pipeline/gitlab/createGitlabJobs.ts

@@ -6,6 +6,10 @@ import type { AllCatladderJobs } from "../createAllJobs";
 
 type AllGitlabJobs = Record<string, GitlabJobDef>;
 
+const removeUndefined = <T extends Record<string, unknown>>(obj: T): T =>
+  Object.fromEntries(
+    Object.entries(obj).filter(([, value]) => value !== undefined)
+  ) as T;
 const getFullJobName = (
   name: string,
   componentName: string,
@@ -47,6 +51,7 @@ export const makeGitlabJob = (
     needsOtherComponent,
     name,
     needs,
+    jobTags,
     ...job
   }: CatladderJob<string>,
   allJobs: AllCatladderJobs
@@ -95,8 +100,9 @@ export const makeGitlabJob = (
     envMode !== "none" ? env : undefined
   );
 
-  const gitlabJob = {
+  const gitlabJob: GitlabJobDef = removeUndefined({
     ...job,
+    tags: jobTags,
     stage,
     environment: job.environment?.on_stop
       ? {
@@ -113,7 +119,7 @@ export const makeGitlabJob = (
     needs: gitlabNeeds,
     retry: BASE_RETRY,
     interruptible: true,
-  };
+  });
 
   return [fullJobName, gitlabJob];
 };

package/src/types/context.ts

@@ -35,6 +35,7 @@ export type CommitInfo = {
   buildTime: string;
   buildId: string;
   trigger: PipelineTrigger;
+  currentVersion: string;
 };
 
 type Workspace = {

package/src/types/gitlab-types.ts

@@ -77,6 +77,7 @@ export type GitlabJobDef = {
   environment?: GitlabEnvironment;
   allow_failure?: boolean;
   parallel?: number;
+  tags?: string[];
   trigger?: {
     strategy: "depend";
     include: Array<{

package/src/types/jobs.ts

@@ -109,4 +109,9 @@ export type CatladderJob<S = BaseStage> = {
    * We use the same shape as GitLab itself.
    */
   parallel?: number;
+
+  /**
+   * tags for the underlying job runner (e.g gitlab)
+   */
+  jobTags?: string[];
 };

package/src/utils/index.ts

@@ -6,7 +6,7 @@ export function notNil<TValue>(
   return value !== null && value !== undefined;
 }
 
-export const ensureArray = <T>(s: T | T[]): T[] | null =>
+export const ensureArray = <T>(s: undefined | T | T[]): T[] | null =>
   isNil(s) ? null : Array.isArray(s) ? s : [s];
 
 // see https://github.com/lodash/lodash/issues/5384