@mastra/github-signals 0.4.0-alpha.1 → 0.4.0
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.
- package/README.md +40 -0
- package/package.json +4 -4
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# @mastra/github-signals
|
|
2
|
+
|
|
3
|
+
`@mastra/github-signals` lets an agent subscribe a conversation thread to a GitHub pull request and receive new commits, review comments, thread-resolution changes, and merge or close events. Use it for long-running coding agents that need to resume work when a pull request changes.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @mastra/github-signals
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
Register one `GithubSignals` instance on the agent that should receive pull request updates.
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { Agent } from '@mastra/core/agent';
|
|
17
|
+
import { GithubSignals } from '@mastra/github-signals';
|
|
18
|
+
|
|
19
|
+
const githubSignals = new GithubSignals({ pollIntervalMs: 5 * 60 * 1000 });
|
|
20
|
+
|
|
21
|
+
export const reviewAgent = new Agent({
|
|
22
|
+
id: 'review-agent',
|
|
23
|
+
name: 'Pull request reviewer',
|
|
24
|
+
instructions: 'Review pull requests and respond when new activity arrives.',
|
|
25
|
+
model: 'openai/gpt-5.6-sol',
|
|
26
|
+
signals: [githubSignals],
|
|
27
|
+
});
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Documentation
|
|
31
|
+
|
|
32
|
+
- [GitHub](https://mastra.ai/integrations/channels/github)
|
|
33
|
+
|
|
34
|
+
## Changelog
|
|
35
|
+
|
|
36
|
+
See the [package changelog](https://github.com/mastra-ai/mastra/blob/main/signals/github/CHANGELOG.md) for version history and release notes.
|
|
37
|
+
|
|
38
|
+
## Support
|
|
39
|
+
|
|
40
|
+
We have an [open community Discord](https://discord.gg/mastra-ai). Come and say hello and let us know if you have any questions or need any help getting things running.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mastra/github-signals",
|
|
3
|
-
"version": "0.4.0
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "GitHub PR notification signal provider for Mastra agents",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -50,9 +50,9 @@
|
|
|
50
50
|
"typescript": "^7.0.2",
|
|
51
51
|
"vitest": "4.1.10",
|
|
52
52
|
"zod": "^4.4.3",
|
|
53
|
-
"@internal/lint": "0.0.
|
|
54
|
-
"@internal/types-builder": "0.0.
|
|
55
|
-
"@mastra/core": "1.64.0
|
|
53
|
+
"@internal/lint": "0.0.130",
|
|
54
|
+
"@internal/types-builder": "0.0.105",
|
|
55
|
+
"@mastra/core": "1.64.0"
|
|
56
56
|
},
|
|
57
57
|
"scripts": {
|
|
58
58
|
"build": "tsdown --silent --config tsdown.config.ts",
|