@webship.co/workspace-github 0.0.0-stage → 1.0.0-alpha1

package/README.md

@@ -1,3 +1,32 @@
-# Temporary Holding Version
+# @webship.co/workspace-github
 
-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.
+GitHub for the [Webship Workspace](https://github.com/webship/workspace) dashboard: the **GITHUB**
+menu on every project whose git remote is on GitHub (open the repository, the open issues and
+pull requests, open one from the current branch, copy the clone URL), the repository chip on the
+card, "Clone a repository" when a new folder is made, and the credential the dashboard uses for the
+host. A provider of [`@webship.co/workspace-forge`](https://github.com/webship/workspace-forge).
+
+The lists come from `gh` (`gh issue list`, `gh pr list`) with the token in the environment, or from the REST API with `curl` when gh is not there; a pull request from the current branch is `gh pr create --head <branch> --fill` in a terminal in the project. The token also serves the dashboard's other GitHub work (the AI-items sync, the tooling repository): `github-auth.js` asks this plugin first, through `api.addForge('github.com', …)`.
+
+## Use it
+
+```bash
+cd ~/workspace
+bash core/scripts/plugins.sh --require github:webship/workspace-github
+bash core/scripts/plugins.sh --activate github
+bash core/scripts/plugins.sh --install github      # carries the git.github block of settings.yml into plugin.github.settings.yml
+bash core/scripts/plugins.sh --configure github
+```
+
+The same four steps are buttons on the dashboard's **Settings → Plugins** page.
+
+## What the package holds
+
+| Path | What it is |
+| --- | --- |
+| `src/index.ts` | `register(api)`: `registerForge(api, githubProvider(api))` |
+| `src/lib/provider.ts` | The GitHub provider: the host, the credential, how a remote reads, the pages, the issue and request lists, the clone URL |
+| `config/plugin.github.settings.yml` | The settings template |
+| `scripts/host-install.sh` | The host side: the CLI and the credential check |
+
+The `workspacePlugin` block in `package.json` is the manifest the installer reads.

package/config/plugin.github.settings.yml

@@ -0,0 +1,13 @@
+# GitHub — core/config/plugin.github.settings.yml
+#
+# How the dashboard reaches GitHub. gh's own login is used when it works (on the host); inside the dashboard container the token lives in the host keyring, which the container cannot read, so the token below is what the dashboard uses there. Never printed, never written to a job log.
+# github.com, or a GitHub Enterprise host.
+host: github.com
+# Authenticate with the gh CLI's own login when it works, and only fall back to the token below.
+use_gh_cli: true
+# The account name GitHub knows you by.
+username: CHANGE_ME
+# The address commits pushed to GitHub carry. Blank falls back to contributor.email.
+email: CHANGE_ME
+# A fine-grained personal access token (Settings → Developer settings). Read-only is enough for the lists and the AI-items sync; pull requests from the dashboard need write on the repositories.
+token: CHANGE_ME

package/config/settings.labels.yml

@@ -0,0 +1,16 @@
+# Labels for core/config/plugin.github.settings.yml, merged into the Settings page.
+host:
+  label: Host
+  info: 'github.com, or a GitHub Enterprise host.'
+use_gh_cli:
+  label: Prefer the gh login
+  info: 'Authenticate with the gh CLI''s own login when it works, and only fall back to the token below.'
+username:
+  label: Username
+  info: 'The account name GitHub knows you by.'
+email:
+  label: Commit email
+  info: 'The address commits pushed to GitHub carry. Blank falls back to contributor.email.'
+token:
+  label: Token
+  info: 'A fine-grained personal access token (Settings → Developer settings). Read-only is enough for the lists and the AI-items sync; pull requests from the dashboard need write on the repositories.'

package/ddev/docker-compose.github-cli.yaml

@@ -0,0 +1,7 @@
+# The gh CLI and its config, shared FROM THE HOST: the bin DIRECTORY is mounted, not the file,
+# so an update on the host is live in the container at once.
+services:
+  web:
+    volumes:
+      - "${HOME}/.local/bin:/host-local-bin:ro"
+      - "${HOME}/.config/gh:/home/${USER}/.config/gh:rw"

package/dist/src/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * GitHub for Webship Workspace.
+ *
+ * The GITHUB menu on every project whose git remote is on GitHub (the repository, open issues,
+ * open pull requests, open one from the current branch, the clone URL), the repository chip,
+ * "Clone a repository" when a new folder is made, and the credential the dashboard uses for the
+ * host. All of it is the forge family's surface (@webship.co/workspace-forge); this package is the
+ * GitHub provider plus its settings template and host install.
+ */
+import type { PluginApi } from '@webship.co/workspace-plugin-api';
+import { githubProvider } from './lib/provider';
+export { githubProvider };
+export declare function register(api: PluginApi): void;

package/dist/src/index.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * GitHub for Webship Workspace.
+ *
+ * The GITHUB menu on every project whose git remote is on GitHub (the repository, open issues,
+ * open pull requests, open one from the current branch, the clone URL), the repository chip,
+ * "Clone a repository" when a new folder is made, and the credential the dashboard uses for the
+ * host. All of it is the forge family's surface (@webship.co/workspace-forge); this package is the
+ * GitHub provider plus its settings template and host install.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.githubProvider = void 0;
+exports.register = register;
+const workspace_forge_1 = require("@webship.co/workspace-forge");
+const provider_1 = require("./lib/provider");
+Object.defineProperty(exports, "githubProvider", { enumerable: true, get: function () { return provider_1.githubProvider; } });
+function register(api) {
+    (0, workspace_forge_1.registerForge)(api, (0, provider_1.githubProvider)(api));
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AASH,4BAEC;AARD,iEAA4D;AAE5D,6CAAgD;AAEvC,+FAFA,yBAAc,OAEA;AAEvB,SAAgB,QAAQ,CAAC,GAAc;IACrC,IAAA,+BAAa,EAAC,GAAG,EAAE,IAAA,yBAAc,EAAC,GAAG,CAAC,CAAC,CAAC;AAC1C,CAAC"}

package/dist/src/lib/provider.d.ts

@@ -0,0 +1,9 @@
+/**
+ * GitHub, as a forge provider.
+ *
+ * gh does the lists and opens pull requests when it is there, with the token from
+ * plugin.github.settings.yml in its environment; without gh the REST API answers through curl.
+ */
+import type { PluginApi } from '@webship.co/workspace-plugin-api';
+import type { ForgeProvider } from '@webship.co/workspace-forge';
+export declare function githubProvider(api: PluginApi): ForgeProvider;

package/dist/src/lib/provider.js

@@ -0,0 +1,88 @@
+"use strict";
+/**
+ * GitHub, as a forge provider.
+ *
+ * gh does the lists and opens pull requests when it is there, with the token from
+ * plugin.github.settings.yml in its environment; without gh the REST API answers through curl.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.githubProvider = githubProvider;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const workspace_forge_1 = require("@webship.co/workspace-forge");
+const configured = (v) => { const s = String(v == null ? '' : v).trim(); return s && s !== 'CHANGE_ME' ? s : null; };
+function hasCli(name) {
+    for (const d of ['/host-local-bin', ...String(process.env.PATH || '').split(':')]) {
+        try {
+            fs_1.default.accessSync(path_1.default.join(d, name), fs_1.default.constants.X_OK);
+            return true;
+        }
+        catch (_) { /* next */ }
+    }
+    return false;
+}
+function githubProvider(api) {
+    const settings = () => api.settings.read() || {};
+    const host = () => String(configured(settings().host) || 'github.com').toLowerCase();
+    const apiBase = () => (host() === 'github.com' ? 'https://api.github.com' : `https://${host()}/api/v3`);
+    const env = () => {
+        const t = configured(settings().token);
+        if (!t)
+            return null;
+        const e = { ...process.env, GH_TOKEN: t };
+        if (host() !== 'github.com')
+            e.GH_HOST = host();
+        return e;
+    };
+    async function rest(lib, e, url) {
+        const headers = ['-H', 'Accept: application/vnd.github+json'];
+        if (e.GH_TOKEN)
+            headers.push('-H', `Authorization: Bearer ${e.GH_TOKEN}`);
+        const out = await lib.run('curl', ['-sS', '-m', '30', ...headers, url], process.env.HOME, { timeoutMs: 40 * 1000, env: process.env });
+        if (!out.ok)
+            throw new Error(lib.cliError(String(out.stderr || out.stdout)));
+        const data = JSON.parse(String(out.stdout));
+        if (data && data.message && !Array.isArray(data))
+            throw new Error(String(data.message));
+        return data;
+    }
+    async function list(kind, repo, lib, e) {
+        if (hasCli('gh')) {
+            const out = await lib.run('gh', [kind, 'list', '-R', `${host()}/${repo.path}`, '--state', 'open', '--limit', '20', '--json', 'number,title,url,author,updatedAt'], process.env.HOME, { timeoutMs: 40 * 1000, env: e });
+            if (out.ok) {
+                return JSON.parse(String(out.stdout) || '[]').map((i) => ({ number: i.number, title: i.title, url: i.url, author: i.author && i.author.login, updated: i.updatedAt }));
+            }
+            // gh is there but could not answer (no credential in this environment): the REST API may still, for a public repository.
+        }
+        const url = `${apiBase()}/repos/${repo.path}/${kind === 'pr' ? 'pulls' : 'issues'}?state=open&per_page=20`;
+        const data = await rest(lib, e, url);
+        return data.filter((i) => kind === 'pr' || !i.pull_request).map((i) => ({ number: i.number, title: i.title, url: i.html_url, author: i.user && i.user.login, updated: i.updated_at }));
+    }
+    return {
+        id: 'github',
+        label: 'GITHUB',
+        title: 'GitHub',
+        host,
+        cli: 'gh',
+        pullsLabel: 'Pull requests',
+        env,
+        auth: () => {
+            const s = settings();
+            return { username: configured(s.username) || undefined, email: configured(s.email) || undefined, how: configured(s.token) ? 'token' : (String(s.use_gh_cli) !== 'false' ? 'gh login' : 'none') };
+        },
+        repoOf: (url, remote) => { const p = (0, workspace_forge_1.repoPathAt)(host(), url); return p ? { path: p, web: `https://${host()}/${p}`, remote } : null; },
+        cloneUrl: (spec) => (/^(https?:\/\/|git@)/.test(spec) ? spec : `https://${host()}/${spec.replace(/\.git$/, '')}.git`),
+        urls: (repo) => ({ issues: `${repo.web}/issues`, pulls: `${repo.web}/pulls`, newIssue: `${repo.web}/issues/new`, newPull: (branch) => `${repo.web}/compare/${encodeURIComponent(branch)}?expand=1` }),
+        listIssues: (repo, lib, e) => list('issue', repo, lib, e),
+        listPulls: (repo, lib, e) => list('pr', repo, lib, e),
+        newPullCommand: (repo, branch) => `git push -u origin ${branch} && gh pr create -R ${host()}/${repo.path} --head ${branch} --fill`,
+        // git borrows gh's login for a private clone, the way the AI-items sync does; the token is in the environment when the dashboard runs it.
+        cloneEnv: () => `GIT_CONFIG_COUNT=1 GIT_CONFIG_KEY_0=credential.https://${host()}.helper GIT_CONFIG_VALUE_0='!gh auth git-credential'`,
+        clone: { pattern: /^[\w.-]+\/[\w.-]+$|^(https?:\/\/|git@)[\w.-]+[:/][\w./-]+$/, placeholder: 'webship/workspace', help: 'A GitHub repository is owner/name, or its clone URL.' },
+        tokenHint: 'token in core/config/plugin.github.settings.yml',
+    };
+}
+//# sourceMappingURL=provider.js.map

