@bakers-build/addon-forge-gitlab 0.0.0-stage → 0.8.1-next.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 keytec GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,5 @@
-# Temporary Holding Version
+# @bakers-build/addon-forge-gitlab
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+bakers.build forge backend for GitLab: a Project Access Token (role Developer, with an expiry date). Implements @bakers-build/addon-forge's ForgeBackend contract.
+
+Part of the bakers.build CLI. Install the meta package `@bakers-build/bakers` to get the `bakers` CLI with all addons. Source: https://github.com/bakers-build/bakers-build (bakers-cli/).

package/dist/src/index.d.ts

@@ -0,0 +1,3 @@
+import { type ForgeBackendFactory } from '@bakers-build/addon-forge/backend';
+declare const factory: ForgeBackendFactory;
+export default factory;

package/dist/src/index.js

@@ -0,0 +1,132 @@
+// The GitLab forge backend: a Project Access Token (role Developer, with an
+// expiry date) for the one configured project, or, with `auth: 'glab'`, the
+// conductor's own `glab` login. Every merge sends `squash`
+// and `should_remove_source_branch` explicitly, so nothing stored on the MR
+// or the project decides them.
+import { cliToken, requestJson, } from '@bakers-build/addon-forge/backend';
+const prOf = (m) => ({
+    number: m.iid,
+    url: m.web_url,
+    head: m.source_branch,
+    base: m.target_branch,
+    title: m.title,
+    headSha: m.sha,
+});
+function statusOf(status) {
+    if (status === 'success' || status === 'skipped')
+        return 'success';
+    if (status === 'failed' || status === 'canceled')
+        return 'failure';
+    return 'pending';
+}
+const factory = async (raw, context) => {
+    const s = (raw ?? {});
+    if (typeof s.project !== 'string' || !s.project.includes('/'))
+        throw new Error("project must be the project path, e.g. 'group/repo'");
+    const base = (typeof s.url === 'string' ? s.url : 'https://gitlab.com').replace(/\/+$/, '');
+    const seen = [];
+    let token;
+    if (s.auth === 'glab') {
+        token = cliToken('glab', ['config', 'get', 'token', '--host', new URL(base).host], seen);
+    }
+    else if (s.auth !== undefined) {
+        throw new Error("auth must be 'glab' or left out for a token");
+    }
+    else {
+        const fixed = typeof s.token === 'string'
+            ? s.token
+            : typeof s.token_env === 'string'
+                ? process.env[s.token_env]
+                : undefined;
+        if (!fixed)
+            throw new Error('token or token_env (naming a set environment variable) must give the Project Access Token');
+        seen.push(fixed);
+        token = async () => fixed;
+    }
+    const basic = (t) => Buffer.from(`oauth2:${t}`).toString('base64');
+    const doFetch = context.fetch ?? fetch;
+    const project = `${base}/api/v4/projects/${encodeURIComponent(s.project)}`;
+    const api = async (path, init = {}) => requestJson(doFetch, `${project}${path}`, {
+        method: init.method ?? 'GET',
+        // Bearer takes access tokens and the OAuth token a `glab` login holds.
+        headers: {
+            authorization: `Bearer ${await token()}`,
+            'content-type': 'application/json',
+        },
+        ...(init.body === undefined ? {} : { body: JSON.stringify(init.body) }),
+    });
+    const mr = async (iid) => (await api(`/merge_requests/${iid}`));
+    const q = encodeURIComponent;
+    const backend = {
+        id: 'gitlab',
+        secrets: () => seen.flatMap((t) => [t, basic(t)]),
+        gitAuth: async () => ({
+            url: `${base}/${s.project}.git`,
+            header: `Authorization: Basic ${basic(await token())}`,
+        }),
+        findOpenPr: async (head) => {
+            const list = (await api(`/merge_requests?state=opened&source_branch=${q(head)}`));
+            const found = list.find((m) => m.source_branch === head);
+            return found && prOf(found);
+        },
+        createPr: async ({ head, base: target, title, body }) => prOf((await api('/merge_requests', {
+            method: 'POST',
+            body: {
+                source_branch: head,
+                target_branch: target,
+                title,
+                description: body,
+            },
+        }))),
+        updatePr: async (pr, { title, body }) => prOf((await api(`/merge_requests/${pr.number}`, {
+            method: 'PUT',
+            body: { title, description: body },
+        }))),
+        openPrsWithBase: async (target) => (await api(`/merge_requests?state=opened&target_branch=${q(target)}&per_page=100`))
+            .filter((m) => m.target_branch === target)
+            .map(prOf),
+        checks: async (ref) => {
+            const by = /^[0-9a-f]{40}$/.test(ref) ? `sha=${ref}` : `ref=${q(ref)}`;
+            const [pipeline] = (await api(`/pipelines?${by}&order_by=id&sort=desc&per_page=1`));
+            if (!pipeline)
+                return [{ name: 'pipeline', status: 'missing', required: true }];
+            const jobs = (await api(`/pipelines/${pipeline.id}/jobs?per_page=100`));
+            return [
+                { name: 'pipeline', status: statusOf(pipeline.status), required: true },
+                ...jobs.map((j) => ({
+                    name: j.name,
+                    status: statusOf(j.status),
+                    required: !j.allow_failure,
+                })),
+            ];
+        },
+        mergeBlocker: async (pr) => {
+            const m = await mr(pr.number);
+            if (m.has_conflicts)
+                return 'merge conflict with its target';
+            if (m.detailed_merge_status === 'checking' ||
+                m.detailed_merge_status === 'unchecked')
+                return 'mergeability is not computed yet; call again shortly';
+            return undefined;
+        },
+        merge: async (pr, o) => {
+            if (!o.deleteSource && (await mr(pr.number)).force_remove_source_branch)
+                throw new Error(`MR ${pr.url} stores force_remove_source_branch: true, but its source must be kept; the branch owner clears it before the merge`);
+            const message = `${o.subject}\n\n${o.body}`;
+            await api(`/merge_requests/${pr.number}/merge`, {
+                method: 'PUT',
+                body: {
+                    squash: o.method === 'squash',
+                    should_remove_source_branch: o.deleteSource,
+                    sha: pr.headSha,
+                    [o.method === 'squash'
+                        ? 'squash_commit_message'
+                        : 'merge_commit_message']: message,
+                },
+            });
+        },
+        isMerged: async (pr) => (await mr(pr.number)).state === 'merged',
+    };
+    return backend;
+};
+export default factory;

