0
Fork 0
mirror of https://github.com/mastra-ai/mastra.git synced 2026-11-17 08:44:46 +00:00
mastra/signals/github/README.md
Lennart e983f74987
chore(*): Update/unify/add READMEs (#22858)
Co-authored-by: Mastra Code (openai/gpt-5.6-sol) <noreply@mastra.ai>
2026-09-02 14:36:59 +02:00

1.3 KiB

@mastra/github-signals

@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.

Installation

npm install @mastra/github-signals

Usage

Register one GithubSignals instance on the agent that should receive pull request updates.

import { Agent } from '@mastra/core/agent';
import { GithubSignals } from '@mastra/github-signals';

const githubSignals = new GithubSignals({ pollIntervalMs: 5 * 60 * 1000 });

export const reviewAgent = new Agent({
  id: 'review-agent',
  name: 'Pull request reviewer',
  instructions: 'Review pull requests and respond when new activity arrives.',
  model: 'openai/gpt-5.6-sol',
  signals: [githubSignals],
});

Documentation

Changelog

See the package changelog for version history and release notes.

Support

We have an open community Discord. Come and say hello and let us know if you have any questions or need any help getting things running.