mirror of
https://github.com/github/awesome-copilot.git
synced 2026-08-29 12:03:09 +00:00
Liz TomandCopilot App
bbde357dbd
The sentry-triage canvas's setup gate previously told users to ask
Copilot to install its optional `sentry` dependency and reload
extensions, and to run `sentry auth login` from a terminal. Both
flows were unreliable or high-friction in practice.
This adds real one-click buttons for both steps:
- sentryClient.mjs — installPackage() runs npm install (async, via
execFile so the shared extension process's event loop isn't
blocked) rooted at the file's own directory via import.meta.url, so
the path is never guessed. loadFactory() falls back to importing
the package's resolved entry file by absolute path when the bare
import('sentry') fails, since Node caches a negative resolution for
a bare specifier for the life of the process — while still
distinguishing a genuinely missing package from a transitive-
dependency defect so the latter isn't masked as "package missing."
login() fails fast with a clear message when SENTRY_AUTH_TOKEN/
SENTRY_TOKEN is active in the environment (which takes precedence
over the OAuth login this button drives), and treats an empty/
falsy auth.login() result as a failed sign-in instead of silently
re-probing.
- preflight.mjs — installDependencies() runs the install and
re-probes the connection; authenticate() classifies the new error
codes for gate messaging.
- server.mjs / extension.mjs — wire POST /api/install-dependencies
and POST /api/auth-login routes (through the existing CSRF/Host
gate) to the new preflight functions, publishing refreshed
connection state to the canvas.
- components/page.mjs / styles.mjs — the install and sign-in
buttons, with loading/success/failure states and accessible live-
region status updates; a live multi-org <select> dropdown that
rebuilds in place once org discovery completes post-signin,
without requiring a canvas reopen.
- README.md — documents the one-click flow; manual npm install /
sentry auth login kept as a fallback.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
123 lines
5.2 KiB
Markdown
123 lines
5.2 KiB
Markdown
# Sentry Triage Canvas
|
|
|
|
A GitHub Copilot canvas for on-call error triage. It scans your live Sentry
|
|
issues, groups them by why they need attention, and lets you hand a selected
|
|
issue off to Copilot — either to file a tracking issue or to spin up a session
|
|
that drafts a fix pull request.
|
|
|
|
## Features
|
|
|
|
- **Live scan** of Sentry issues for an organization (optionally narrowed to a
|
|
single project), grouped by urgency.
|
|
- **Plain-English titles** toggle that rewrites the raw Sentry error into a
|
|
one-sentence, user-facing summary.
|
|
- **Tracking detection** so already-triaged issues (filed with the
|
|
`sentry-triage` label) are recognized on later scans.
|
|
- **📝 Create issue** files or reuses a tracking issue only — no code, branch, or
|
|
PR.
|
|
- **🔧 Fix with Copilot** files/reuses the tracking issue **and** spawns a
|
|
dedicated session that drafts a fix PR.
|
|
- **Settings panel** to confirm the repository, local checkout, base branch, and
|
|
issue tracker before anything is created.
|
|
|
|
## Files
|
|
|
|
- `extension.mjs` — canvas declaration, agent hand-off tools, and orchestration.
|
|
- `server.mjs` — loopback HTTP server that backs the canvas webview.
|
|
- `state.mjs` — per-canvas state and render coordination.
|
|
- `styles.mjs` — canvas styling.
|
|
- `sentry.mjs` / `sentryClient.mjs` — Sentry CLI (library mode) access: scan
|
|
issues, list orgs and projects.
|
|
- `preflight.mjs` — Sentry sign-in / connection checks with the setup gate.
|
|
- `prefs.mjs` — persisted user preferences.
|
|
- `escape.mjs` — prompt/HTML escaping helpers.
|
|
- `components/` — `page.mjs`, `card.mjs`, and `category.mjs` webview components.
|
|
- `assets/preview.png` — preview image for the extensions gallery.
|
|
- `package.json` — ESM entry point and runtime dependencies.
|
|
- `copilot-extension.json` — Copilot extension name/version metadata.
|
|
|
|
## Prerequisites
|
|
|
|
- **Node.js 22 or newer.**
|
|
- The GitHub Copilot app canvas / UI-extensions experiment enabled.
|
|
- **A Sentry sign-in.** This canvas reads issues through the
|
|
[Sentry CLI](https://cli.sentry.dev) in library mode — there is no MCP server
|
|
to configure. The setup gate walks you through installing the dependency and
|
|
signing in with one-click buttons (see **Install** below); no terminal
|
|
required. For non-interactive environments, you can instead export a token:
|
|
|
|
```sh
|
|
export SENTRY_AUTH_TOKEN=<your-token>
|
|
```
|
|
|
|
The login or token needs these scopes: `event:read`, `org:read`,
|
|
`project:read`. The canvas checks for a valid sign-in each time it opens; if
|
|
you aren't signed in it shows a setup gate with the exact reason.
|
|
|
|
## Install
|
|
|
|
Drop this folder at `~/.copilot/extensions/sentry-triage/` for user scope, or in a
|
|
repository at `.github/extensions/sentry-triage/` for project scope.
|
|
|
|
This canvas depends on the [`sentry`](https://cli.sentry.dev) npm package at
|
|
runtime, which isn't bundled with the extension source. If it's missing, the canvas
|
|
still **opens** and shows a setup gate — click its **Install dependencies** button
|
|
and the extension runs `npm install` in its own directory (wherever it's actually
|
|
installed, so there's no path to guess). Once installed, if you aren't signed in
|
|
yet the gate shows a **Sign in with Sentry** button that opens your browser to
|
|
approve access and returns automatically — no terminal step required. The gate
|
|
clears once both finish; no reload or Copilot involvement needed.
|
|
|
|
### Or set it up manually
|
|
|
|
If you'd rather not use the buttons (or `npm`/a browser isn't available to the
|
|
extension process), you can run the same steps yourself:
|
|
|
|
```sh
|
|
# User scope
|
|
cd ~/.copilot/extensions/sentry-triage
|
|
|
|
# Or project scope, from the repository root
|
|
cd .github/extensions/sentry-triage
|
|
|
|
# Or, if you installed the published plugin (`copilot plugin install`), the source
|
|
# lives inside the installed plugin — cd into its extension folder:
|
|
cd <installed-plugin-path>/com.github.copilot/extensions/sentry-triage
|
|
|
|
npm install
|
|
npx sentry auth login
|
|
```
|
|
|
|
Reload extensions in the GitHub Copilot app, then open the `sentry-triage` canvas.
|
|
|
|
## Open the canvas in the correct repository scope
|
|
|
|
Open the canvas from a Copilot session scoped to the repository where you want
|
|
issues and draft pull requests created, so it can detect the repository, local
|
|
checkout, and base branch automatically. If you opened it outside the intended
|
|
repository, open **Settings** and confirm the targets before selecting **Create
|
|
issue** or **Fix with Copilot**.
|
|
|
|
## Use the canvas
|
|
|
|
1. Open the canvas from the repository you want to work in.
|
|
2. Confirm the Sentry **organization** (auto-detected from your sign-in). If your
|
|
account has more than one org, pick it from the dropdown. **Scan issues**
|
|
stays disabled until an organization is set.
|
|
3. Optionally narrow to a single **project** using the autocomplete field. Leave
|
|
it blank to scan the whole org.
|
|
4. Review the issues grouped by why they need attention. Toggle **Plain-English
|
|
titles** to swap the raw Sentry error for a readable summary.
|
|
5. Select issues and choose an action in the toolbar — **📝 Create issue** or
|
|
**🔧 Fix with Copilot**.
|
|
|
|
## Agent tools
|
|
|
|
The canvas exposes structured hand-off tools the agent calls instead of printing
|
|
JSON into the timeline: `submit_issue_summaries`,
|
|
`submit_tracking`, `submit_related`, and `submit_work_pr`.
|
|
|
|
## License
|
|
|
|
MIT — see [LICENSE](LICENSE).
|