@sentry/junior-github 0.117.0 → 0.118.0

package/README.md

@@ -1,6 +1,7 @@
 # @sentry/junior-github
 
-`@sentry/junior-github` adds GitHub issue, pull request, repository, and user-attachment workflows to Junior using a GitHub App.
+`@sentry/junior-github` adds GitHub deployment, issue, pull request,
+repository, and user-attachment workflows to Junior using a GitHub App.
 
 Install it alongside `@sentry/junior`:
 
@@ -24,6 +25,7 @@ export const plugins = defineJuniorPlugins([
 
 Full setup guide: https://junior.sentry.dev/extend/github-plugin/
 
-The plugin owns its signed webhook route, normalized pull request and issue
-outcome projections, and dashboard operational report. Core only owns delivery
-from plugin-published resource events into matching conversation subscriptions.
+The plugin owns its signed webhook route, deployment and pull request resource
+events, normalized pull request and issue outcome projections, and dashboard
+operational report. Core only owns delivery from plugin-published resource
+events into matching conversation subscriptions.

package/SETUP.md

@@ -14,6 +14,7 @@ In GitHub:
 - Contents: Read and write
 - Pull requests: Read and write
 - Actions: Read and write
+- Deployments: Read
 - Workflows: Write
 - Metadata: Read
 
@@ -77,8 +78,15 @@ the App bot login from that email. Set the GitHub App webhook URL to
 `https://<junior-host>/api/webhooks/github` and subscribe to Pull request
 and Issues events. The secret in GitHub must match the deployment environment.
 
-Conversation watches additionally use Check suite, Issue comment, Pull request
-review, and Pull request review comment events.
+Conversation watches additionally use Check suite, Deployment, Deployment
+status, Issue comment, Pull request review, and Pull request review comment
+events.
+
+`github_getDeployment` reads the latest deployment and status for an exact
+repository, environment, and commit SHA. When webhooks are configured, its
+result can subscribe the current conversation to deployment creation, progress,
+success, failure, and error events. The subscription remains available when
+GitHub has not created the deployment yet.
 
 ```bash
 vercel env add GITHUB_WEBHOOK_SECRET production
@@ -108,6 +116,7 @@ githubPlugin({
   appPermissions: {
     actions: "write",
     contents: "write",
+    deployments: "read",
     issues: "write",
     metadata: "read",
     pull_requests: "write",

package/dist/{chunk-JDNXIBCQ.js → chunk-EPYBKNXS.js}

@@ -1,6 +1,41 @@
 // src/webhooks/resource-events.ts
 import { z } from "zod";
 
+// src/resource-events/deployment.ts
+var GITHUB_DEPLOYMENT_EVENTS = [
+  "deployment.created",
+  "deployment.queued",
+  "deployment.pending",
+  "deployment.in_progress",
+  "deployment.succeeded",
+  "deployment.failed",
+  "deployment.error"
+];
+var SUGGESTED_EVENTS = [
+  "deployment.succeeded",
+  "deployment.failed",
+  "deployment.error"
+];
+function gitHubDeploymentSourceResource(input) {
+  const commitSha = input.commitSha.toLowerCase();
+  const environment = input.environment.trim();
+  const repo = input.repo.toLowerCase();
+  return {
+    label: `GitHub deployment for ${repo} at ${commitSha.slice(0, 12)}`,
+    provider: "github",
+    resourceRef: `github:deployment-source:${repo}:${encodeURIComponent(environment.toLowerCase())}:${commitSha}`
+  };
+}
+function gitHubDeploymentSourceSubscribable(input) {
+  if (!process.env.GITHUB_WEBHOOK_SECRET?.trim()) return void 0;
+  return {
+    ...gitHubDeploymentSourceResource(input),
+    suggestedEvents: SUGGESTED_EVENTS,
+    supportedEvents: [...GITHUB_DEPLOYMENT_EVENTS],
+    type: "deployment_source"
+  };
+}
+
 // src/resource-events/pull-request.ts
 var SUPPORTED_EVENTS = [
   "checks.failed",
@@ -13,7 +48,7 @@ var SUPPORTED_EVENTS = [
   "state.merged",
   "state.closed_unmerged"
 ];
-var SUGGESTED_EVENTS = [
+var SUGGESTED_EVENTS2 = [
   "checks.failed",
   "comment.created",
   "review.changes_requested",
@@ -33,7 +68,7 @@ function gitHubPullRequestSubscribable(input) {
   if (!process.env.GITHUB_WEBHOOK_SECRET?.trim()) return void 0;
   return {
     ...gitHubPullRequestResource(input),
-    suggestedEvents: SUGGESTED_EVENTS,
+    suggestedEvents: SUGGESTED_EVENTS2,
     supportedEvents: SUPPORTED_EVENTS,
     type: "pull_request"
   };
@@ -43,7 +78,125 @@ function gitHubPullRequestSubscribable(input) {
 function gitHubEventKey(deliveryId, eventType) {
   return `github:${deliveryId}:${eventType}`;
 }
-var repositorySchema = z.object({ full_name: z.string().min(1) });
+var repositorySchema = z.object({ full_name: z.string().min(1) }).passthrough();
+var deploymentSchema = z.object({
+  created_at: z.string().optional(),
+  environment: z.string().min(1),
+  id: z.number(),
+  sha: z.string().regex(/^[0-9a-f]{40}$/i)
+}).passthrough();
+var deploymentWebhookSchema = z.object({
+  action: z.string(),
+  deployment: deploymentSchema,
+  repository: repositorySchema
+}).passthrough();
+var canonicalDeploymentEventSchema = z.object({
+  action: z.string(),
+  commitSha: z.string().regex(/^[0-9a-f]{40}$/i),
+  createdAt: z.string().optional(),
+  deploymentId: z.number(),
+  environment: z.string().min(1),
+  repo: z.string().min(1)
+}).strict();
+function parseDeploymentEvent(body) {
+  const parsed = deploymentWebhookSchema.safeParse(body);
+  if (!parsed.success) return void 0;
+  return canonicalDeploymentEventSchema.parse({
+    action: parsed.data.action,
+    commitSha: parsed.data.deployment.sha,
+    createdAt: parsed.data.deployment.created_at,
+    deploymentId: parsed.data.deployment.id,
+    environment: parsed.data.deployment.environment,
+    repo: parsed.data.repository.full_name
+  });
+}
+function normalizeDeploymentEvent(deliveryId, body) {
+  const parsed = parseDeploymentEvent(body);
+  if (!parsed || parsed.action !== "created") return void 0;
+  const resource = gitHubDeploymentSourceResource({
+    commitSha: parsed.commitSha,
+    environment: parsed.environment,
+    repo: parsed.repo
+  });
+  const eventType = "deployment.created";
+  return {
+    eventKey: gitHubEventKey(deliveryId, eventType),
+    eventType,
+    occurredAtMs: providerTime(parsed.createdAt) ?? Date.now(),
+    provider: "github",
+    resourceRef: resource.resourceRef,
+    trustedSummary: `${resource.label} was created (deployment ${parsed.deploymentId}).`
+  };
+}
+var deploymentStatusWebhookSchema = z.object({
+  action: z.string(),
+  deployment: deploymentSchema,
+  deployment_status: z.object({
+    created_at: z.string().optional(),
+    description: z.string().optional().nullable(),
+    state: z.string()
+  }).passthrough(),
+  repository: repositorySchema
+}).passthrough();
+var canonicalDeploymentStatusEventSchema = canonicalDeploymentEventSchema.extend({
+  description: z.string().optional().nullable(),
+  state: z.string(),
+  statusCreatedAt: z.string().optional()
+}).strict();
+function parseDeploymentStatusEvent(body) {
+  const parsed = deploymentStatusWebhookSchema.safeParse(body);
+  if (!parsed.success) return void 0;
+  return canonicalDeploymentStatusEventSchema.parse({
+    action: parsed.data.action,
+    commitSha: parsed.data.deployment.sha,
+    createdAt: parsed.data.deployment.created_at,
+    deploymentId: parsed.data.deployment.id,
+    description: parsed.data.deployment_status.description,
+    environment: parsed.data.deployment.environment,
+    repo: parsed.data.repository.full_name,
+    state: parsed.data.deployment_status.state,
+    statusCreatedAt: parsed.data.deployment_status.created_at
+  });
+}
+function deploymentStatusEventType(state) {
+  switch (state) {
+    case "queued":
+    case "pending":
+    case "in_progress":
+      return `deployment.${state}`;
+    case "success":
+      return "deployment.succeeded";
+    case "failure":
+      return "deployment.failed";
+    case "error":
+      return "deployment.error";
+    default:
+      return void 0;
+  }
+}
+function normalizeDeploymentStatusEvent(deliveryId, body) {
+  const parsed = parseDeploymentStatusEvent(body);
+  if (!parsed || parsed.action !== "created") return void 0;
+  const eventType = deploymentStatusEventType(parsed.state);
+  if (!eventType) return void 0;
+  const resource = gitHubDeploymentSourceResource({
+    commitSha: parsed.commitSha,
+    environment: parsed.environment,
+    repo: parsed.repo
+  });
+  const outcome = eventType === "deployment.succeeded" ? "succeeded" : eventType === "deployment.failed" ? "failed" : eventType === "deployment.error" ? "reported an error" : eventType === "deployment.in_progress" ? "started" : `is ${parsed.state}`;
+  const terminal = eventType === "deployment.succeeded" || eventType === "deployment.failed" || eventType === "deployment.error";
+  return {
+    eventKey: gitHubEventKey(deliveryId, eventType),
+    eventType,
+    occurredAtMs: providerTime(parsed.statusCreatedAt) ?? Date.now(),
+    provider: "github",
+    resourceRef: resource.resourceRef,
+    ...terminal ? { terminal: true } : {},
+    trustedSummary: `${resource.label} ${outcome} (deployment ${parsed.deploymentId}).`,
+    untrustedText: parsed.description ?? void 0
+  };
+}
 var checkSuiteWebhookSchema = z.object({
   action: z.string(),
   check_suite: z.object({
@@ -207,6 +360,14 @@ function normalizePullRequestEvent(deliveryId, body) {
 }
 function normalizeGitHubResourceEvents(args) {
   switch (args.eventName) {
+    case "deployment": {
+      const event = normalizeDeploymentEvent(args.deliveryId, args.body);
+      return event ? [event] : [];
+    }
+    case "deployment_status": {
+      const event = normalizeDeploymentStatusEvent(args.deliveryId, args.body);
+      return event ? [event] : [];
+    }
     case "pull_request": {
       const event = normalizePullRequestEvent(args.deliveryId, args.body);
       return event ? [event] : [];
@@ -234,6 +395,7 @@ function normalizeGitHubResourceEvents(args) {
 }
 
 export {
+  gitHubDeploymentSourceSubscribable,
   gitHubPullRequestSubscribable,
   normalizeGitHubResourceEvents
 };