mirror of
https://github.com/vercel/chat.git
synced 2026-09-14 18:32:29 +08:00
Hayden Bleasel
1348532068
* Update docs - Slack Assistants API, App Home tab, Stream stop blocks * Update README.md * Update package readmes, fix readme integration test * Add npm badges to all package READMEs Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Add test coverage to all packages * Create CODE_OF_CONDUCT.md * Create pull_request_template.md * Create issue templates * Create config.yml * Add unit tests for errors, singleton, logger, message, modals, gchat utils, and teams markdown Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Add a vitest:workspace command * Misc URL fixes * Update CONTRIBUTING.md * Misc fixes, upgrade workflow/serde * Replace PII in integration test data --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
43 lines
1.1 KiB
Markdown
43 lines
1.1 KiB
Markdown
# @chat-adapter/github
|
|
|
|
[](https://www.npmjs.com/package/@chat-adapter/github)
|
|
[](https://www.npmjs.com/package/@chat-adapter/github)
|
|
|
|
GitHub adapter for [Chat SDK](https://chat-sdk.dev/docs). Enables bots to respond to @mentions in GitHub PR and issue comment threads.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install chat @chat-adapter/github
|
|
```
|
|
|
|
## Usage
|
|
|
|
```typescript
|
|
import { Chat } from "chat";
|
|
import { createGitHubAdapter } from "@chat-adapter/github";
|
|
|
|
const bot = new Chat({
|
|
userName: "my-bot",
|
|
adapters: {
|
|
github: createGitHubAdapter({
|
|
token: process.env.GITHUB_TOKEN!,
|
|
webhookSecret: process.env.GITHUB_WEBHOOK_SECRET!,
|
|
userName: "my-bot",
|
|
}),
|
|
},
|
|
});
|
|
|
|
bot.onNewMention(async (thread, message) => {
|
|
await thread.post("Hello from GitHub!");
|
|
});
|
|
```
|
|
|
|
## Documentation
|
|
|
|
Full setup instructions, configuration reference, and features at [chat-sdk.dev/docs/adapters/github](https://chat-sdk.dev/docs/adapters/github).
|
|
|
|
## License
|
|
|
|
MIT
|