feat: readme updated (shubhaamgupta11#17)

shubhaamgupta11 · web-flow · commit 77d9fee9f30e · 2025-01-26T11:27:24.000+05:30
* feat: enhanced readme and package json content

* feat: version bumup
diff --git a/.github/workflows/example.yml b/.github/workflows/example.yml
@@ -21,7 +21,7 @@ jobs:
           task: "monitor-issues"
           git_secret: ${{ secrets.GIT_SECRET }}
           notifier: "discord"
-          fetch_data_interval: 24
-          discord_webhook_url: "https://discord.com/api/webhooks/1332703260401729689/5RWQZ3PticjEsiOh3BlxxWHJj_t2ucxxqAfIDj3ELZeZ06JXSoqW2F4fxjhvvYc6hNkP"
+          fetch_data_interval: 2 # in hours
+          discord_webhook_url: ${{ secrets.DISCORD_WEBHOOK_URL }}
           repo_owner: "facebook"
           repo_name: "react-native"
diff --git a/README.md b/README.md
@@ -1,39 +1,27 @@
-# Monitor Issues and PRs GitHub Action
+# GitHub Action for Tracking Issues & Pull Requests
 
-## Overview
-A GitHub Action to monitor new issues and pull requests in a specified repository and send notifications to Slack or Discord. This action allows you to track activity in your repositories and get alerted when new issues or PRs are created.
+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.
 
-## Features
+## Repo Activity Monitor
 
-- Monitor issues and PRs in a GitHub repository.
-- Support for multiple notification methods.
-- Easy integration with GitHub workflows.
+This [GitHub Action](https://github.com/marketplace/actions/repo-monitor) empowers open-source maintainers by:
 
-## Inputs
+- Tracking new issues and pull requests in real time.
+- Sending notifications to your preferred communication platforms like **Slack** or **Discord**
 
-| Input | Description | Required | Default |
-| ----- | ----------- | -------- | ------- |
-| task | The task to run (monitor-issues or monitor-prs). | Yes | None |
-| git_secret | GitHub token for authentication. | Yes | None |
-| repo_owner | The owner of the GitHub repository (`facebook`). | Yes | None |
-| repo_name | The name of the GitHub repository (`react-native`). | Yes | None |
-| fetch_data_interval | The time interval to fetch data for (e.g., 1 hour, 24 hours). This should align with the cron schedule. | Yes | None |
-| notifier | Notification method (**slack** or **discord**). | Yes | None |
-| slack_bot_token | Slack bot token to send notifications (required if notifier=`slack`). | No | None |
-| slack_channel | The Slack channel id to send notifications to (required if notifier=`slack`). | No | None |
-| 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 |
+With **Repo ActivityMonitor**, you can stay on top of your repositories' activities, streamline communication, and ensure no critical issues or pull requests fall through the cracks.
 
-## Example Usage
+## Usage
+
+### Monitoring Issues with Slack
 
 ```yml
 name: Monitor GitHub Repo
 
 on:
   schedule:
     - cron: "0 * * * *" # Runs every hour
-  workflow_dispatch:
+  workflow_dispatch: # Optional
 
 jobs:
   run-notifier:
@@ -43,46 +31,101 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: '16'
-      - name: Run action
-        uses: ./ # Path to your action
+      - name: Monitor New Issues
+        uses: shubhaamgupta11/repo-monitor@v0.6.0
         with:
           task: "monitor-issues"
           git_secret: "${{ secrets.GITHUB_TOKEN }}"
-          notifier: "slack"  # Or "discord"
-          fetch_data_interval: 24  # Hours (must align with your cron schedule)
+          notifier: "slack"
+          fetch_data_interval: 1  # Hours (must align with your cron schedule)
           slack_bot_token: "${{ secrets.SLACK_BOT_TOKEN }}"
-          slack_channel: "#your-channel"
-          repo_owner: "facebook"
-          repo_name: "react-native"
+          slack_channel: "<channel-id>"
+          slack_id_type: "<user/group>"
+          slack_id: "<user-id/group-id>"
+          repo_owner: "<owner>"
+          repo_name: "<repo>"
+```
+
+### Monitoring PRs with Discord
+
+```yml
+name: Monitor GitHub Repo
+
+on:
+  schedule:
+    - cron: "0 * * * *" # Runs every hour
+  workflow_dispatch: # Optional to trigger manually
+
+jobs:
+  run-notifier:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+      - name: Monitor New PRs
+        uses: shubhaamgupta11/repo-monitor@v0.6.0
+        with:
+          task: "monitor-prs"
+          git_secret: "${{ secrets.GITHUB_TOKEN }}"
+          notifier: "discord"
+          fetch_data_interval: 1  # Hours (must align with your cron schedule)
+          discord_webhook_url: "${{ secrets.DISCORD_WEBHOOK_URL }}"
+          repo_owner: "<owner>"
+          repo_name: "<repo>"       
 ```
 
-## How It Works
+> **Note:** You can configure any notifier (slack, discord, or others) for any task (monitor-issues, monitor-prs, etc.).
+
+## 🔧 Inputs
+
+| Input | Description | Required | Default |
+| ----- | ----------- | -------- | ------- |
+| task | The task to run (monitor-issues or monitor-prs). | Yes | None |
+| git_secret | GitHub token for authentication. | Yes | None |
+| repo_owner | The owner of the GitHub repository (`facebook`). | Yes | None |
+| repo_name | The name of the GitHub repository (`react-native`). | Yes | None |
+| fetch_data_interval | The time interval to fetch data for (e.g., 1 hour, 24 hours). This should align with the cron schedule. | Yes | None |
+| notifier | Notification method (**slack** or **discord**). | Yes | None |
+| slack_bot_token | Slack bot token to send notifications (required if notifier=`slack`). | No | None |
+| slack_channel | The Slack channel id to send notifications to (required if notifier=`slack`). | No | None |
+| 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 |
+
+## 📖 How It Works
 - The action listens for new issues or PRs in the specified GitHub repository.
 - Depending on the `task` input, it will either monitor new issues (`monitor-issues`) or pull requests (`monitor-prs`).
 - Once a new issue or PR is detected, it sends a notification via Slack or Discord based on the `notifier` input.
 - The action checks for issues or PRs within the time period defined by `fetch_data_interval`, which should align with the cron schedule. For example, if the cron schedule is set to run every hour `(0 * * * *)`, set `fetch_data_interval` to 1 hour.
 
-## Setting up Slack
-If you choose Slack as the notification method, you will need to create a Slack app and retrieve the **Slack Bot Token** and **Channel**:
+## 🔧 Setting Up
+
+### Slack
+
+- Create a Slack App.
+- Generate a Slack Bot Token.
+- 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`
 
-- Create a Slack app.
-- Generate a **Slack Bot Token**.
-- Get the **Channel I**D.
-- Get the **Slack User ID** or **Group ID**.
-- Add these tokens/IDs to the GitHub secrets (`SLACK_BOT_TOKEN`, `SLACK_CHANNEL`, `SLACK_ID_TYPE`, and `SLACK_ID`).
+### Discord
 
-`slack_id_type` Explanation
-- `user`: Use this if you want to send a notification to an individual user.
-- `group`: Use this if you want to send a notification to a group of users (e.g., a Slack channel or a group).
+- Create a Discord Webhook.
+- Copy the Webhook URL.
+- Add the Webhook URL to your GitHub repository secrets as `DISCORD_WEBHOOK_URL`.
 
-## Setting up Discord
-If you choose Discord as the notification method, you will need a Discord Webhook URL:
+## 🔮 Roadmap
 
-- Create a **Discord Webhook**.
-- Copy the Webhook URL and add it to the GitHub secrets (`DISCORD_WEBHOOK_URL`).
+- [ ] **Generalize Notification Channels**: Allow adding multiple notification methods (e.g.  Webhooks).
+- [ ] **Support Custom Filters**: Enable users to apply filters like labels, authors, or milestones to issues and PRs.
+- [ ] **Handle API Rate Limiting**: Add rate limiting or retry logic for handling GitHub API rate limits.
+- [ ] **Track inactivity** on issues and notify users after a specific TAT (Turnaround Time).
 
-## Roadmap
-- [ ] Generalize Notification Channels: Allow adding multiple notification methods (e.g.  Webhooks).
-- [ ] Support Custom Filters: Enable users to apply filters like labels, authors, or milestones to issues and PRs.
-- [ ] Handle API Rate Limiting: Add rate limiting or retry logic for handling GitHub API rate limits.
+## 📜 License
 
+This project is licensed under the [MIT License](https://github.com/shubhaamgupta11/repo-monitor/blob/main/LICENSE).
diff --git a/action.yml b/action.yml
@@ -2,8 +2,8 @@ name: Repo Monitor
 description: A GitHub Action to monitor new issues and pull requests and send notifications to Slack.
 author: Shubham Gupta <shubhaamgupta11@gmail.com>
 branding:
-  icon: zap
-  color: blue
+  icon: bell
+  color: green
 
 inputs:
   task:
diff --git a/action/monitor-new-issue.js b/action/monitor-new-issue.js
@@ -13,7 +13,7 @@ const sendDiscordNotification = require("./integrations/discord");
  */
 const fetchNewIssues = async (gitToken, owner, repo, alertTime) => {
   const apiUrl = `https://api.github.com/repos/${owner}/${repo}/issues`;
-
+  console.log("🔍  Fetching new issues... ", apiUrl);
   const sinceDate = new Date(
     new Date().getTime() - alertTime * 60 * 60 * 1000
   ).toISOString();
@@ -76,6 +76,11 @@ async function monitorIssues({
 }) {
   const issues = await fetchNewIssues(gitToken, owner, repo, alertTime);
 
+  if (issues.length === 0) {
+    console.log("No new issues found.");
+    return;
+  }
+
   if (notifier === "slack") {
     const {
       slackToken,
@@ -84,7 +89,7 @@ async function monitorIssues({
       slackID,
     } = slackConfig;
     console.log(
-      "Sending notifications to Slack for issues:",
+      "🔔 Sending notifications to Slack for issues:",
       issues.map((issue) => issue.title)
     );
     await sendSlackNotification(
@@ -100,7 +105,7 @@ async function monitorIssues({
       discordWebhookUrl,
     } = discordConfig;
     console.log(
-      "Sending notifications to Discord for issues:",
+      "🔔 Sending notifications to Discord for issues:",
       issues.map((issue) => issue.title)
     );
     await sendDiscordNotification(discordWebhookUrl, issues, repo);
diff --git a/action/monitor-new-pr.js b/action/monitor-new-pr.js
@@ -13,17 +13,14 @@ const sendDiscordNotification = require("./integrations/discord");
  */
 const fetchNewPRs = async (gitToken, owner, repo, alertTime) => {
   const apiUrl = `https://api.github.com/repos/${owner}/${repo}/pulls`;
+  console.log("🔍  Fetching new PRs... ", apiUrl);
   const cutoffDate = new Date(
     Date.now() - alertTime * 60 * 60 * 1000
   ).toISOString();
 
   let newPRs = [];
   let page = 1;
 
-  console.log(
-    `Fetching new PRs created in the last ${alertTime} days from ${apiUrl}`
-  );
-
   try {
     while (true) {
       console.log(`Fetching page ${page}...`);
@@ -81,10 +78,11 @@ async function monitorPRs({
   console.log("Starting PR monitor...");
 
   const prs = await fetchNewPRs(gitToken, owner, repo, alertTime);
-  console.log(
-    `Found ${prs.length} new PRs:`,
-    prs.map((pr) => pr.title)
-  );
+
+  if (prs.length === 0) {
+    console.log("No new PRs found.");
+    return;
+  }
 
   if (notifier === "slack") {
     const {
@@ -94,7 +92,7 @@ async function monitorPRs({
       slackID,
     } = slackConfig;
     console.log(
-      "Sending notifications to Slack for PRs:",
+      "🔔 Sending notifications to Slack for PRs:",
       prs.map((pr) => pr.title)
     );
     await sendSlackNotification(
@@ -110,7 +108,7 @@ async function monitorPRs({
       discordWebhookUrl,
     } = discordConfig;
     console.log(
-      "Sending notifications to Discord for PRs:",
+      "🔔 Sending notifications to Discord for PRs:",
       prs.map((pr) => pr.title)
     );
     await sendDiscordNotification(discordWebhookUrl, prs, repo);
diff --git a/dist/index.js b/dist/index.js
@@ -146,7 +146,7 @@ const sendDiscordNotification = __nccwpck_require__(9220);
  */
 const fetchNewIssues = async (gitToken, owner, repo, alertTime) => {
   const apiUrl = `https://api.github.com/repos/${owner}/${repo}/issues`;
-
+  console.log("🔍  Fetching new issues... ", apiUrl);
   const sinceDate = new Date(
     new Date().getTime() - alertTime * 60 * 60 * 1000
   ).toISOString();
@@ -209,6 +209,11 @@ async function monitorIssues({
 }) {
   const issues = await fetchNewIssues(gitToken, owner, repo, alertTime);
 
+  if (issues.length === 0) {
+    console.log("No new issues found.");
+    return;
+  }
+
   if (notifier === "slack") {
     const {
       slackToken,
@@ -217,7 +222,7 @@ async function monitorIssues({
       slackID,
     } = slackConfig;
     console.log(
-      "Sending notifications to Slack for issues:",
+      "🔔 Sending notifications to Slack for issues:",
       issues.map((issue) => issue.title)
     );
     await sendSlackNotification(
@@ -233,7 +238,7 @@ async function monitorIssues({
       discordWebhookUrl,
     } = discordConfig;
     console.log(
-      "Sending notifications to Discord for issues:",
+      "🔔 Sending notifications to Discord for issues:",
       issues.map((issue) => issue.title)
     );
     await sendDiscordNotification(discordWebhookUrl, issues, repo);
@@ -264,17 +269,14 @@ const sendDiscordNotification = __nccwpck_require__(9220);
  */
 const fetchNewPRs = async (gitToken, owner, repo, alertTime) => {
   const apiUrl = `https://api.github.com/repos/${owner}/${repo}/pulls`;
+  console.log("🔍  Fetching new PRs... ", apiUrl);
   const cutoffDate = new Date(
     Date.now() - alertTime * 60 * 60 * 1000
   ).toISOString();
 
   let newPRs = [];
   let page = 1;
 
-  console.log(
-    `Fetching new PRs created in the last ${alertTime} days from ${apiUrl}`
-  );
-
   try {
     while (true) {
       console.log(`Fetching page ${page}...`);
@@ -332,10 +334,11 @@ async function monitorPRs({
   console.log("Starting PR monitor...");
 
   const prs = await fetchNewPRs(gitToken, owner, repo, alertTime);
-  console.log(
-    `Found ${prs.length} new PRs:`,
-    prs.map((pr) => pr.title)
-  );
+
+  if (prs.length === 0) {
+    console.log("No new PRs found.");
+    return;
+  }
 
   if (notifier === "slack") {
     const {
@@ -345,7 +348,7 @@ async function monitorPRs({
       slackID,
     } = slackConfig;
     console.log(
-      "Sending notifications to Slack for PRs:",
+      "🔔 Sending notifications to Slack for PRs:",
       prs.map((pr) => pr.title)
     );
     await sendSlackNotification(
@@ -361,7 +364,7 @@ async function monitorPRs({
       discordWebhookUrl,
     } = discordConfig;
     console.log(
-      "Sending notifications to Discord for PRs:",
+      "🔔 Sending notifications to Discord for PRs:",
       prs.map((pr) => pr.title)
     );
     await sendDiscordNotification(discordWebhookUrl, prs, repo);
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
