feat: message template added (shubhaamgupta11#19)

* feat: new template added for pr and issues on slack and discord

* feat: slack id makes optional

* dist changed

Author: shubhaamgupta11

README.md

@@ -47,10 +47,12 @@ jobs:
           # Slack-specific inputs
           slack_bot_token: "${{ secrets.SLACK_BOT_TOKEN }}"
           slack_channel: "<channel-id>"
-          slack_id_type: "<user/group>"
-          slack_id: "<user-id/group-id>"
+          slack_id_type: "<user/group>" # Optional: Only needed to ping someone directly.
+          slack_id: "<user-id/group-id>" # Optional: Only needed if slack_id_type is provided.
 ```
 
+> **Note:** slack_id_type and slack_id are only needed if you want to ping someone directly.
+
 ### Monitoring PRs with Discord
 
 ```yml
@@ -84,7 +86,7 @@ jobs:
           discord_webhook_url: "${{ secrets.DISCORD_WEBHOOK_URL }}"
 ```
 
-> **Note:** You can configure any notifier (slack, discord) for any task (monitor-issues, monitor-prs, etc.).
+> **Note:** You can configure any notifier (slack, discord) for any task (monitor-issues, monitor-prs, etc.). 
 
 ## 🔧 Inputs
 

action/integrations/discord.js

@@ -15,7 +15,7 @@ const discordWrapper = (webhookUrl) => {
 };
 
 // Send Discord Notifications
-const sendDiscordNotification = async (webhookUrl, issues, repo) => {
+const sendDiscordNotification = async (webhookUrl, issues, repo, type) => {
     if (!issues.length) {
       console.log("No issues found within the specified time frame.");
       return;
@@ -24,12 +24,30 @@ const sendDiscordNotification = async (webhookUrl, issues, repo) => {
     const discord = discordWrapper(webhookUrl);
 
     for (const issue of issues) {
-      const message = `
-      **New Issue in ${repo}**  
-      **Title:** ${issue.title}  
-      **Labels:** ${issue.labels.map((label) => `\`${label}\``).join(", ")}  
-      **Link:** ${issue.url}
-      `;
+        let message = '';
+        if (type === 'issue') {
+            message = `
+            :chart_with_upwards_trend: **New Issue in ${repo}**  
+            *-* **Title:** ${issue.title}  
+            *-* **Labels:** ${issue.labels
+              .map((label) => `\`${label}\``)
+              .join(", ")}  
+            *-* **Link:** <${issue.url}>
+
+        Mark as acknowledged👍 after triaging
+        `;
+        } else if (type === 'pr') {
+            message = `
+            :sparkles: **New Pull Request in ${repo}**  
+            *-* **Title:** ${issue.title}  
+            *-* **Author:** ${issue.author}
+            *-* **Labels:** ${issue.labels
+              .map((label) => `\`${label}\``)
+              .join(", ")}  
+            *-* **Link:** <${issue.url}>
+        Review and acknowledge👍
+        `;
+        }
 
       try {
         await discord.sendMessage(message);

action/integrations/slack.js

@@ -24,42 +24,76 @@ const slackWrapper = (token, channel) => {
   };
 };
 
-const sendSlackNotification = async (slackToken, slackChannel, slackIDType, slackID, issues, repo) => {
-    if (!issues.length) {
-      console.log("No issues found within the specified time frame.");
-      return;
-    }
-  
-    const slack = slackWrapper(slackToken, slackChannel);
-  
-    const assigneeText =
-      slackIDType === "group"
-        ? `*Assignee:* <!subteam^${slackID}> *(Mark as ACK or Done after triaging)*`
-        : slackIDType === "user"
-        ? `*Assignee:* <@${slackID}> *(Mark as ACK or Done after triaging)*`
-        : "";
-  
-    for (const issue of issues) {
-      const message = `
-      :chart_with_upwards_trend: *New Issue in ${repo}*  
-      *-* *Title:* ${issue.title}  
-      *-* *Labels:* ${issue.labels.map((label) => `\`${label}\``).join(", ")}  
-      *-* *Link:* <${issue.url}|View Issue>  
-      ${assigneeText}
-      `;
-  
-      try {
-        await slack.sendMessage({ text: message });
-        console.log(`Posted issue "${issue.title}" to Slack.`);
-      } catch (error) {
-        console.error(`Failed to post issue "${issue.title}" to Slack:`, error.message);
+const sendSlackNotification = async (
+  slackToken,
+  slackChannel,
+  slackIDType,
+  slackID,
+  issues,
+  repo,
+  type
+) => {
+  if (!issues.length) {
+    console.log("No issues found within the specified time frame.");
+    return;
+  }
+
+  const slack = slackWrapper(slackToken, slackChannel);
+
+  for (const issue of issues) {
+    let message = "";
+    let assigneeText = "";
+
+    if (type === "issue") {
+      assigneeText =
+        slackIDType === "group"
+          ? `*Assignee:* <!subteam^${slackID}> *(Mark as ACK or Done after triaging)*`
+          : slackIDType === "user"
+          ? `*Assignee:* <@${slackID}> *(Mark as ACK or Done after triaging)*`
+          : "";
+
+      message = `
+            :chart_with_upwards_trend: *New Issue in ${repo}*  
+            *-* *Title:* ${issue.title}  
+            *-* *Labels:* ${issue.labels
+              .map((label) => `\`${label}\``)
+              .join(", ")}  
+            *-* *Link:* <${issue.url}|View Issue>  
+            ${assigneeText}
+        `;
+    } else if (type === "pr") {
+      if (slackIDType === "group") {
+        assigneeText = `*Reviewer:* <!subteam^${slackID}> *(Review and acknowledge)*`;
+      } else if (slackIDType === "user") {
+        assigneeText = `*Reviewer:* <@${slackID}> *(Review and acknowledge)*`;
       }
-  
-      console.log("Waiting for 30 seconds before sending the next message...");
-      await delay(5 * 1000);
+      message = `
+            :sparkles: *New Pull Request in ${repo}*  
+            *-* *Title:* ${issue.title}  
+            *-* *Author:* ${issue.author}
+            *-* *Labels:* ${issue.labels
+              .map((label) => `\`${label}\``)
+              .join(", ")}  
+            *-* *Link:* <${issue.url}|View PR>  
+            ${assigneeText}
+            `;
     }
-  
-    console.log(`*** All issues posted on Slack for ${repo} ***`);
-  };
+
+    try {
+      await slack.sendMessage({ text: message });
+      console.log(`Posted issue "${issue.title}" to Slack.`);
+    } catch (error) {
+      console.error(
+        `Failed to post issue "${issue.title}" to Slack:`,
+        error.message
+      );
+    }
+
+    console.log("Waiting for 30 seconds before sending the next message...");
+    await delay(5 * 1000);
+  }
+
+  console.log(`*** All issues posted on Slack for ${repo} ***`);
+};
 
 module.exports = sendSlackNotification;

action/monitor-new-issue.js

@@ -98,7 +98,8 @@ async function monitorIssues({
       slackIDType,
       slackID,
       issues,
-      repo
+      repo,
+      "issue"
     );
   } else if (notifier === "discord") {
     const {
@@ -108,7 +109,7 @@ async function monitorIssues({
       "🔔 Sending notifications to Discord for issues:",
       issues.map((issue) => issue.title)
     );
-    await sendDiscordNotification(discordWebhookUrl, issues, repo);
+    await sendDiscordNotification(discordWebhookUrl, issues, repo, "issue");
   } else {
     throw new Error("Unsupported notifier. Use 'slack' or 'discord'.");
   }

action/monitor-new-pr.js

@@ -101,7 +101,8 @@ async function monitorPRs({
       slackIDType,
       slackID,
       prs,
-      repo
+      repo,
+      "pr"
     );
   } else if (notifier === "discord") {
     const {
@@ -111,7 +112,7 @@ async function monitorPRs({
       "🔔 Sending notifications to Discord for PRs:",
       prs.map((pr) => pr.title)
     );
-    await sendDiscordNotification(discordWebhookUrl, prs, repo);
+    await sendDiscordNotification(discordWebhookUrl, prs, repo, "pr");
   } else {
     throw new Error("Unsupported notifier. Use 'slack' or 'discord'.");
   }