feat: add release notes to frontend Slack notifications (#72)

snomiao · claude · Copilot · web-flow · commit 42db8e3f49f4 · 2025-09-11T23:32:34.000Z
* feat: add release notes to frontend Slack notifications - Include GitHub release body content in Slack messages - Format release notes with proper Slack markdown - Truncate long release notes (>500 chars) with "Read more" link - Update tests to cover release notes functionality This enhancement provides better context in Slack notifications by including the actual release notes from GitHub, making it easier for team members to understand what changed in each release. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Update app/tasks/gh-frontend-release-notification/index.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * feat: add release notes to frontend Slack notifications - Integrated release notes fetching for frontend releases - Enhanced Slack message formatting with release details - Updated message structure for better readability --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
diff --git a/app/tasks/gh-desktop-release-notification/upsertSlackMessage.ts b/app/tasks/gh-desktop-release-notification/upsertSlackMessage.ts
@@ -1,10 +1,12 @@
+#!/usr/bin/env bun --hot
 import { slack } from "@/src/slack";
 import { getSlackChannel } from "@/src/slack/channels";
 import KeyvSqlite from "@keyv/sqlite";
 import DIE from "@snomiao/die";
 import Keyv from "keyv";
 import { slackMessageUrlParse, slackMessageUrlStringify } from "../gh-design/gh-design";
 import { COMFY_PR_CACHE_DIR } from "./COMFY_PR_CACHE_DIR";
+import chalk from "chalk";
 
 const SlackChannelIdsCache = new Keyv<string>({
   store: new KeyvSqlite("sqlite://" + COMFY_PR_CACHE_DIR + "/slackChannelIdCache.sqlite"),
@@ -49,7 +51,11 @@ export async function upsertSlackMessage({
   if (!channel) DIE(`No slack channel specified`);
 
   if (!url) {
-    if (process.env.DRY_RUN) throw new Error("sending slack message: " + JSON.stringify({ text, channel }));
+    if (process.env.DRY_RUN) {
+      console.error("DRY RUN MODE");
+      console.error("sending text:", text);
+      throw new Error(chalk.red("Sending slack message to: " + JSON.stringify({  channel })))
+    };
     const thread_ts = !replyUrl ? undefined : slackMessageUrlParse(replyUrl).ts;
     const msg = !thread_ts
       ? await slack.chat.postMessage({ text, channel })
@@ -58,7 +64,11 @@ export async function upsertSlackMessage({
     const url = slackMessageUrlStringify({ channel, ts: msg.ts! });
     return { ...msg, url, text, channel };
   }
-  if (process.env.DRY_RUN) throw new Error("updating slack message: " + JSON.stringify({ text, channel, url }));
+  if (process.env.DRY_RUN) {
+    console.error("DRY RUN MODE");
+    console.error("sending text:", text);
+    throw new Error(chalk.red("Updating slack message to: " + JSON.stringify({  channel, url })))
+  };
   const ts = slackMessageUrlParse(url).ts;
   const msg = await slack.chat.update({ text, channel, ts });
   return { ...msg, url, text, channel };
diff --git a/app/tasks/gh-frontend-release-notification/index.spec.ts b/app/tasks/gh-frontend-release-notification/index.spec.ts
@@ -77,6 +77,7 @@ describe("GithubFrontendReleaseNotificationTask", () => {
         version: mockRelease.tag_name,
         status: "stable",
         isStable: true,
+        releaseNotes: mockRelease.body,
         createdAt: new Date(mockRelease.created_at),
         releasedAt: new Date(mockRelease.published_at),
       });
@@ -87,10 +88,11 @@ describe("GithubFrontendReleaseNotificationTask", () => {
         version: mockRelease.tag_name,
         status: "stable",
         isStable: true,
+        releaseNotes: mockRelease.body,
         createdAt: new Date(mockRelease.created_at),
         releasedAt: new Date(mockRelease.published_at),
         slackMessage: {
-          text: "🎨 ComfyUI_frontend <https://github.com/Comfy-Org/ComfyUI_frontend/releases/tag/v1.0.0|Release v1.0.0> is stable!",
+          text: "🎨 ComfyUI_frontend <https://github.com/Comfy-Org/ComfyUI_frontend/releases/tag/v1.0.0|Release v1.0.0> is stable!\n\n*Release Notes:*\nRelease notes",
           channel: "test-channel-id",
           url: "https://slack.com/message/123",
         },
@@ -135,10 +137,11 @@ describe("GithubFrontendReleaseNotificationTask", () => {
         version: mockRelease.tag_name,
         status: "stable",
         isStable: true,
+        releaseNotes: mockRelease.body,
         createdAt: new Date(mockRelease.created_at),
         releasedAt: new Date(mockRelease.published_at),
         slackMessage: {
-          text: "🎨 ComfyUI_frontend <https://github.com/Comfy-Org/ComfyUI_frontend/releases/tag/v1.0.0|Release v1.0.0> is stable!",
+          text: "🎨 ComfyUI_frontend <https://github.com/Comfy-Org/ComfyUI_frontend/releases/tag/v1.0.0|Release v1.0.0> is stable!\n\n*Release Notes:*\nRelease notes",
           channel: "test-channel-id",
           url: "https://slack.com/message/123",
         },
@@ -173,6 +176,7 @@ describe("GithubFrontendReleaseNotificationTask", () => {
         version: mockPrerelease.tag_name,
         status: "prerelease",
         isStable: false,
+        releaseNotes: mockPrerelease.body,
         createdAt: new Date(mockPrerelease.created_at),
         releasedAt: new Date(mockPrerelease.published_at),
       });
@@ -183,10 +187,11 @@ describe("GithubFrontendReleaseNotificationTask", () => {
         version: mockPrerelease.tag_name,
         status: "prerelease",
         isStable: false,
+        releaseNotes: mockPrerelease.body,
         createdAt: new Date(mockPrerelease.created_at),
         releasedAt: new Date(mockPrerelease.published_at),
         slackMessageDrafting: {
-          text: "🎨 ComfyUI_frontend <https://github.com/Comfy-Org/ComfyUI_frontend/releases/tag/v1.0.0-beta.1|Release v1.0.0-beta.1> is prerelease!",
+          text: "🎨 ComfyUI_frontend <https://github.com/Comfy-Org/ComfyUI_frontend/releases/tag/v1.0.0-beta.1|Release v1.0.0-beta.1> is prerelease!\n\n*Release Notes:*\nBeta release notes",
           channel: "test-channel-id",
           url: "https://slack.com/message/456",
         },
@@ -224,6 +229,7 @@ describe("GithubFrontendReleaseNotificationTask", () => {
         version: mockDraft.tag_name,
         status: "draft",
         isStable: false,
+        releaseNotes: mockDraft.body,
         createdAt: new Date(mockDraft.created_at),
         releasedAt: undefined,
       });
@@ -265,6 +271,7 @@ describe("GithubFrontendReleaseNotificationTask", () => {
         version: oldRelease.tag_name,
         status: "stable",
         isStable: true,
+        releaseNotes: oldRelease.body,
         createdAt: new Date(oldRelease.created_at),
         releasedAt: new Date(oldRelease.published_at),
       });
@@ -299,6 +306,7 @@ describe("GithubFrontendReleaseNotificationTask", () => {
         version: mockRelease.tag_name,
         status: "stable",
         isStable: true,
+        releaseNotes: mockRelease.body,
         createdAt: new Date(mockRelease.created_at),
         releasedAt: new Date(mockRelease.published_at),
         slackMessage: {
@@ -314,8 +322,9 @@ describe("GithubFrontendReleaseNotificationTask", () => {
         version: mockRelease.tag_name,
         status: "stable",
         isStable: true,
+        releaseNotes: mockRelease.body,
         slackMessage: {
-          text: "🎨 ComfyUI_frontend <https://github.com/Comfy-Org/ComfyUI_frontend/releases/tag/v1.0.0|Release v1.0.1> is stable!",
+          text: "🎨 ComfyUI_frontend <https://github.com/Comfy-Org/ComfyUI_frontend/releases/tag/v1.0.0|Release v1.0.1> is stable!\n\n*Release Notes:*\nUpdated release notes",
           channel: "test-channel-id",
           url: "https://slack.com/message/123",
         },
@@ -331,6 +340,59 @@ describe("GithubFrontendReleaseNotificationTask", () => {
         }),
       );
     });
+
+    it("should truncate long release notes in Slack message", async () => {
+      const longReleaseNotes = "x".repeat(600); // Create a 600 character string
+      const mockRelease = {
+        html_url: "https://github.com/Comfy-Org/ComfyUI_frontend/releases/tag/v1.0.0",
+        tag_name: "v1.0.0",
+        draft: false,
+        prerelease: false,
+        created_at: new Date().toISOString(),
+        published_at: new Date().toISOString(),
+        body: longReleaseNotes,
+      };
+
+      mockGh.repos = {
+        listReleases: jest.fn().mockResolvedValue({
+          data: [mockRelease],
+        }),
+      } as any;
+
+      // First call - save initial data
+      collection.findOneAndUpdate.mockResolvedValueOnce({
+        url: mockRelease.html_url,
+        version: mockRelease.tag_name,
+        status: "stable",
+        isStable: true,
+        releaseNotes: longReleaseNotes,
+        createdAt: new Date(mockRelease.created_at),
+        releasedAt: new Date(mockRelease.published_at),
+      });
+
+      // Second call - save with truncated message
+      collection.findOneAndUpdate.mockResolvedValueOnce({
+        url: mockRelease.html_url,
+        version: mockRelease.tag_name,
+        status: "stable",
+        isStable: true,
+        releaseNotes: longReleaseNotes,
+        slackMessage: {
+          text: expect.stringContaining("... <"),
+          channel: "test-channel-id",
+          url: "https://slack.com/message/123",
+        },
+      });
+
+      await runGithubFrontendReleaseNotificationTask();
+
+      // Check that the message was truncated and includes a "Read more" link
+      expect(upsertSlackMessage).toHaveBeenCalledWith(
+        expect.objectContaining({
+          text: expect.stringMatching(/\.\.\. <.*\|Read more>/),
+        }),
+      );
+    });
   });
 
   describe("Database Index", () => {
diff --git a/app/tasks/gh-frontend-release-notification/index.ts b/app/tasks/gh-frontend-release-notification/index.ts
@@ -1,3 +1,4 @@
+#!/usr/bin/env bun --hot
 import { db } from "@/src/db";
 import { gh } from "@/src/gh";
 import { parseGithubRepoUrl } from "@/src/parseOwnerRepo";
@@ -31,6 +32,7 @@ export type GithubFrontendReleaseNotificationTask = {
   releasedAt?: Date;
   isStable?: boolean;
   status: "draft" | "prerelease" | "stable";
+  releaseNotes?: string;
 
   slackMessageDrafting?: {
     text: string;
@@ -81,23 +83,35 @@ async function runGithubFrontendReleaseNotificationTask() {
       const url = release.html_url;
       const status = release.draft ? "draft" : release.prerelease ? "prerelease" : "stable";
 
+      // Extract release notes from body
+      const releaseNotes = release.body ?? "";
+
       let task = await save({
         url,
         status: status,
         isStable: status == "stable",
         version: release.tag_name,
+        releaseNotes: releaseNotes,
         createdAt: new Date(release.created_at || DIE("no created_at in release, " + JSON.stringify(release))),
         releasedAt: !release.published_at ? undefined : new Date(release.published_at),
       });
 
       if (+task.createdAt! < +new Date(config.sendSince)) return task;
 
+      // Format release notes for Slack (not truncate, slack will fold automatically)
+      const formattedReleaseNotes = task.isStable ? releaseNotes || "" : "";
+
       const newSlackMessageText = config.slackMessage
         .replace("{url}", task.url)
-        .replace("{repo}", parseGithubUrl(task.url)?.repo || DIE(`unable parse REPO from URL ${task.url}`))
-        .replace("{version}", task.version || DIE(`unable to parse version from task ${JSON.stringify(task)}`))
-        .replace("{status}", task.status);
-
+        .replace("{repo}", parseGithubUrl(task.url)?.repo || DIE(`Unable to parse REPO from URL ${task.url}`))
+        .replace("{version}", task.version || DIE(`Unable to parse version from task ${JSON.stringify(task)}`))
+        .replace("{status}", task.status)
+        .replace(/$/, "\n" + formattedReleaseNotes)
+        .replace(/(.*) in (https:\/\/\S*)$/gm, "<$2|$1>") // linkify URLs at the end of lines;
+        .replace(/^([\s\S]{1800}.*)\r?\n[\s\S]*?(.*[\s\S]{1800})$/, "$1\n...TRUNCATED...\n$2") // truncate to 4000 characters, slack limit is 40000 but be safe
+        .replace('**Full Changelog**', 'Full Changelog'); 
+
+      console.log(newSlackMessageText);
       const shouldSendDraftingMessage = !task.isStable;
       const draftingTextChanged =
         !task.slackMessageDrafting?.text || task.slackMessageDrafting.text.trim() !== newSlackMessageText.trim();
@@ -108,6 +122,9 @@ async function runGithubFrontendReleaseNotificationTask() {
             channelName: config.slackChannelName,
             text: newSlackMessageText,
             url: task.slackMessageDrafting?.url,
+          }).catch((e) => {
+            console.error("Failed to send draft slack message for release", task.url, e);
+            throw e;
           }),
         });
       }
@@ -123,10 +140,12 @@ async function runGithubFrontendReleaseNotificationTask() {
             text: newSlackMessageText,
             url: task.slackMessage?.url,
             replyUrl: task.slackMessageDrafting?.url,
+          }).catch((e) => {
+            console.error("Failed to send slack message for release", task.url, JSON.stringify(e));
+            throw e;
           }),
         });
       }
-
       return task;
     })
     .log()
diff --git a/src/updateSlackMessages.ts b/src/updateSlackMessages.ts
@@ -4,6 +4,9 @@ import pMap from "p-map";
 import { postSlackMessage } from "./postSlackMessage";
 import { SlackMsgs } from "./slack/SlackMsgs";
 
+/**
+ * @deprecated use upsertSlackMessage instead
+ */
 export async function updateSlackMessages() {
   // send
   return await pMap(
