@sentry/junior-github 0.129.0 → 0.130.0

package/README.md

@@ -1,6 +1,6 @@
 # @sentry/junior-github
 
-`@sentry/junior-github` adds GitHub deployment, issue, pull request,
+`@sentry/junior-github` adds GitHub deployment, issue, pull request, release,
 repository, and user-attachment workflows to Junior using a GitHub App.
 
 Install it alongside `@sentry/junior`:
@@ -25,7 +25,7 @@ export const plugins = defineJuniorPlugins([
 
 Full setup guide: https://junior.sentry.dev/extend/github-plugin/
 
-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.
+The plugin owns its signed webhook route, deployment, pull request, and release
+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

@@ -79,8 +79,8 @@ the App bot login from that email. Set the GitHub App webhook URL to
 and Issues events. The secret in GitHub must match the deployment environment.
 
 Conversation watches additionally use Check suite, Deployment, Deployment
-status, Issue comment, Pull request review, and Pull request review comment
-events.
+status, Issue comment, Pull request review, Pull request review comment, and
+Release events.
 
 `github_getDeployment` reads the latest deployment and status for an exact
 repository and commit SHA, optionally limited to one environment. When
@@ -91,6 +91,13 @@ subscription remains available when GitHub has not created the deployment yet.
 Commit-wide watches remain active across terminal outcomes so later
 environments for the same commit can also notify the conversation.
 
+`github_getRelease` reads a release for an exact repository, optionally limited
+to one tag. When webhooks are configured, its result can subscribe the current
+conversation to `release.published`. Omitting the tag watches every published
+release in the repository. The subscription remains available when GitHub has
+not published the release yet. Tag-specific watches complete after publish;
+repository-wide release watches remain active across later tags.
+
 ```bash
 vercel env add GITHUB_WEBHOOK_SECRET production
 ```

package/dist/{chunk-25NTEYYB.js → chunk-6XR7J3LQ.js}

@@ -103,6 +103,28 @@ function gitHubPullRequestSubscribable(input) {
   };
 }
 
+// src/resource-events/release.ts
+var GITHUB_RELEASE_EVENTS = ["release.published"];
+var GITHUB_RELEASE_SUGGESTED_EVENTS = ["release.published"];
+function gitHubReleaseSourceResource(input) {
+  const repo = input.repo.toLowerCase();
+  const tag = input.tag?.trim();
+  return {
+    label: `GitHub release for ${repo}`,
+    namespace: "github",
+    identifier: tag ? `release-source:${repo}:${encodeURIComponent(tag)}` : `release-source:${repo}`
+  };
+}
+function gitHubReleaseSourceSubscribable(input) {
+  if (!process.env.GITHUB_WEBHOOK_SECRET?.trim()) return void 0;
+  return {
+    ...gitHubReleaseSourceResource(input),
+    suggestedEvents: GITHUB_RELEASE_SUGGESTED_EVENTS,
+    supportedEvents: [...GITHUB_RELEASE_EVENTS],
+    type: "release_source"
+  };
+}
+
 // src/resource-events/repository.ts
 function gitHubRepositoryResource(input) {
   return {
@@ -115,8 +137,12 @@ function gitHubRepositorySubscribable(input) {
   if (!process.env.GITHUB_WEBHOOK_SECRET?.trim()) return void 0;
   return {
     ...gitHubRepositoryResource(input),
-    suggestedEvents: ["issue.opened", ...GITHUB_ISSUE_SUGGESTED_EVENTS],
-    supportedEvents: GITHUB_ISSUE_EVENTS,
+    suggestedEvents: [
+      "issue.opened",
+      ...GITHUB_ISSUE_SUGGESTED_EVENTS,
+      ...GITHUB_PULL_REQUEST_SUGGESTED_EVENTS
+    ],
+    supportedEvents: [...GITHUB_ISSUE_EVENTS, ...GITHUB_PULL_REQUEST_EVENTS],
     type: "repository"
   };
 }
@@ -125,6 +151,16 @@ function gitHubRepositorySubscribable(input) {
 function gitHubEventKey(deliveryId, eventType) {
   return `github:${deliveryId}:${eventType}`;
 }
+function pullRequestTargets(event, repo) {
+  const { terminal: _terminal, ...repositoryEvent } = event;
+  return [
+    event,
+    {
+      ...repositoryEvent,
+      identifier: gitHubRepositoryResource({ repo }).identifier
+    }
+  ];
+}
 var repositorySchema = z.object({ full_name: z.string().min(1) }).passthrough();
 var deploymentSchema = z.object({
   created_at: z.string().optional(),
@@ -265,21 +301,25 @@ function normalizeCheckSuiteEvents(deliveryId, body) {
   const eventType = conclusion === "failure" || conclusion === "timed_out" ? "pull_request.checks.failed" : conclusion === "success" ? "pull_request.checks.recovered" : void 0;
   if (!eventType) return [];
   const sha = parsed.data.check_suite.head_sha?.slice(0, 12);
-  return parsed.data.check_suite.pull_requests.map((pullRequest) => {
+  return parsed.data.check_suite.pull_requests.flatMap((pullRequest) => {
+    const repo = parsed.data.repository.full_name;
     const resource = gitHubPullRequestResource({
       number: pullRequest.number,
-      repo: parsed.data.repository.full_name
+      repo
     });
-    return {
-      eventKey: gitHubEventKey(
-        deliveryId,
-        `${eventType}:${pullRequest.number}`
-      ),
-      eventType,
-      occurredAtMs: Date.now(),
-      identifier: resource.identifier,
-      trustedSummary: eventType === "pull_request.checks.failed" ? `${resource.label} checks failed${sha ? ` for ${sha}` : ""}.` : `${resource.label} checks recovered${sha ? ` for ${sha}` : ""}.`
-    };
+    return pullRequestTargets(
+      {
+        eventKey: gitHubEventKey(
+          deliveryId,
+          `${eventType}:${pullRequest.number}`
+        ),
+        eventType,
+        occurredAtMs: Date.now(),
+        identifier: resource.identifier,
+        trustedSummary: eventType === "pull_request.checks.failed" ? `${resource.label} checks failed${sha ? ` for ${sha}` : ""}.` : `${resource.label} checks recovered${sha ? ` for ${sha}` : ""}.`
+      },
+      repo
+    );
   });
 }
 var issueCommentWebhookSchema = z.object({
@@ -305,7 +345,7 @@ function normalizeIssueCommentEvents(deliveryId, body) {
   if (parsed.data.issue.pull_request) {
     const eventType = "pull_request.comment.created";
     const resource = gitHubPullRequestResource(input);
-    return [
+    return pullRequestTargets(
       {
         eventKey: gitHubEventKey(deliveryId, eventType),
         eventType,
@@ -313,8 +353,9 @@ function normalizeIssueCommentEvents(deliveryId, body) {
         identifier: resource.identifier,
         trustedSummary: `${resource.label} received a comment${author ? ` from ${author}` : ""}.`,
         untrustedText: parsed.data.comment.body
-      }
-    ];
+      },
+      input.repo
+    );
   }
   const issue = gitHubIssueResource(input);
   const repository = gitHubRepositoryResource(input);
@@ -401,21 +442,25 @@ var pullRequestReviewCommentWebhookSchema = z.object({
 });
 function normalizePullRequestReviewCommentEvent(deliveryId, body) {
   const parsed = pullRequestReviewCommentWebhookSchema.safeParse(body);
-  if (!parsed.success || parsed.data.action !== "created") return void 0;
+  if (!parsed.success || parsed.data.action !== "created") return [];
   const eventType = "pull_request.review_comment.created";
+  const repo = parsed.data.repository.full_name;
   const resource = gitHubPullRequestResource({
     number: parsed.data.pull_request.number,
-    repo: parsed.data.repository.full_name
+    repo
   });
   const author = parsed.data.comment.user?.login;
-  return {
-    eventKey: gitHubEventKey(deliveryId, eventType),
-    eventType,
-    occurredAtMs: Date.now(),
-    identifier: resource.identifier,
-    trustedSummary: `${resource.label} received an inline review comment${author ? ` from ${author}` : ""}.`,
-    untrustedText: parsed.data.comment.body
-  };
+  return pullRequestTargets(
+    {
+      eventKey: gitHubEventKey(deliveryId, eventType),
+      eventType,
+      occurredAtMs: Date.now(),
+      identifier: resource.identifier,
+      trustedSummary: `${resource.label} received an inline review comment${author ? ` from ${author}` : ""}.`,
+      untrustedText: parsed.data.comment.body
+    },
+    repo
+  );
 }
 var pullRequestReviewWebhookSchema = z.object({
   action: z.string(),
@@ -429,23 +474,27 @@ var pullRequestReviewWebhookSchema = z.object({
 });
 function normalizePullRequestReviewEvent(deliveryId, body) {
   const parsed = pullRequestReviewWebhookSchema.safeParse(body);
-  if (!parsed.success || parsed.data.action !== "submitted") return void 0;
+  if (!parsed.success || parsed.data.action !== "submitted") return [];
   const reviewState = parsed.data.review.state.toUpperCase();
   const eventType = reviewState === "APPROVED" ? "pull_request.review.approved" : reviewState === "CHANGES_REQUESTED" ? "pull_request.review.changes_requested" : reviewState === "COMMENTED" ? "pull_request.review.commented" : void 0;
-  if (!eventType) return void 0;
+  if (!eventType) return [];
+  const repo = parsed.data.repository.full_name;
   const resource = gitHubPullRequestResource({
     number: parsed.data.pull_request.number,
-    repo: parsed.data.repository.full_name
+    repo
   });
   const reviewer = parsed.data.review.user?.login;
-  return {
-    eventKey: gitHubEventKey(deliveryId, eventType),
-    eventType,
-    occurredAtMs: Date.now(),
-    identifier: resource.identifier,
-    trustedSummary: eventType === "pull_request.review.approved" ? `${resource.label} was approved${reviewer ? ` by ${reviewer}` : ""}.` : eventType === "pull_request.review.changes_requested" ? `${resource.label} received requested changes${reviewer ? ` from ${reviewer}` : ""}.` : `${resource.label} received a review comment${reviewer ? ` from ${reviewer}` : ""}.`,
-    untrustedText: parsed.data.review.body ?? void 0
-  };
+  return pullRequestTargets(
+    {
+      eventKey: gitHubEventKey(deliveryId, eventType),
+      eventType,
+      occurredAtMs: Date.now(),
+      identifier: resource.identifier,
+      trustedSummary: eventType === "pull_request.review.approved" ? `${resource.label} was approved${reviewer ? ` by ${reviewer}` : ""}.` : eventType === "pull_request.review.changes_requested" ? `${resource.label} received requested changes${reviewer ? ` from ${reviewer}` : ""}.` : `${resource.label} received a review comment${reviewer ? ` from ${reviewer}` : ""}.`,
+      untrustedText: parsed.data.review.body ?? void 0
+    },
+    repo
+  );
 }
 var pullRequestWebhookSchema = z.object({
   action: z.string(),
@@ -464,22 +513,76 @@ function providerTime(value) {
 }
 function normalizePullRequestEvent(deliveryId, body) {
   const parsed = pullRequestWebhookSchema.safeParse(body);
-  if (!parsed.success || parsed.data.action !== "closed") return void 0;
+  if (!parsed.success || parsed.data.action !== "closed") return [];
   const eventType = parsed.data.pull_request.merged ? "pull_request.merged" : "pull_request.closed_unmerged";
+  const repo = parsed.data.repository.full_name;
   const resource = gitHubPullRequestResource({
     number: parsed.data.pull_request.number,
-    repo: parsed.data.repository.full_name
+    repo
   });
-  return {
-    eventKey: gitHubEventKey(deliveryId, eventType),
-    eventType,
-    occurredAtMs: providerTime(
-      parsed.data.pull_request.merged ? parsed.data.pull_request.merged_at : parsed.data.pull_request.closed_at
-    ) ?? Date.now(),
-    identifier: resource.identifier,
-    terminal: true,
-    trustedSummary: eventType === "pull_request.merged" ? `${resource.label} was merged.` : `${resource.label} was closed without being merged.`
-  };
+  return pullRequestTargets(
+    {
+      eventKey: gitHubEventKey(deliveryId, eventType),
+      eventType,
+      occurredAtMs: providerTime(
+        parsed.data.pull_request.merged ? parsed.data.pull_request.merged_at : parsed.data.pull_request.closed_at
+      ) ?? Date.now(),
+      identifier: resource.identifier,
+      terminal: true,
+      trustedSummary: eventType === "pull_request.merged" ? `${resource.label} was merged.` : `${resource.label} was closed without being merged.`
+    },
+    repo
+  );
+}
+var releaseWebhookSchema = z.object({
+  action: z.string(),
+  release: z.object({
+    body: z.string().optional().nullable(),
+    draft: z.boolean().optional(),
+    id: z.number(),
+    name: z.string().optional().nullable(),
+    prerelease: z.boolean().optional(),
+    published_at: z.string().optional().nullable(),
+    tag_name: z.string().min(1)
+  }).passthrough(),
+  repository: repositorySchema
+}).passthrough();
+function releaseSourceTargets(input) {
+  return [
+    {
+      completeOnTerminalEvent: true,
+      resource: gitHubReleaseSourceResource(input)
+    },
+    {
+      completeOnTerminalEvent: false,
+      resource: gitHubReleaseSourceResource({ repo: input.repo })
+    }
+  ];
+}
+function normalizeReleaseEvent(deliveryId, body) {
+  const parsed = releaseWebhookSchema.safeParse(body);
+  if (!parsed.success || parsed.data.action !== "published") return [];
+  if (parsed.data.release.draft) return [];
+  const eventType = "release.published";
+  const repo = parsed.data.repository.full_name;
+  const tag = parsed.data.release.tag_name;
+  const untrustedParts = [
+    tag ? `Tag: ${tag}` : void 0,
+    parsed.data.release.name?.trim() ? `Name: ${parsed.data.release.name.trim()}` : void 0,
+    parsed.data.release.body?.trim() || void 0
+  ].filter((part) => part !== void 0);
+  const untrustedText = untrustedParts.length > 0 ? untrustedParts.join("\n\n") : void 0;
+  return releaseSourceTargets({ repo, tag }).map(
+    ({ completeOnTerminalEvent, resource }) => ({
+      eventKey: gitHubEventKey(deliveryId, eventType),
+      eventType,
+      occurredAtMs: providerTime(parsed.data.release.published_at) ?? Date.now(),
+      identifier: resource.identifier,
+      ...completeOnTerminalEvent ? { terminal: true } : {},
+      trustedSummary: `${resource.label} was published (release ${parsed.data.release.id}).`,
+      ...untrustedText ? { untrustedText } : {}
+    })
+  );
 }
 function normalizeGitHubResourceEvents(args) {
   switch (args.eventName) {
@@ -490,28 +593,24 @@ function normalizeGitHubResourceEvents(args) {
       return normalizeDeploymentStatusEvent(args.deliveryId, args.body);
     }
     case "pull_request": {
-      const event = normalizePullRequestEvent(args.deliveryId, args.body);
-      return event ? [event] : [];
+      return normalizePullRequestEvent(args.deliveryId, args.body);
     }
     case "issues": {
       return normalizeIssueEvents(args.deliveryId, args.body);
     }
     case "pull_request_review": {
-      const event = normalizePullRequestReviewEvent(args.deliveryId, args.body);
-      return event ? [event] : [];
+      return normalizePullRequestReviewEvent(args.deliveryId, args.body);
     }
     case "issue_comment": {
       return normalizeIssueCommentEvents(args.deliveryId, args.body);
     }
     case "pull_request_review_comment": {
-      const event = normalizePullRequestReviewCommentEvent(
-        args.deliveryId,
-        args.body
-      );
-      return event ? [event] : [];
+      return normalizePullRequestReviewCommentEvent(args.deliveryId, args.body);
     }
     case "check_suite":
       return normalizeCheckSuiteEvents(args.deliveryId, args.body);
+    case "release":
+      return normalizeReleaseEvent(args.deliveryId, args.body);
     default:
       return [];
   }
@@ -527,6 +626,9 @@ export {
   GITHUB_PULL_REQUEST_EVENTS,
   GITHUB_PULL_REQUEST_SUGGESTED_EVENTS,
   gitHubPullRequestSubscribable,
+  GITHUB_RELEASE_EVENTS,
+  GITHUB_RELEASE_SUGGESTED_EVENTS,
+  gitHubReleaseSourceSubscribable,
   gitHubRepositorySubscribable,
   normalizeGitHubResourceEvents
 };