@elizaos/plugin-github 2.0.0-alpha.6 → 2.0.3-beta.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shaw Walters and elizaOS Contributors
+
+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

@@ -0,0 +1,86 @@
+# @elizaos/plugin-github
+
+GitHub integration for elizaOS agents. Enables agents to manage pull requests, issues, and notifications using the GitHub REST API via Octokit.
+
+## What it does
+
+- **List pull requests** — open/closed/all for a specific repo or across accessible repos, with optional author filter.
+- **Review pull requests** — submit approve, request-changes, or comment reviews (requires confirmation).
+- **Issue management** — create, assign, close, reopen, comment on, or label issues (all write ops require confirmation).
+- **Notification triage** — fetch unread GitHub notifications and return them ranked by priority score (reason, subject type, repo freshness). Read-only, no confirmation needed.
+- **PAT management** — REST endpoints for storing/removing a GitHub Personal Access Token from local disk (`<state-dir>/credentials/github.json`).
+
+## Enabling the plugin
+
+Add `"@elizaos/plugin-github"` to the agent's `plugins` array in its character file or runtime configuration. The plugin is opt-in.
+
+## Required configuration
+
+At least one GitHub token must be configured. The plugin supports two roles:
+
+- **`user`** — acts on behalf of the human (used for reviews and notifications by default).
+- **`agent`** — acts on behalf of the Eliza agent (used for issue and PR ops by default).
+
+### Multi-account (recommended)
+
+Set `GITHUB_ACCOUNTS` to a JSON array:
+
+```json
+[
+  { "accountId": "user", "role": "user", "token": "ghp_..." },
+  { "accountId": "agent", "role": "agent", "token": "ghp_..." }
+]
+```
+
+### Legacy single-account
+
+| Env var | Role |
+|---|---|
+| `GITHUB_USER_PAT` | user |
+| `GITHUB_AGENT_PAT` | agent |
+
+### OAuth (optional)
+
+To enable OAuth-app flows through the connector account manager, also set:
+
+- `GITHUB_OAUTH_CLIENT_ID`
+- `GITHUB_OAUTH_CLIENT_SECRET`
+- `GITHUB_OAUTH_REDIRECT_URI`
+
+## Actions
+
+The plugin exposes one umbrella action `GITHUB` that dispatches to sub-operations via an `action` parameter:
+
+| `action` value | What it does |
+|---|---|
+| `pr_list` | List pull requests |
+| `pr_review` | Submit a PR review (requires `review_action`: approve / request-changes / comment) |
+| `issue_create` | Create a new issue (`title` required) |
+| `issue_assign` | Assign users to an issue |
+| `issue_close` | Close an issue |
+| `issue_reopen` | Reopen a closed issue |
+| `issue_comment` | Add a comment to an issue |
+| `issue_label` | Apply labels to an issue |
+| `notification_triage` | Fetch and rank unread notifications |
+
+All write operations require confirmation before they execute.
+
+## HTTP routes
+
+The plugin registers three routes on the agent's server for PAT management:
+
+| Method | Path | Description |
+|---|---|---|
+| `GET` | `/api/github/token` | Returns connection status (token never exposed) |
+| `POST` | `/api/github/token` | Save a PAT (validated against GitHub `/user` before save) |
+| `DELETE` | `/api/github/token` | Remove the saved PAT |
+
+## Development
+
+```bash
+bun run --cwd plugins/plugin-github build
+bun run --cwd plugins/plugin-github test
+bun run --cwd plugins/plugin-github typecheck
+```
+
+See [CLAUDE.md](CLAUDE.md) for agent-facing layout and extension guide.

package/package.json

