@intentius/chant-lexicon-gitlab 0.124.31 → 0.124.32

package/dist/composites/catalog.js

@@ -0,0 +1,418 @@
+export const compositeCatalog = [
+    {
+        "name": "BunPipeline",
+        "lexicon": "gitlab",
+        "description": "NodePipeline preset for Bun projects.",
+        "bundles": [
+            "Default",
+            "Job"
+        ],
+        "params": [
+            {
+                "name": "defaults",
+                "type": "{ defaults?: Partial<ConstructorParameters<typeof Default>[0]>; build?: Partial<ConstructorParameters<typeof Job>[0]>...",
+                "required": false,
+                "description": "Per-member defaults for customizing the generated resources."
+            },
+            {
+                "name": "nodeVersion",
+                "type": "string",
+                "required": false,
+                "description": "Node.js version."
+            },
+            {
+                "name": "installCommand",
+                "type": "string",
+                "required": false,
+                "description": "Override auto-detected install command"
+            },
+            {
+                "name": "buildScript",
+                "type": "string",
+                "required": false,
+                "description": "Build script name (runs via package manager)."
+            },
+            {
+                "name": "buildArtifactPaths",
+                "type": "string[]",
+                "required": false,
+                "description": "Artifact paths from build."
+            },
+            {
+                "name": "artifactExpiry",
+                "type": "string",
+                "required": false,
+                "description": "Artifact expiry."
+            },
+            {
+                "name": "testScript",
+                "type": "string",
+                "required": false,
+                "description": "Test script name."
+            },
+            {
+                "name": "packageManager",
+                "type": "\"npm\" | \"pnpm\" | \"bun\"",
+                "required": false,
+                "description": "Package manager."
+            }
+        ]
+    },
+    {
+        "name": "DockerBuild",
+        "lexicon": "gitlab",
+        "description": "Bundles Job.",
+        "bundles": [
+            "Job"
+        ],
+        "params": [
+            {
+                "name": "stage",
+                "type": "string",
+                "required": false,
+                "description": "Job stage."
+            },
+            {
+                "name": "tag",
+                "type": "string",
+                "required": false,
+                "description": "Image tag."
+            },
+            {
+                "name": "dockerfile",
+                "type": "string",
+                "required": false,
+                "description": "Dockerfile path."
+            },
+            {
+                "name": "context",
+                "type": "string",
+                "required": false,
+                "description": "Build context."
+            },
+            {
+                "name": "registry",
+                "type": "string",
+                "required": false,
+                "description": "Container registry."
+            },
+            {
+                "name": "image",
+                "type": "string",
+                "required": false,
+                "description": "Full image name."
+            },
+            {
+                "name": "tagLatest",
+                "type": "boolean",
+                "required": false,
+                "description": "Tag as :latest on default branch."
+            },
+            {
+                "name": "buildArgs",
+                "type": "Record<string, string>",
+                "required": false,
+                "description": "Extra docker build --build-arg flags"
+            },
+            {
+                "name": "rules",
+                "type": "InstanceType<typeof Rule>[]",
+                "required": false,
+                "description": "Job rules."
+            },
+            {
+                "name": "dockerVersion",
+                "type": "string",
+                "required": false,
+                "description": "Docker version."
+            },
+            {
+                "name": "defaults",
+                "type": "{ build?: Partial<ConstructorParameters<typeof Job>[0]>; }",
+                "required": false,
+                "description": "Per-member defaults for customizing the build job."
+            }
+        ]
+    },
+    {
+        "name": "MrPlanReport",
+        "lexicon": "gitlab",
+        "description": "A CI job that publishes `chant lifecycle plan` as the GitLab merge-request plan widget.",
+        "bundles": [
+            "Job"
+        ],
+        "params": [
+            {
+                "name": "environment",
+                "type": "string",
+                "required": true,
+                "description": "Lifecycle environment to plan against — the `<environment>` argument of `chant lifecycle plan`."
+            },
+            {
+                "name": "lexicon",
+                "type": "string",
+                "required": false,
+                "description": "Restrict the plan to one lexicon (the optional `[lexicon]` argument)."
+            },
+            {
+                "name": "stage",
+                "type": "string",
+                "required": false,
+                "description": "Stage for the plan job."
+            },
+            {
+                "name": "image",
+                "type": "string",
+                "required": false,
+                "description": "Image to run chant in."
+            },
+            {
+                "name": "ownedOnly",
+                "type": "boolean",
+                "required": false,
+                "description": "Plan against chant-owned resources only (passes `--owned`)."
+            },
+            {
+                "name": "reportFile",
+                "type": "string",
+                "required": false,
+                "description": "Artifact filename the report is written to."
+            },
+            {
+                "name": "before",
+                "type": "string[]",
+                "required": false,
+                "description": "Commands to run before the plan — typically cloud-credential setup, since the plan queries the live system to classify create/update/delete."
+            },
+            {
+                "name": "defaults",
+                "type": "{ plan?: Partial<ConstructorParameters<typeof Job>[0]>; }",
+                "required": false,
+                "description": "Per-member defaults for customizing the generated job."
+            }
+        ]
+    },
+    {
+        "name": "NodePipeline",
+        "lexicon": "gitlab",
+        "description": "Bundles Default, Job.",
+        "bundles": [
+            "Default",
+            "Job"
+        ],
+        "params": [
+            {
+                "name": "nodeVersion",
+                "type": "string",
+                "required": false,
+                "description": "Node.js version."
+            },
+            {
+                "name": "packageManager",
+                "type": "\"npm\" | \"pnpm\" | \"bun\"",
+                "required": false,
+                "description": "Package manager."
+            },
+            {
+                "name": "buildScript",
+                "type": "string",
+                "required": false,
+                "description": "Build script name (runs via package manager)."
+            },
+            {
+                "name": "testScript",
+                "type": "string",
+                "required": false,
+                "description": "Test script name."
+            },
+            {
+                "name": "buildArtifactPaths",
+                "type": "string[]",
+                "required": false,
+                "description": "Artifact paths from build."
+            },
+            {
+                "name": "artifactExpiry",
+                "type": "string",
+                "required": false,
+                "description": "Artifact expiry."
+            },
+            {
+                "name": "installCommand",
+                "type": "string",
+                "required": false,
+                "description": "Override auto-detected install command"
+            },
+            {
+                "name": "defaults",
+                "type": "{ defaults?: Partial<ConstructorParameters<typeof Default>[0]>; build?: Partial<ConstructorParameters<typeof Job>[0]>...",
+                "required": false,
+                "description": "Per-member defaults for customizing the generated resources."
+            }
+        ]
+    },
+    {
+        "name": "PnpmPipeline",
+        "lexicon": "gitlab",
+        "description": "NodePipeline preset for pnpm projects.",
+        "bundles": [
+            "Default",
+            "Job"
+        ],
+        "params": [
+            {
+                "name": "defaults",
+                "type": "{ defaults?: Partial<ConstructorParameters<typeof Default>[0]>; build?: Partial<ConstructorParameters<typeof Job>[0]>...",
+                "required": false,
+                "description": "Per-member defaults for customizing the generated resources."
+            },
+            {
+                "name": "nodeVersion",
+                "type": "string",
+                "required": false,
+                "description": "Node.js version."
+            },
+            {
+                "name": "installCommand",
+                "type": "string",
+                "required": false,
+                "description": "Override auto-detected install command"
+            },
+            {
+                "name": "buildScript",
+                "type": "string",
+                "required": false,
+                "description": "Build script name (runs via package manager)."
+            },
+            {
+                "name": "buildArtifactPaths",
+                "type": "string[]",
+                "required": false,
+                "description": "Artifact paths from build."
+            },
+            {
+                "name": "artifactExpiry",
+                "type": "string",
+                "required": false,
+                "description": "Artifact expiry."
+            },
+            {
+                "name": "testScript",
+                "type": "string",
+                "required": false,
+                "description": "Test script name."
+            },
+            {
+                "name": "packageManager",
+                "type": "\"npm\" | \"pnpm\" | \"bun\"",
+                "required": false,
+                "description": "Package manager."
+            }
+        ]
+    },
+    {
+        "name": "PythonPipeline",
+        "lexicon": "gitlab",
+        "description": "Bundles Default, Job.",
+        "bundles": [
+            "Default",
+            "Job"
+        ],
+        "params": [
+            {
+                "name": "pythonVersion",
+                "type": "string",
+                "required": false,
+                "description": "Python version."
+            },
+            {
+                "name": "testCommand",
+                "type": "string",
+                "required": false,
+                "description": "Test command."
+            },
+            {
+                "name": "lintCommand",
+                "type": "string | null",
+                "required": false,
+                "description": "Lint command."
+            },
+            {
+                "name": "requirementsFile",
+                "type": "string",
+                "required": false,
+                "description": "Requirements file."
+            },
+            {
+                "name": "usePoetry",
+                "type": "boolean",
+                "required": false,
+                "description": "Use poetry instead of pip."
+            },
+            {
+                "name": "defaults",
+                "type": "{ defaults?: Partial<ConstructorParameters<typeof Default>[0]>; test?: Partial<ConstructorParameters<typeof Job>[0]>;...",
+                "required": false,
+                "description": "Per-member defaults for customizing the generated resources."
+            }
+        ]
+    },
+    {
+        "name": "ReviewApp",
+        "lexicon": "gitlab",
+        "description": "Bundles Job.",
+        "bundles": [
+            "Job"
+        ],
+        "params": [
+            {
+                "name": "name",
+                "type": "string",
+                "required": true,
+                "description": "Base name for the jobs (e.g. \"review\" → review-deploy, review-stop in YAML)."
+            },
+            {
+                "name": "deployScript",
+                "type": "string | string[]",
+                "required": true,
+                "description": "Deploy script command(s)."
+            },
+            {
+                "name": "stopScript",
+                "type": "string | string[]",
+                "required": false,
+                "description": "Stop script command(s)."
+            },
+            {
+                "name": "urlPattern",
+                "type": "string",
+                "required": false,
+                "description": "Environment URL pattern."
+            },
+            {
+                "name": "autoStopIn",
+                "type": "string",
+                "required": false,
+                "description": "Auto-stop timer."
+            },
+            {
+                "name": "image",
+                "type": "InstanceType<typeof Image>",
+                "required": false,
+                "description": "Override image for both jobs."
+            },
+            {
+                "name": "stage",
+                "type": "string",
+                "required": false,
+                "description": "Job stage."
+            },
+            {
+                "name": "defaults",
+                "type": "{ deploy?: Partial<ConstructorParameters<typeof Job>[0]>; stop?: Partial<ConstructorParameters<typeof Job>[0]>; }",
+                "required": false,
+                "description": "Per-member defaults for customizing the deploy and stop jobs."
+            }
+        ]
+    }
+];