package/dist/src/lib/provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../../../src/lib/provider.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;AAiBH,wCA4DC;AA3ED,4CAAoB;AACpB,gDAAwB;AAExB,iEAAyD;AAGzD,MAAM,UAAU,GAAG,CAAC,CAAU,EAAE,EAAE,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAE9H,SAAS,MAAM,CAAC,IAAY;IAC1B,KAAK,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QAClF,IAAI,CAAC;YAAC,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,YAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAAC,OAAO,IAAI,CAAC;QAAC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC;IACrG,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAgB,cAAc,CAAC,GAAc;IAC3C,MAAM,QAAQ,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;IACjD,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,CAAC,WAAW,EAAE,CAAC;IACrF,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,YAAY,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,WAAW,IAAI,EAAE,SAAS,CAAC,CAAC;IAExG,MAAM,GAAG,GAAG,GAA6B,EAAE;QACzC,MAAM,CAAC,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC;QACvC,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACpB,MAAM,CAAC,GAAsB,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;QAC7D,IAAI,IAAI,EAAE,KAAK,YAAY;YAAE,CAAC,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC;QAChD,OAAO,CAAC,CAAC;IACX,CAAC,CAAC;IAEF,KAAK,UAAU,IAAI,CAAC,GAAc,EAAE,CAAoB,EAAE,GAAW;QACnE,MAAM,OAAO,GAAG,CAAC,IAAI,EAAE,qCAAqC,CAAC,CAAC;QAC9D,IAAI,CAAC,CAAC,QAAQ;YAAE,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC1E,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;QACtI,IAAI,CAAC,GAAG,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC7E,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5C,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QACxF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,UAAU,IAAI,CAAC,IAAoB,EAAE,IAAe,EAAE,GAAc,EAAE,CAAoB;QAC7F,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACjB,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,mCAAmC,CAAC,EAC/J,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;YACtD,IAAI,GAAG,CAAC,EAAE,EAAE,CAAC;gBACX,OAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,CAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YACpL,CAAC;YACD,yHAAyH;QAC3H,CAAC;QACD,MAAM,GAAG,GAAG,GAAG,OAAO,EAAE,UAAU,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,yBAAyB,CAAC;QAC3G,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAU,CAAC;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IACzL,CAAC;IAED,OAAO;QACL,EAAE,EAAE,QAAQ;QACZ,KAAK,EAAE,QAAQ;QACf,KAAK,EAAE,QAAQ;QACf,IAAI;QACJ,GAAG,EAAE,IAAI;QACT,UAAU,EAAE,eAAe;QAC3B,GAAG;QACH,IAAI,EAAE,GAAG,EAAE;YACT,MAAM,CAAC,GAAG,QAAQ,EAAE,CAAC;YACrB,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,SAAS,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,SAAS,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QACnM,CAAC;QACD,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,GAAG,MAAM,CAAC,GAAG,IAAA,4BAAU,EAAC,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,WAAW,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACrI,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,IAAI,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,MAAM,CAAC;QACrH,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,SAAS,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,QAAQ,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,GAAG,aAAa,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,YAAY,kBAAkB,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QACrM,UAAU,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;QACzD,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;QACrD,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,sBAAsB,MAAM,uBAAuB,IAAI,EAAE,IAAI,IAAI,CAAC,IAAI,WAAW,MAAM,SAAS;QAClI,0IAA0I;QAC1I,QAAQ,EAAE,GAAG,EAAE,CAAC,0DAA0D,IAAI,EAAE,sDAAsD;QACtI,KAAK,EAAE,EAAE,OAAO,EAAE,4DAA4D,EAAE,WAAW,EAAE,mBAAmB,EAAE,IAAI,EAAE,sDAAsD,EAAE;QAChL,SAAS,EAAE,iDAAiD;KAC7D,CAAC;AACJ,CAAC"}