@@ -1,119 +1,57 @@
 {
   "name": "@elizaos/plugin-github",
-  "version": "2.0.0-alpha.6",
+  "version": "2.0.3-beta.2",
+  "description": "GitHub integration plugin for elizaOS agents — PRs, issues, notifications via the GitHub REST API",
   "type": "module",
   "main": "dist/index.js",
-  "module": "dist/index.js",
   "types": "dist/index.d.ts",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/elizaos-plugins/plugin-github.git"
-  },
   "exports": {
-    "./package.json": "./package.json",
     ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "types": "./dist/index.d.ts",
+      "eliza-source": {
+        "types": "./src/index.ts",
+        "import": "./src/index.ts",
+        "default": "./src/index.ts"
+      },
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./*.css": "./dist/*.css",
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "eliza-source": {
+        "types": "./src/*.ts",
+        "import": "./src/*.ts",
+        "default": "./src/*.ts"
+      },
+      "import": "./dist/*.js",
+      "default": "./dist/*.js"
     }
   },
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "tsup src/index.ts src/register-routes.ts --format esm --dts --clean",
+    "test": "vitest run",
+    "typecheck": "tsgo --noEmit",
+    "clean": "rm -rf dist .turbo"
+  },
   "dependencies": {
-    "@elizaos/core": "2.0.0-alpha.3",
-    "@octokit/rest": "^21.0.0",
-    "@octokit/types": "^13.0.0",
-    "@octokit/webhooks-types": "^7.5.0",
-    "glob": "^11.0.0",
-    "simple-git": "^3.27.0",
-    "zod": "^4.3.6"
+    "@elizaos/core": "2.0.3-beta.2",
+    "@octokit/rest": "^22.0.0"
   },
-  "devDependencies": {
-    "@biomejs/biome": "^2.3.11",
-    "@types/node": "^25.0.3",
-    "typescript": "^5.9.3"
+  "peerDependencies": {
+    "@elizaos/core": "2.0.3-beta.2"
   },
-  "scripts": {
-    "dev": "bun --hot build.ts",
-    "typecheck": "tsc --noEmit -p tsconfig.json",
-    "test": "vitest run __tests__/ --passWithNoTests",
-    "test:unit": "vitest run __tests__/ --passWithNoTests",
-    "test:integration": "echo 'Integration tests require elizaos CLI - skipping'",
-    "lint": "bunx @biomejs/biome check --write --unsafe .",
-    "lint:check": "biome check .",
-    "clean": "rm -rf dist .turbo node_modules .turbo-tsconfig.json tsconfig.tsbuildinfo",
-    "format": "biome format --write .",
-    "format:check": "biome format .",
-    "build": "bun run build.ts",
-    "build:ts": "bun run build.ts"
+  "devDependencies": {
+    "@types/node": "24.12.2",
+    "tsup": "8.5.1",
+    "typescript": "^6.0.3",
+    "vitest": "4.1.9"
   },
   "publishConfig": {
     "access": "public"
   },
-  "agentConfig": {
-    "pluginType": "elizaos:plugin:1.0.0",
-    "pluginParameters": {
-      "GITHUB_API_TOKEN": {
-        "type": "string",
-        "description": "GitHub personal access token for API authentication",
-        "required": true,
-        "sensitive": true
-      },
-      "GITHUB_OWNER": {
-        "type": "string",
-        "description": "Default GitHub repository owner (username or organization)",
-        "required": false,
-        "sensitive": false
-      },
-      "GITHUB_REPO": {
-        "type": "string",
-        "description": "Default GitHub repository name",
-        "required": false,
-        "sensitive": false
-      },
-      "GITHUB_BRANCH": {
-        "type": "string",
-        "description": "Default branch name (defaults to main)",
-        "required": false,
-        "default": "main",
-        "sensitive": false
-      },
-      "GITHUB_WEBHOOK_SECRET": {
-        "type": "string",
-        "description": "Secret for validating GitHub webhook payloads",
-        "required": false,
-        "sensitive": true
-      },
-      "GITHUB_APP_ID": {
-        "type": "string",
-        "description": "GitHub App ID for app-based authentication",
-        "required": false,
-        "sensitive": false
-      },
-      "GITHUB_APP_PRIVATE_KEY": {
-        "type": "string",
-        "description": "GitHub App private key for app-based authentication",
-        "required": false,
-        "sensitive": true
-      },
-      "GITHUB_INSTALLATION_ID": {
-        "type": "string",
-        "description": "GitHub App installation ID",
-        "required": false,
-        "sensitive": false
-      }
-    }
-  },
-  "gitHead": "646c632924826e2b75c2304a75ee56959fe4a460",
-  "milady": {
-    "platforms": [
-      "node"
-    ],
-    "runtime": "node",
-    "platformDetails": {
-      "node": "ESM build available via exports.import"
-    }
-  }
+  "gitHead": "82fe0f44215954c2417328203f5bd6510985c1fc"
 }