package/dist/composites/docker-build.js

@@ -0,0 +1,38 @@
+import { Composite, mergeDefaults } from "@intentius/chant";
+import { Job, Image, Service } from "../generated/index.js";
+import { CI } from "../variables.js";
+export const DockerBuild = Composite((props) => {
+    const { stage = "build", tag = CI.CommitRefSlug, dockerfile = "Dockerfile", context = ".", registry = CI.Registry, image = CI.RegistryImage, tagLatest = true, buildArgs, rules, dockerVersion = "27", defaults: defs, } = props;
+    const buildArgFlags = buildArgs
+        ? Object.entries(buildArgs)
+            .map(([k, v]) => `--build-arg ${k}=${v}`)
+            .join(" ")
+        : "";
+    const buildCmd = [
+        "docker build",
+        buildArgFlags,
+        `-t ${image}:${tag}`,
+        `-f ${dockerfile}`,
+        context,
+    ]
+        .filter(Boolean)
+        .join(" ");
+    const script = [buildCmd, `docker push ${image}:${tag}`];
+    if (tagLatest) {
+        script.push(`if [ "${CI.CommitBranch}" = "${CI.DefaultBranch}" ]; then docker tag ${image}:${tag} ${image}:latest && docker push ${image}:latest; fi`);
+    }
+    const build = new Job(mergeDefaults({
+        stage,
+        image: new Image({ name: `docker:${dockerVersion}-cli` }),
+        services: [new Service({ name: `docker:${dockerVersion}-dind`, alias: "docker" })],
+        variables: {
+            DOCKER_TLS_CERTDIR: "/certs",
+        },
+        before_script: [
+            `docker login -u ${CI.RegistryUser} -p ${CI.RegistryPassword} ${registry}`,
+        ],
+        script,
+        ...(rules ? { rules } : {}),
+    }, defs?.build));
+    return { build };
+}, "DockerBuild");