package/features/github.feature

@@ -0,0 +1,13 @@
+Feature: The GitHub plugin on a project row
+  Once the plugin is activated and installed, every project whose git remote is on GitHub carries
+  the GITHUB menu, and the Plugins page lists the plugin with its four steps.
+
+  Scenario: A project cloned from GitHub offers the GITHUB menu
+    Given I am on "/dev"
+     Then the element ".act-menu-github" should be displayed
+      And I should see "GITHUB"
+
+  Scenario: The plugin is listed on the Plugins page
+    Given I am on "/settings/plugins"
+     Then I should see "GitHub"
+      And I should see "@webship.co/workspace-github"

package/host-mounts.txt

@@ -0,0 +1,2 @@
+# Directories the dashboard container bind-mounts for this plugin; host-mounts.sh creates them as you first.
+~/.config/gh

package/package.json

@@ -1,6 +1,60 @@
 {
   "name": "@webship.co/workspace-github",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0-alpha1",
+  "description": "GitHub for Webship Workspace: the GITHUB menu on every project whose remote is on github.com (repository, issues, pull requests, open one from the branch), the repository chip, clone when a new folder is made, and the credential gh-based work uses from the dashboard. A provider of @webship.co/workspace-forge.",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/webship/workspace-github.git"
+  },
+  "files": [
+    "dist/src",
+    "config",
+    "features",
+    "scripts",
+    "README.md",
+    "ddev",
+    "host-mounts.txt"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepare": "npm run build",
+    "test": "npm run build && node --test dist/tests/*.test.js",
+    "lint": "tsc -p tsconfig.json --noEmit"
+  },
+  "workspacePlugin": {
+    "name": "github",
+    "label": "GitHub",
+    "settingsFile": "plugin.github.settings.yml",
+    "settingsTemplate": "config/plugin.github.settings.yml",
+    "labels": "config/settings.labels.yml",
+    "legacySettingsKey": "git.github",
+    "scripts": {
+      "hostInstall": "scripts/host-install.sh"
+    },
+    "features": [
+      "features/github.feature"
+    ],
+    "ddev": {
+      "compose": [
+        "ddev/docker-compose.github-cli.yaml"
+      ],
+      "hostMounts": [
+        "~/.config/gh"
+      ]
+    }
+  },
+  "dependencies": {
+    "@webship.co/workspace-forge": "^1.0.0-alpha1"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "@webship.co/workspace-plugin-api": "^1.0.0-alpha1",
+    "typescript": "^5.9.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/scripts/host-install.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+## The host side of the GitHub plugin: the CLI on this machine and the dashboard's credential.
+## Run by core/scripts/plugins.sh --install github, and by core/scripts/install.sh for every installed
+## plugin that ships one. Idempotent: whatever is already there is reported, not redone.
+set -u
+WORKSPACE_ROOT="${WORKSPACE_ROOT:-$(cd "$(dirname "${BASH_SOURCE[0]}")/../../../../.." && pwd)}";
+
+BIN='';
+for candidate in "$(command -v gh 2>/dev/null)" "${HOME}/.local/bin/gh" ; do
+  [ -n "${candidate}" ] && [ -x "${candidate}" ] && { BIN="${candidate}"; break; }
+done
+if [ -n "${BIN}" ] ; then
+  printf '  ✓ %-16s %s\n' "gh" "${BIN}" ;
+else
+  printf '  ✗ %-16s %s\n' "gh" "missing — opening pull requests from the dashboard needs it (cli.github.com)" ;
+fi
+
+STATE="$(grep -E '^token:' "${WORKSPACE_ROOT}/core/config/plugin.github.settings.yml" 2>/dev/null | head -1 | sed -E 's/^[a-z_]+:[[:space:]]*//')";
+case "${STATE}" in
+  ''|CHANGE_ME|"''"|'""') printf '  ✗ %-16s %s\n' "token" "not set in plugin.github.settings.yml — the dashboard reads only public repositories on GitHub" ;;
+  *)                       printf '  ✓ %-16s %s\n' "token" "set (plugin.github.settings.yml)" ;;
+esac
+