feat: new features added (shubhaamgupta11#20)

* feat: payload change for slack and discord

* feat: added support for discord role and user id

* feat: added preview images

* fix: preview style changed

* feat: preview added

* node updated to 22

* feat: error mechanism added

Author: shubhaamgupta11

.github/workflows/example.yml

@@ -1,27 +1,26 @@
-name: Test Action
+name: Repo Activity Monitor Workflow
 
 on:
-  workflow_dispatch:
+  workflow_dispatch: # Allows manual triggering of the workflow
 
 jobs:
-  test-action:
+  monitor-repo-activity:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout the code
-        uses: actions/checkout@v3
-
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 22 # Use Node.js 22 for the workflow
 
-      - name: Test Local Action
-        uses: ./ # This points to the root of your action's repo
+      - name: Run Repo Activity Monitor
+        uses: ./ # Points to the local action repository
         with:
-          task: "monitor-issues"
-          git_secret: ${{ secrets.GIT_SECRET }}
-          notifier: "discord"
-          fetch_data_interval: 2 # in hours
-          discord_webhook_url: ${{ secrets.DISCORD_WEBHOOK_URL }}
-          repo_owner: "facebook"
-          repo_name: "react-native"
+          task: "monitor-issues" # Task to monitor issues (can be "monitor-prs" as well)
+          git_secret: ${{ secrets.GIT_SECRET }} # GitHub token
+          repo_owner: "facebook" # Replace with the repository owner
+          repo_name: "react-native" # Replace with the repository name
+          fetch_data_interval: 2 # Fetch data from the last 2 hours
+          notifier: "discord" # Use Discord for notifications
+          discord_webhook_url: ${{ secrets.DISCORD_WEBHOOK_URL }} # Discord webhook URL
+          discord_id_type: "role" # Type of Discord ID ("user" or "role")
+          discord_id: "111111111111111111" # Replace with the Discord role ID to mention

README.md

@@ -1,4 +1,4 @@
-# Monitor Issues & PRs with Slack/Discord Notifications
+# Monitor Issues & PRs with Slack+Discord Notifications
 
 Managing activity in open-source repositories can be challenging. With a constant influx of **issues** and **pull requests**, it's easy to lose track of what needs attention—especially when working with large teams or active projects. Missed notifications or delayed responses can lead to bottlenecks, reduced contributor satisfaction, and slower project progress.
 
@@ -8,8 +8,9 @@ This [GitHub Action](https://github.com/marketplace/actions/repo-activity-monito
 
 - Tracking new issues and pull requests.
 - Sending auto-generated notifications to **Slack** or **Discord**.
-- Customizing Slack notifications with the ability to ping specific users or groups.
-- Allowing Slack notifications to be sent to designated channels.
+- Customizing **Slack** notifications with the ability to ping specific users or groups.
+- Customizing **Discord** notifications with the ability to ping specific users or roles.
+- Allowing **Slack** notifications to be sent to designated channels.
 
 With **Repo Activity Monitor**, you can stay on top of your repositories activities, streamline communication, and ensure no critical issues or pull requests fall through the cracks.
 
@@ -30,15 +31,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: '16'
+          node-version: '22'
       - name: Monitor New Issues
-        uses: shubhaamgupta11/repo-monitor@v0.6.0
+        uses: shubhaamgupta11/repo-monitor@v1.0.0
         with:
           # required inputs
           task: "monitor-issues"
-          git_secret: "${{ secrets.GITHUB_TOKEN }}"
+          git_secret: "${{ secrets.GIT_SECRET }}"
           notifier: "slack"
           fetch_data_interval: 1  # Hours (must align with your cron schedule)
           # repo inputs
@@ -68,26 +69,54 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: '16'
+          node-version: '22'
       - name: Monitor New PRs
-        uses: shubhaamgupta11/repo-monitor@v0.6.0
+        uses: shubhaamgupta11/repo-monitor@v1.0.0
         with:
           # required inputs
           task: "monitor-prs"
-          git_secret: "${{ secrets.GITHUB_TOKEN }}"
+          git_secret: "${{ secrets.GIT_SECRET }}"
           notifier: "discord"
           fetch_data_interval: 1  # Hours (must align with your cron schedule)
           # repo inputs
           repo_owner: "<owner>"
           repo_name: "<repo>"
           # Discord-specific inputs
           discord_webhook_url: "${{ secrets.DISCORD_WEBHOOK_URL }}"
+          discord_id_type: "<user/role>" # Optional: Only needed to ping someone directly.
+          discord_id: "<user-id/role-id>" # Optional: Only needed if discord_id_type is provided.
 ```
 
 > **Note:** You can configure any notifier (slack, discord) for any task (monitor-issues, monitor-prs, etc.). 
 
+## Message Previews
+Below are examples of how the notifications look on Slack and Discord.
+
+### Slack Notification Previews
+<details> <summary>Click to view Slack notifications</summary>
+
+For Issues
+
+<img src="./assets/slack-issue-notification.png" alt="Slack Issue Notification" width="400"/>
+
+For Pull Requests
+
+<img src="./assets/slack-pr-notification.png" alt="Slack PR Notification" width="400"/> </details>
+
+### Discord Notification Previews
+<details> <summary>Click to view Discord notifications</summary>
+
+For Issues
+
+<img src="./assets/discord-issue-notification.png" alt="Discord Issue Notification" width="400"/>
+
+For Pull Requests
+
+<img src="./assets/discord-pr-notification.png" alt="Discord PR Notification" width="400"/> </details>
+
+
 ## 🔧 Inputs
 
 | Input | Description | Required | Default |
@@ -103,6 +132,8 @@ jobs:
 | slack_id_type | Type of Slack ID (user or group, required if notifier=`slack`). This is needed to ping someone directly. | No | None |
 | slack_id | user id or group id as per `slack_id_type` (required if notifier=`slack`). | No | None |
 | discord_webhook_url | Discord webhook URL to send notifications (required if notifier=`discord`). | No | None |
+| discord_id_type | Type of Discord ID (user or role, required if notifier=`discord`). This is needed to ping someone directly. | No | None |
+| discord_id | user id or role id as per `discord_id_type` (required if notifier=`discord`). | No | None |
 
 ## 📖 How It Works
 - The action listens for new issues or PRs in the specified GitHub repository.
@@ -119,15 +150,17 @@ jobs:
 - Retrieve the Channel ID and User/Group IDs.
 - Add these secrets to your GitHub repository:
   - `SLACK_BOT_TOKEN`
-  - `SLACK_CHANNEL`
-  - `SLACK_ID_TYPE`
-  - `SLACK_ID`
+- Provide the Slack Channel ID, Slack ID Type and Slack ID in the workflow.
 
 ### Discord
 
 - Create a [Discord Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks).
 - Copy the Webhook URL.
 - Add the Webhook URL to your GitHub repository secrets as `DISCORD_WEBHOOK_URL`.
+- Retrieve the User/Role IDs.
+- Add these secrets to your GitHub repository:
+  - `DISCORD_WEBHOOK_URL`
+- Provide the Discord Webhook URL, Discord ID Type and Discord ID in the workflow.
 
 ## 🔮 Roadmap
 
@@ -139,3 +172,6 @@ jobs:
 ## 📜 License
 
 This project is licensed under the [MIT License](https://github.com/shubhaamgupta11/repo-monitor/blob/main/LICENSE).
+
+## Support & Feedback
+If you find this action helpful, please give the repository a ⭐️ on GitHub! Your support helps us grow and continue improving. Feel free to raise issues or suggest enhancements to make this even better.

action.yml

@@ -41,10 +41,16 @@ inputs:
   discord_webhook_url:
     description: Discord webhook URL to send notifications.
     required: false
+  discord_id_type:
+    description: Type of Discord ID (user or role).
+    required: false
+  discord_id:
+    description: Discord ID of the recipient (user or role).
+    required: false
 
 
 runs:
-  using: node16
+  using: node22
   main: dist/index.js
 
 outputs:

action/index.js

@@ -21,6 +21,8 @@ async function run() {
 
     // Discord-specific inputs
     const discordWebhookUrl = core.getInput("discord_webhook_url");
+    const discordIDType = core.getInput("discord_id_type");
+    const discordID = core.getInput("discord_id");
 
     switch (task) {
       case "monitor-issues":
@@ -30,7 +32,7 @@ async function run() {
           repo,
           notifier,
           slackConfig: { slackToken, slackChannel, slackIDType, slackID },
-          discordConfig: { discordWebhookUrl },
+          discordConfig: { discordWebhookUrl, discordIDType, discordID },
           alertTime,
         });
         break;
@@ -42,7 +44,7 @@ async function run() {
           repo,
           notifier,
           slackConfig: { slackToken, slackChannel, slackIDType, slackID },
-          discordConfig: { discordWebhookUrl },
+          discordConfig: { discordWebhookUrl, discordIDType, discordID },
           alertTime,
         });
         break;

action/integrations/discord.js

@@ -1,9 +1,11 @@
 const axios = require("axios");
 const delay = require("../utility/delay");
+const { generateDiscordPayload } = require("../utility/generatePayload");
+
 const discordWrapper = (webhookUrl) => {
   const sendMessage = async (content) => {
     try {
-      await axios.post(webhookUrl, { content });
+      await axios.post(webhookUrl,  content );
     } catch (e) {
       console.error("Unable to send Discord message:", e.message);
     }
@@ -15,48 +17,26 @@ const discordWrapper = (webhookUrl) => {
 };
 
 // Send Discord Notifications
-const sendDiscordNotification = async (webhookUrl, issues, repo, type) => {
+const sendDiscordNotification = async (webhookUrl, issues, repo, type, discordIDType, discordID) => {
     if (!issues.length) {
       console.log("No issues found within the specified time frame.");
       return;
     }
 
     const discord = discordWrapper(webhookUrl);
-  
-    for (const issue of issues) {
-        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👍
-        `;
-        }
+
+    for (const issue of issues) {
+      let payload = generateDiscordPayload({type, repo, issue, discordIDType, discordID});
 
       try {
-        await discord.sendMessage(message);
+        await discord.sendMessage(payload);
         console.log(`Posted issue "${issue.title}" to Discord.`);
       } catch (error) {
         console.error(`Failed to post issue "${issue.title}" to Discord:`, error.message);
       }
 
-      console.log("Waiting for 30 seconds before sending the next message...");
+      // Introduce a delay between messages to avoid rate limiting
       await delay(5 * 1000);
     }
 

action/integrations/slack.js

@@ -1,5 +1,6 @@
 const { WebClient } = require("@slack/web-api");
 const delay = require("../utility/delay");
+const { generateSlackPayload } = require("../utility/generatePayload");
 
 const slackWrapper = (token, channel) => {
   const client = new WebClient(token);
@@ -41,46 +42,16 @@ const sendSlackNotification = async (
   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)*`;
-      }
-      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}
-            `;
-    }
+    const payload = generateSlackPayload({
+      type,
+      repo,
+      issue,
+      slackIDType,
+      slackID,
+    });
 
     try {
-      await slack.sendMessage({ text: message });
+      await slack.sendMessage(payload);
       console.log(`Posted issue "${issue.title}" to Slack.`);
     } catch (error) {
       console.error(
@@ -89,7 +60,7 @@ const sendSlackNotification = async (
       );
     }
 
-    console.log("Waiting for 30 seconds before sending the next message...");
+    // Introduce a delay between messages to avoid rate limiting
     await delay(5 * 1000);
   }
 

action/monitor-new-issue.js

@@ -46,6 +46,8 @@ const fetchNewIssues = async (gitToken, owner, repo, alertTime) => {
         ...issues.map((issue) => ({
           title: issue.title,
           url: issue.html_url,
+          avatar_url: issue.user.avatar_url,
+          author: issue.user.login,
           createdAt: issue.created_at,
           labels: issue.labels.map((label) => label.name),
           comments: issue.comments,
@@ -60,7 +62,7 @@ const fetchNewIssues = async (gitToken, owner, repo, alertTime) => {
 
     return newIssues;
   } catch (error) {
-    console.error("Error fetching issues:", error.message);
+    console.error("Error fetching issues:", error.response.data);
     return [];
   }
 };
@@ -104,12 +106,14 @@ async function monitorIssues({
   } else if (notifier === "discord") {
     const {
       discordWebhookUrl,
+      discordIDType,
+      discordID,
     } = discordConfig;
     console.log(
       "🔔 Sending notifications to Discord for issues:",
       issues.map((issue) => issue.title)
     );
-    await sendDiscordNotification(discordWebhookUrl, issues, repo, "issue");
+    await sendDiscordNotification(discordWebhookUrl, issues, repo, "issue", discordIDType, discordID);
   } else {
     throw new Error("Unsupported notifier. Use 'slack' or 'discord'.");
   }