package/dist/composites/index.js

@@ -0,0 +1,5 @@
+export { DockerBuild } from "./docker-build.js";
+export { NodePipeline, BunPipeline, PnpmPipeline } from "./node-pipeline.js";
+export { PythonPipeline } from "./python-pipeline.js";
+export { ReviewApp } from "./review-app.js";
+export { MrPlanReport } from "./mr-plan-report.js";

package/dist/composites/mr-plan-report.js

@@ -0,0 +1,42 @@
+import { Composite, mergeDefaults } from "@intentius/chant";
+import { Job, Image, Artifacts } from "../generated/index.js";
+/**
+ * A CI job that publishes `chant lifecycle plan` as the GitLab merge-request
+ * plan widget.
+ *
+ * The job runs the plan with `--report gitlab-mr`, writes the count JSON to a
+ * file, and declares it as `artifacts:reports:terraform`. GitLab then renders
+ * "N to add, M to change, K to delete" on the MR — the same widget Terraform
+ * uses. The label reads "Terraform" regardless of producer; that is GitLab's
+ * fixed string. Counts are create/update/delete only — `adopt` and `noop` do
+ * not appear.
+ *
+ * The plan reads the live system to classify drift, so wire cloud credentials
+ * via `before` or CI variables.
+ */
+export const MrPlanReport = Composite((props) => {
+    const { environment, lexicon, stage = "plan", image = "node:22-alpine", ownedOnly = false, reportFile = "tfplan.json", before, defaults: defs, } = props;
+    const planArgs = [
+        "lifecycle",
+        "plan",
+        environment,
+        ...(lexicon ? [lexicon] : []),
+        ...(ownedOnly ? ["--owned"] : []),
+        "--report",
+        "gitlab-mr",
+    ].join(" ");
+    const plan = new Job(mergeDefaults({
+        stage,
+        image: new Image({ name: image }),
+        ...(before ? { before_script: before } : {}),
+        script: [
+            "npx chant build",
+            `npx chant ${planArgs} > ${reportFile}`,
+        ],
+        artifacts: new Artifacts({
+            reports: { terraform: reportFile },
+            when: "always",
+        }),
+    }, defs?.plan));
+    return { plan };
+}, "MrPlanReport");

