@burtson-labs/agent-adapters-github 1.0.4 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +46 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,46 @@
1
+ <div align="center">
2
+ <a href="https://burtson.ai">
3
+ <picture>
4
+ <img src="https://cdn.burtson.ai/logos/bandit-stealth.png" alt="Bandit Stealth" width="150" style="width: 150px !important; max-width: 150px !important; height: auto; display: inline-block;" />
5
+ </picture>
6
+ </a>
7
+
8
+ # @burtson-labs/agent-adapters-github
9
+
10
+ **GitHub Actions adapter for the Bandit Agent Framework.**
11
+
12
+ Run an agent inside a workflow and surface its plan, execution, and report as a GitHub check run — backed by [`@burtson-labs/agent-core`](https://www.npmjs.com/package/@burtson-labs/agent-core).
13
+ </div>
14
+
15
+ ---
16
+
17
+ ## <img src="https://api.iconify.design/lucide/package.svg?color=%23a60ee5&width=22" align="absmiddle"> Install
18
+
19
+ ```bash
20
+ pnpm add @burtson-labs/agent-adapters-github @burtson-labs/agent-core
21
+ ```
22
+
23
+ ## <img src="https://api.iconify.design/lucide/puzzle.svg?color=%23a60ee5&width=22" align="absmiddle"> What's inside
24
+
25
+ - `GithubAdapterOptions` — extends `CreateAgentRuntimeOptions` with `repository`, `headSha`, and `workflowName`
26
+ - `GithubCheckRunPayload` — the shape POSTed to the GitHub `/check-runs` endpoint after a planned run
27
+ - `GithubCheckRunOutput` — title / summary / text fields that render in the workflow UI
28
+ - An adapter that maps agent plan + execution + report into a single check-run payload
29
+
30
+ ## <img src="https://api.iconify.design/lucide/zap.svg?color=%23a60ee5&width=22" align="absmiddle"> Quick example
31
+
32
+ ```ts
33
+ import { createGithubAdapter } from "@burtson-labs/agent-adapters-github";
34
+
35
+ const adapter = createGithubAdapter({
36
+ repository: "burtson-labs/bandit-agent-framework",
37
+ headSha: process.env.GITHUB_SHA,
38
+ workflowName: "Bandit Agent"
39
+ });
40
+
41
+ const checkRun = await adapter.toCheckRun(await adapter.plan("Audit PR"));
42
+ ```
43
+
44
+ ## License
45
+
46
+ [Apache License 2.0](LICENSE) — Copyright 2026 Burtson Labs.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@burtson-labs/agent-adapters-github",
3
- "version": "1.0.4",
3
+ "version": "1.0.5",
4
4
  "description": "GitHub Actions adapter for the Bandit Agent Framework.",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -18,7 +18,7 @@
18
18
  ],
19
19
  "license": "Apache-2.0",
20
20
  "dependencies": {
21
- "@burtson-labs/agent-core": "1.6.13"
21
+ "@burtson-labs/agent-core": "1.6.14"
22
22
  },
23
23
  "scripts": {
24
24
  "prebuild": "pnpm -C ../../.. --filter @burtson-labs/agent-core build",