package/options.schema.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://bakers.build/schema/addon-forge-gitlab/options.schema.json",
+  "title": "@bakers-build/addon-forge-gitlab options",
+  "description": "The forge entry's with.backend.with: a Project Access Token, or the conductor's glab login with auth 'glab'.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "project"
+  ],
+  "properties": {
+    "url": {
+      "type": "string",
+      "pattern": "^https?://",
+      "description": "Default https://gitlab.com."
+    },
+    "project": {
+      "type": "string",
+      "pattern": "/",
+      "description": "The project path, e.g. group/repo."
+    },
+    "auth": {
+      "const": "glab",
+      "description": "Use the conductor's own glab login instead of a token."
+    },
+    "token": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The Project Access Token; machine config only."
+    },
+    "token_env": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Names the conductor environment variable that holds the credential."
+    }
+  }
+}

package/package.json

@@ -1,6 +1,31 @@
 {
   "name": "@bakers-build/addon-forge-gitlab",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.8.1-next.2",
+  "description": "bakers.build forge backend for GitLab: a Project Access Token (role Developer, with an expiry date). Implements @bakers-build/addon-forge's ForgeBackend contract.",
+  "type": "module",
+  "license": "MIT",
+  "exports": {
+    ".": "./dist/src/index.js",
+    "./options.schema.json": "./options.schema.json"
+  },
+  "files": [
+    "dist/src",
+    "options.schema.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bakers-build/bakers-build.git",
+    "directory": "bakers-cli/addons/forge-gitlab"
+  },
+  "peerDependencies": {
+    "@bakers-build/addon-forge": "^0.8.1-next.2",
+    "@bakers-build/core": "^0.8.1-next.2"
+  },
+  "bakersBuild": {
+    "commit": "0177880667693d1c36c65ffced82d2f3a17cbf2a",
+    "channel": "next"
+  }
+}