package/dist/composites/node-pipeline.js

@@ -0,0 +1,67 @@
+import { Composite, mergeDefaults, withDefaults } from "@intentius/chant";
+import { Job, Default, Image, Cache, Artifacts } from "../generated/index.js";
+import { CI } from "../variables.js";
+const cacheConfig = {
+    npm: {
+        paths: [".npm/"],
+        keyFile: "package-lock.json",
+        envVars: { npm_config_cache: `${CI.ProjectDir}/.npm/` },
+        installCmd: "npm ci",
+        runPrefix: "npm run",
+    },
+    pnpm: {
+        paths: [".pnpm-store/"],
+        keyFile: "pnpm-lock.yaml",
+        envVars: {},
+        installCmd: "pnpm install --frozen-lockfile",
+        runPrefix: "pnpm run",
+    },
+    bun: {
+        paths: [".bun/install/cache"],
+        keyFile: "bun.lock",
+        envVars: {},
+        installCmd: "bun install --frozen-lockfile",
+        runPrefix: "bun run",
+    },
+};
+export const NodePipeline = Composite((props) => {
+    const { nodeVersion = "22", packageManager = "npm", buildScript = "build", testScript = "test", buildArtifactPaths = ["dist/"], artifactExpiry = "1 hour", installCommand, defaults: defs, } = props;
+    const pm = cacheConfig[packageManager];
+    const install = installCommand ?? pm.installCmd;
+    const run = pm.runPrefix;
+    const nodeImage = new Image({ name: `node:${nodeVersion}-alpine` });
+    const cache = new Cache({
+        key: { files: [pm.keyFile] },
+        paths: pm.paths,
+        policy: "pull-push",
+    });
+    const variables = Object.keys(pm.envVars).length > 0 ? pm.envVars : undefined;
+    const defaults = new Default(mergeDefaults({
+        image: nodeImage,
+        cache: [cache],
+        ...(variables ? {} : {}),
+    }, defs?.defaults));
+    const build = new Job(mergeDefaults({
+        stage: "build",
+        script: [install, `${run} ${buildScript}`],
+        artifacts: new Artifacts({
+            paths: buildArtifactPaths,
+            expire_in: artifactExpiry,
+        }),
+        ...(variables ? { variables } : {}),
+    }, defs?.build));
+    const test = new Job(mergeDefaults({
+        stage: "test",
+        script: [install, `${run} ${testScript}`],
+        artifacts: new Artifacts({
+            reports: { junit: "junit.xml" },
+            when: "always",
+        }),
+        ...(variables ? { variables } : {}),
+    }, defs?.test));
+    return { defaults, build, test };
+}, "NodePipeline");
+/** NodePipeline preset for Bun projects. */
+export const BunPipeline = withDefaults(NodePipeline, { packageManager: "bun" });
+/** NodePipeline preset for pnpm projects. */
+export const PnpmPipeline = withDefaults(NodePipeline, { packageManager: "pnpm" });

