@catladder/cli 0.0.0-next-89bce6d0 → 0.0.0-next-ddc387fe

package/dist/bundles/catenv/index.js

@@ -2288,9 +2288,8 @@ const ciVariables_1 = __nccwpck_require__(88393);
 const index_1 = __nccwpck_require__(68906);
 const createGithubJobs_1 = __nccwpck_require__(57877);
 const jobImagesPlan_1 = __nccwpck_require__(47864);
-const scriptFunctions_1 = __nccwpck_require__(79252);
+const ensureImageJobs_1 = __nccwpck_require__(70051);
 const shippedCatci_1 = __nccwpck_require__(79024);
-const utils_1 = __nccwpck_require__(24516);
 const githubReleaseJobs_1 = __nccwpck_require__(89800);
 const scriptFiles_1 = __nccwpck_require__(30966);
 const WORKFLOWS_FOLDER = ".github/workflows";
@@ -2299,9 +2298,13 @@ const WORKFLOWS_FOLDER = ".github/workflows";
  * user-maintained workflows in the same folder
  */
 const GENERATED_FILE_PREFIX = "catladder-";
+// NOTE on the emoji prefixes: github sorts the Actions sidebar by raw
+// code point, so the 🛠️ (U+1F6E0) prefix makes the pipeline workflows
+// sort BELOW the triggerable action workflows (↩️ ⏹️ ▶️ 🚀, all lower
+// code points) — the things a human clicks come first.
 const TRIGGER_WORKFLOWS = {
     mr: {
-        name: "catladder review",
+        name: "🛠️ catladder review",
         on: { pull_request: { types: ["opened", "synchronize", "reopened"] } },
         concurrency: {
             group: "catladder-review-${{ github.event.number }}",
@@ -2309,12 +2312,12 @@ const TRIGGER_WORKFLOWS = {
         },
     },
     mainBranch: {
-        name: "catladder main",
+        name: "🛠️ catladder main",
         // TODO: make the default branch configurable
         on: { push: { branches: ["main"] } },
     },
     taggedRelease: {
-        name: "catladder release",
+        name: "🛠️ catladder release",
         // tags pushed with the default GITHUB_TOKEN (as the release job
         // does) don't trigger `on: push: tags` — the release job therefore
         // also dispatches this workflow explicitly for the new tag
@@ -2364,15 +2367,18 @@ class GithubBackend {
             ...(0, index_1.getPipelineOptions)(config, this.type).runnerVariables,
         };
         const reviewStopJobs = {};
-        // jobs routed to the workflow_dispatch "manual tasks" workflow. A
-        // manual job and its build closure live here instead of an automatic
-        // workflow; `manualJobConditions` is the `if` that selects each one
-        // from the dispatch input, `manualDispatchOptions` the leaf jobs that
-        // become dropdown choices (closure jobs run because their leaf was
-        // chosen, not on their own).
-        const manualJobs = {};
-        const manualJobConditions = {};
-        const manualDispatchOptions = [];
+        // jobs routed to the per-kind workflow_dispatch workflows (deploy /
+        // stop / rollback). A manual job and its build closure live there
+        // instead of an automatic workflow; `conditions` is the `if` that
+        // selects each one from the dispatch input, `options` the leaf jobs
+        // that become dropdown choices (closure jobs run because their leaf
+        // was chosen, not on their own). A closure job serving leaves of
+        // several kinds is duplicated into each kind's workflow.
+        const manualKindBuckets = {
+            deploy: { jobs: {}, conditions: {}, options: [], envTypes: [] },
+            stop: { jobs: {}, conditions: {}, options: [], envTypes: [] },
+            rollback: { jobs: {}, conditions: {}, options: [], envTypes: [] },
+        };
         for (const trigger of config_1.ALL_PIPELINE_TRIGGERS) {
             const allJobs = await (0, createAllJobs_1.createAllJobs)({
                 config,
@@ -2449,32 +2455,46 @@ class GithubBackend {
                     }
                 }
             }
+            const kindOfLeaf = new Map(leafIds.map((id) => [id, manualKind(triggerJobs.get(id).job)]));
             const jobs = {};
             for (const [id, { githubJob }] of triggerJobs) {
                 const leaves = servesLeaves.get(id);
                 if (leaves) {
-                    manualJobs[id] = githubJob;
-                    manualJobConditions[id] = [...leaves]
-                        .sort()
-                        .map((leaf) => `inputs.job == '${leaf}'`)
-                        .join(" || ");
+                    // one entry per kind the job serves — restricted to that
+                    // kind's leaves, so the `if` only references its own inputs
+                    for (const kind of new Set([...leaves].map((leaf) => kindOfLeaf.get(leaf)))) {
+                        const bucket = manualKindBuckets[kind];
+                        bucket.jobs[id] = githubJob;
+                        bucket.conditions[id] = [...leaves]
+                            .filter((leaf) => kindOfLeaf.get(leaf) === kind)
+                            .sort()
+                            .map((leaf) => `inputs.job == '${leaf}'`)
+                            .join(" || ");
+                    }
                 }
                 else {
                     jobs[id] = githubJob;
                 }
             }
-            manualDispatchOptions.push(...leafIds);
+            for (const id of leafIds) {
+                const bucket = manualKindBuckets[kindOfLeaf.get(id)];
+                bucket.options.push(id);
+                const context = triggerJobs.get(id).context;
+                if (context.type === "component") {
+                    bucket.envTypes.push(context.environment.envType);
+                }
+            }
             if (trigger === "mr") {
                 Object.assign(jobs, (0, githubReleaseJobs_1.getGithubReleaseCheckJobs)(config, images));
             }
             if (trigger === "mainBranch") {
-                const releaseJobs = (0, githubReleaseJobs_1.getGithubReleaseJobs)(config, Object.keys(jobs), images);
-                Object.assign(jobs, releaseJobs.main);
-                for (const [id, job] of Object.entries(releaseJobs.manual)) {
-                    manualJobs[id] = job;
-                    manualJobConditions[id] = `inputs.job == '${id}'`;
-                    manualDispatchOptions.push(id);
-                }
+                // auto release mode: the release job runs at the end of the
+                // main workflow itself
+                Object.assign(jobs, (0, githubReleaseJobs_1.getGithubReleaseJobs)(config, Object.keys(jobs), images));
+                // the dispatch workflow to trigger a release by hand (with a
+                // force checkbox where the method distinguishes it)
+                workflows[`${GENERATED_FILE_PREFIX}create-release.yml`] =
+                    (0, githubReleaseJobs_1.getGithubCreateReleaseWorkflow)(config, images, workflowEnv);
                 // manual release mode: the workflow that runs a queued release
                 // once the main workflow completed green
                 const releaseOnGreen = (0, githubReleaseJobs_1.getGithubReleaseOnGreenWorkflow)(config, images, TRIGGER_WORKFLOWS.mainBranch.name, workflowEnv);
@@ -2488,41 +2508,59 @@ class GithubBackend {
                     ...TRIGGER_WORKFLOWS[trigger],
                     ...workflowPermissions(images),
                     env: workflowEnv,
-                    jobs: { ...makeEnsureImageGithubJobs(images), ...jobs },
+                    jobs: { ...(0, ensureImageJobs_1.makeEnsureImageGithubJobs)(images), ...jobs },
                 };
             }
         }
         if (Object.keys(reviewStopJobs).length > 0) {
             workflows[`${GENERATED_FILE_PREFIX}review-stop.yml`] = {
-                name: "catladder review stop",
+                name: "🛠️ catladder review stop",
                 on: { pull_request: { types: ["closed"] } },
                 ...workflowPermissions(images),
                 env: workflowEnv,
-                jobs: { ...makeEnsureImageGithubJobs(images), ...reviewStopJobs },
+                jobs: { ...(0, ensureImageJobs_1.makeEnsureImageGithubJobs)(images), ...reviewStopJobs },
             };
         }
-        if (Object.keys(manualJobs).length > 0) {
-            workflows[`${GENERATED_FILE_PREFIX}manual.yml`] = {
-                name: "catladder manual tasks",
+        for (const [kind, bucket] of Object.entries(manualKindBuckets)) {
+            if (Object.keys(bucket.jobs).length === 0) {
+                continue;
+            }
+            const options = [...new Set(bucket.options)];
+            // a single candidate needs no dropdown — the dispatch just runs it
+            const singleTask = options.length === 1;
+            // one common env across the kind's tasks → carry it in the name
+            // ("▶️ catladder deploy prod"); mixed envs keep the generic name
+            // and the dropdown distinguishes
+            const envTypes = [...new Set(bucket.envTypes)];
+            const envSuffix = envTypes.length === 1 &&
+                bucket.envTypes.length === bucket.options.length
+                ? ` ${envTypes[0]}`
+                : "";
+            workflows[`${GENERATED_FILE_PREFIX}${kind}.yml`] = {
+                name: `${MANUAL_KIND_WORKFLOW_NAMES[kind]}${envSuffix}`,
                 on: {
-                    workflow_dispatch: {
-                        inputs: {
-                            job: {
-                                description: "the task to run",
-                                required: true,
-                                type: "choice",
-                                options: [...new Set(manualDispatchOptions)],
+                    workflow_dispatch: singleTask
+                        ? {}
+                        : {
+                            inputs: {
+                                job: {
+                                    description: "the task to run",
+                                    required: true,
+                                    type: "choice",
+                                    options,
+                                },
                             },
                         },
-                    },
                 },
                 ...workflowPermissions(images),
                 env: workflowEnv,
                 jobs: {
-                    ...makeEnsureImageGithubJobs(images),
-                    ...Object.fromEntries(Object.entries(manualJobs).map(([id, job]) => [
+                    ...(0, ensureImageJobs_1.makeEnsureImageGithubJobs)(images),
+                    ...Object.fromEntries(Object.entries(bucket.jobs).map(([id, job]) => [
                         id,
-                        { ...job, if: `\${{ ${manualJobConditions[id]} }}` },
+                        singleTask
+                            ? job
+                            : { ...job, if: `\${{ ${bucket.conditions[id]} }}` },
                     ])),
                 },
             };
@@ -2537,33 +2575,6 @@ exports.GithubBackend = GithubBackend;
 const workflowPermissions = (_images) => ({
     permissions: { contents: "read", packages: "write" },
 });
-/**
- * the image build jobs: always run (github has no server-side
- * changes-filter), the existence check makes unchanged runs fast.
- * Docker is native on github runners — no container, no dind.
- */
-const makeEnsureImageGithubJobs = (images) => Object.fromEntries(images.getEnsureJobs().map((job) => {
-    var _a, _b;
-    return [
-        (0, createGithubJobs_1.githubGlobalJobId)(job.name),
-        {
-            name: job.name,
-            "runs-on": "ubuntu-latest",
-            steps: [
-                { name: "Checkout", uses: "actions/checkout@v4" },
-                {
-                    name: job.name,
-                    id: "main",
-                    run: [
-                        ...(0, scriptFunctions_1.getGithubScriptFunctionDefinitions)(),
-                        ...((_b = (_a = job.script) === null || _a === void 0 ? void 0 : _a.filter(utils_1.notNil)) !== null && _b !== void 0 ? _b : []),
-                    ].join("\n"),
-                    shell: "bash",
-                },
-            ],
-        },
-    ];
-}));
 const workflowFileName = (trigger) => {
     switch (trigger) {
         case "mr":
@@ -2587,10 +2598,20 @@ const isReviewStopJob = (context, job) => {
 };
 /**
  * stop/rollback jobs of non-review environments have no automatic
- * trigger; they are collected in a workflow_dispatch workflow
+ * trigger; they are collected in workflow_dispatch workflows
  * (gitlab runs them as manual jobs inside the pipeline)
  */
 const isManualTaskJob = (job) => job.stage === "stop" || job.stage === "rollback";
+const MANUAL_KIND_WORKFLOW_NAMES = {
+    deploy: "▶️ catladder deploy",
+    stop: "⏹️ catladder stop",
+    rollback: "↩️ catladder rollback",
+};
+const manualKind = (job) => job.stage === "stop"
+    ? "stop"
+    : job.stage === "rollback"
+        ? "rollback"
+        : "deploy";
 //# sourceMappingURL=GithubBackend.js.map
 
 /***/ }),
@@ -3020,17 +3041,78 @@ exports.getUploadProviderIds = getUploadProviderIds;
 
 /***/ }),
 
+/***/ 70051:
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.makeEnsureImageGithubJobs = void 0;
+const createGithubJobs_1 = __nccwpck_require__(57877);
+const scriptFunctions_1 = __nccwpck_require__(79252);
+const utils_1 = __nccwpck_require__(24516);
+/**
+ * the image build jobs: always run (github has no server-side
+ * changes-filter), the existence check makes unchanged runs fast.
+ * Docker is native on github runners — no container, no dind.
+ * `only` restricts to the named images (e.g. the create-release
+ * workflow needs just the release image).
+ */
+const makeEnsureImageGithubJobs = (images, options = {}) => Object.fromEntries(images
+    .getEnsureJobs()
+    .filter((job) => !options.only || options.only.includes(job.name))
+    .map((job) => {
+    var _a, _b;
+    return [
+        (0, createGithubJobs_1.githubGlobalJobId)(job.name),
+        {
+            name: job.name,
+            "runs-on": "ubuntu-latest",
+            steps: [
+                { name: "Checkout", uses: "actions/checkout@v4" },
+                {
+                    name: job.name,
+                    id: "main",
+                    run: [
+                        ...(0, scriptFunctions_1.getGithubScriptFunctionDefinitions)(),
+                        ...((_b = (_a = job.script) === null || _a === void 0 ? void 0 : _a.filter(utils_1.notNil)) !== null && _b !== void 0 ? _b : []),
+                    ].join("\n"),
+                    shell: "bash",
+                },
+            ],
+        },
+    ];
+}));
+exports.makeEnsureImageGithubJobs = makeEnsureImageGithubJobs;
+//# sourceMappingURL=ensureImageJobs.js.map
+
+/***/ }),
+
 /***/ 89800:
 /***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
 
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.getGithubReleaseCheckJobs = exports.getGithubReleaseOnGreenWorkflow = exports.getGithubReleaseJobs = void 0;
+exports.getGithubReleaseCheckJobs = exports.getGithubReleaseOnGreenWorkflow = exports.getGithubCreateReleaseWorkflow = exports.getGithubReleaseJobs = void 0;
 const createGithubJobs_1 = __nccwpck_require__(57877);
+const ensureImageJobs_1 = __nccwpck_require__(70051);
 const release_1 = __nccwpck_require__(38904);
 const shippedCatci_1 = __nccwpck_require__(79024);
 const CATCI = `${shippedCatci_1.GENERATED_CATCI_FOLDER}/index.js`;
+/**
+ * the build job of the release image only — the create-release
+ * dispatch workflow needs no other image (empty for external images)
+ */
+const makeReleaseImageEnsureJobs = (config, images) => {
+    const resolved = images.resolveRef({
+        catladderImage: (0, release_1.getReleaseMethod)(config).image,
+    });
+    if (!resolved.need || typeof resolved.need !== "object") {
+        return {};
+    }
+    return (0, ensureImageJobs_1.makeEnsureImageGithubJobs)(images, { only: [resolved.need.job] });
+};
 const createReleaseJob = (config, images, options = {}) => {
     var _a;
     const method = (0, release_1.getReleaseMethod)(config);
@@ -3084,6 +3166,7 @@ const createReleaseJob = (config, images, options = {}) => {
                     {
                         name: "check main workflow",
                         id: "queue",
+                        ...(options.queueCheckIf ? { if: options.queueCheckIf } : {}),
                         run: `node ${CATCI} release github-queue-check`,
                         shell: "bash",
                     },
@@ -3101,51 +3184,75 @@ const createReleaseJob = (config, images, options = {}) => {
     };
 };
 /**
- * the release jobs for the github backend (the counterpart of the
- * gitlab release jobs):
- * - releases.when === "auto": the release job runs in the main-branch
- *   workflow after all other jobs; a force variant goes to the manual
- *   tasks workflow
- * - otherwise (manual, the default): the release job goes to the
- *   manual tasks workflow. Its queue-check step releases right away on
- *   a green main run and otherwise queues the release for the
- *   release-on-green workflow (see getGithubReleaseOnGreenWorkflow) —
- *   the counterpart of gitlab's queue button + executor pair.
+ * the release jobs of the main-branch workflow: with releases.when ===
+ * "auto" the release runs at the end of every main workflow run.
+ * Manual releasing happens via the create-release dispatch workflow
+ * (see getGithubCreateReleaseWorkflow) instead.
  */
 const getGithubReleaseJobs = (config, mainWorkflowJobIds, images) => {
     var _a;
-    const method = (0, release_1.getReleaseMethod)(config);
-    if (((_a = config.releases) === null || _a === void 0 ? void 0 : _a.when) === "auto") {
-        return {
-            main: {
-                "create-release": createReleaseJob(config, images, {
-                    needs: mainWorkflowJobIds,
-                }),
-            },
-            manual: {
-                "force-create-release": createReleaseJob(config, images, {
-                    extraEnv: method.forceReleaseVariables,
-                }),
-            },
-        };
+    if (((_a = config.releases) === null || _a === void 0 ? void 0 : _a.when) !== "auto") {
+        return {};
     }
     return {
-        main: {},
-        manual: {
-            "create-release": createReleaseJob(config, images, { queueCheck: true }),
-            // an explicit force option wherever the method distinguishes it
-            // (e.g. changesets: release a patch bump without changesets)
-            ...(method.forceReleaseVariables
+        "create-release": createReleaseJob(config, images, {
+            needs: mainWorkflowJobIds,
+        }),
+    };
+};
+exports.getGithubReleaseJobs = getGithubReleaseJobs;
+/**
+ * the dispatch workflow to trigger a release by hand — a first-class
+ * entry in the Actions sidebar (the counterpart of gitlab's `create
+ * release` button). Its queue-check step releases right away when the
+ * main workflow run for HEAD is green and otherwise queues the release
+ * for the release-on-green workflow. Where the release method
+ * distinguishes a force mode (e.g. changesets: release a patch bump
+ * without pending changesets), forcing is a checkbox input — a forced
+ * release skips the queue-check and releases immediately, whatever the
+ * pipeline state.
+ */
+const getGithubCreateReleaseWorkflow = (config, images, workflowEnv) => {
+    const method = (0, release_1.getReleaseMethod)(config);
+    const forceVariables = method.forceReleaseVariables;
+    const job = createReleaseJob(config, images, {
+        queueCheck: true,
+        ...(forceVariables
+            ? {
+                queueCheckIf: "${{ !inputs.force }}",
+                // only effective when the force checkbox is ticked
+                extraEnv: Object.fromEntries(Object.entries(forceVariables).map(([key, value]) => [
+                    key,
+                    `\${{ inputs.force && '${value}' || '' }}`,
+                ])),
+            }
+            : {}),
+    });
+    return {
+        name: "🚀 catladder create release",
+        on: {
+            workflow_dispatch: forceVariables
                 ? {
-                    "force-create-release": createReleaseJob(config, images, {
-                        extraEnv: method.forceReleaseVariables,
-                    }),
+                    inputs: {
+                        force: {
+                            description: "force: release even without pending changes (patch bump), ignoring the pipeline state",
+                            required: false,
+                            type: "boolean",
+                            default: false,
+                        },
+                    },
                 }
-                : {}),
+                : {},
+        },
+        permissions: { contents: "read", packages: "write" },
+        env: workflowEnv,
+        jobs: {
+            ...makeReleaseImageEnsureJobs(config, images),
+            "create-release": job,
         },
     };
 };
-exports.getGithubReleaseJobs = getGithubReleaseJobs;
+exports.getGithubCreateReleaseWorkflow = getGithubCreateReleaseWorkflow;
 /**
  * the release-on-green workflow (manual release mode only): runs on
  * every completed main workflow run. A lightweight host job checks the
@@ -3164,7 +3271,7 @@ const getGithubReleaseOnGreenWorkflow = (config, images, mainWorkflowName, workf
         return null;
     }
     return {
-        name: "catladder release on green",
+        name: "🛠️ catladder release on green",
         on: {
             workflow_run: {
                 workflows: [mainWorkflowName],