package/dist/composites/python-pipeline.js

@@ -0,0 +1,45 @@
+import { Composite, mergeDefaults } from "@intentius/chant";
+import { Job, Default, Image, Cache, Artifacts } from "../generated/index.js";
+import { CI } from "../variables.js";
+export const PythonPipeline = Composite((props) => {
+    const { pythonVersion = "3.12", testCommand = "pytest --junitxml=report.xml --cov", lintCommand = "ruff check .", requirementsFile = "requirements.txt", usePoetry = false, defaults: defs, } = props;
+    const pythonImage = new Image({ name: `python:${pythonVersion}-slim` });
+    const cache = new Cache({
+        key: { files: [usePoetry ? "poetry.lock" : requirementsFile] },
+        paths: [".pip-cache/", ".venv/"],
+        policy: "pull-push",
+    });
+    const installSteps = usePoetry
+        ? ["pip install poetry", "poetry config virtualenvs.in-project true", "poetry install"]
+        : [
+            "python -m venv .venv",
+            "source .venv/bin/activate",
+            `pip install -r ${requirementsFile}`,
+        ];
+    const activateStep = usePoetry ? "source .venv/bin/activate" : "source .venv/bin/activate";
+    const defaults = new Default(mergeDefaults({
+        image: pythonImage,
+        cache: [cache],
+        before_script: [...installSteps],
+    }, defs?.defaults));
+    const test = new Job(mergeDefaults({
+        stage: "test",
+        variables: { PIP_CACHE_DIR: `${CI.ProjectDir}/.pip-cache` },
+        script: [activateStep, testCommand],
+        artifacts: new Artifacts({
+            reports: { junit: "report.xml" },
+            when: "always",
+        }),
+    }, defs?.test));
+    const lint = lintCommand !== null
+        ? new Job(mergeDefaults({
+            stage: "test",
+            variables: { PIP_CACHE_DIR: `${CI.ProjectDir}/.pip-cache` },
+            script: [activateStep, lintCommand],
+        }, defs?.lint))
+        : undefined;
+    if (lint) {
+        return { defaults, test, lint };
+    }
+    return { defaults, test };
+}, "PythonPipeline");

package/dist/composites/review-app.js

@@ -0,0 +1,32 @@
+import { Composite, mergeDefaults } from "@intentius/chant";
+import { Job, Environment, Rule } from "../generated/index.js";
+import { CI } from "../variables.js";
+export const ReviewApp = Composite((props) => {
+    const { name, deployScript, stopScript = 'echo "Stopping review app..."', urlPattern = `https://${CI.EnvironmentSlug}.example.com`, autoStopIn = "1 week", image, stage = "deploy", defaults: defs, } = props;
+    const stopJobName = `${name}-stop`;
+    const deployScriptArr = Array.isArray(deployScript) ? deployScript : [deployScript];
+    const stopScriptArr = Array.isArray(stopScript) ? stopScript : [stopScript];
+    const deploy = new Job(mergeDefaults({
+        stage,
+        ...(image ? { image } : {}),
+        environment: new Environment({
+            name: `review/${CI.CommitRefSlug}`,
+            url: urlPattern,
+            auto_stop_in: autoStopIn,
+            on_stop: stopJobName,
+        }),
+        rules: [new Rule({ if: CI.MergeRequestIid })],
+        script: deployScriptArr,
+    }, defs?.deploy));
+    const stop = new Job(mergeDefaults({
+        stage,
+        ...(image ? { image } : {}),
+        environment: new Environment({
+            name: `review/${CI.CommitRefSlug}`,
+            action: "stop",
+        }),
+        rules: [new Rule({ if: CI.MergeRequestIid, when: "manual" })],
+        script: stopScriptArr,
+    }, defs?.stop));
+    return { deploy, stop };
+}, "ReviewApp");