feat: readme update (shubhaamgupta11#3)

* feat: refactored new issue logic

* feat: refactored new pr  logic

* slack and discord added

* feat: updated entry point

* updated readme

Author: shubhaamgupta11

.github/workflows/example.yml

@@ -6,19 +6,21 @@ on:
   workflow_dispatch:
 
 jobs:
-  monitor:
+  run-notifier:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-      - name: Run GitHub Monitor Action
-        uses: ./
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
         with:
-          task: "monitor-issues" # or monitor-prs
-          git_token: ${{ secrets.GITHUB_TOKEN }}
-          slack_bot_token: ${{ secrets.SLACK_BOT_TOKEN }}
-          slack_channel: ${{ secrets.SLACK_CHANNEL }}
+          node-version: '16'
+      - name: Run action
+        uses: ./ # path to your action
+        with:
+          task: "monitor-issues"
+          git_token: "${{ secrets.GITHUB_TOKEN }}"
+          notifier: "discord"  # or "slack"
+          fetch_data_interval: 24  # You can set this in hours
+          discord_webhook_url: "your_discord_webhook_url"
           repo_owner: "facebook"
           repo_name: "react-native"
-          slack_id_type: "user"
-          slack_id: "U01N6V7HKUJ"
+

README.md

@@ -1,6 +1,85 @@
-# GitHub Monitor Action
+# Monitor Issues and PRs GitHub Action
 
-Monitor GitHub issues and PRs, and post updates to Slack.
+## 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.
+
+## Features
+
+- Monitor issues and PRs in a GitHub repository.
+- Support for multiple notification methods.
+- Easy integration with GitHub workflows.
+
+## 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 |
+
+## Example Usage
+
+```yml
+name: Monitor GitHub Repo
+
+on:
+  schedule:
+    - cron: "0 * * * *" # Runs every hour
+  workflow_dispatch:
+
+jobs:
+  run-notifier:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+      - name: Run action
+        uses: ./ # Path to your action
+        with:
+          task: "monitor-issues"
+          git_secret: "${{ secrets.GITHUB_TOKEN }}"
+          notifier: "slack"  # Or "discord"
+          fetch_data_interval: 24  # 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"
+```
+
+## 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**:
+
+- 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`).
+
+`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).
+
+## Setting up Discord
+If you choose Discord as the notification method, you will need a Discord Webhook URL:
+
+- Create a **Discord Webhook**.
+- Copy the Webhook URL and add it to the GitHub secrets (`DISCORD_WEBHOOK_URL`).
 
 ## Inputs
 

action/action.yml

@@ -6,27 +6,42 @@ branding:
   color: blue
 
 inputs:
+  task:
+    description: Task to run (monitor-issues or monitor-prs).
+    required: true
   git_secret:
     description: GitHub token for authentication.
     required: true
-  slack_bot_token:
-    description: Slack bot token to send notifications.
-    required: true
-  slack_channel:
-    description: The Slack channel to send notifications to.
-    required: true
   repo_owner:
     description: Owner of the repository.
     required: true
   repo_name:
     description: Name of the repository.
     required: true
-  slack_id_type:
-    description: Type of Slack ID (user or channel).
+  fetch_data_interval:
+    description: How far back to fetch data (e.g., 1 hour, 24 hours).
     required: true
-  slack_id:
-    description: Slack ID of the recipient (user or channel).
+  notifier:
+    description: Notification method (slack or discord).
     required: true
+  # Slack-specific inputs
+  slack_bot_token:
+    description: Slack bot token to send notifications.
+    required: false
+  slack_channel:
+    description: The Slack channel to send notifications to.
+    required: false
+  slack_id_type:
+    description: Type of Slack ID (user or group).
+    required: false
+  slack_id:
+    description: Slack ID of the recipient (user or group).
+    required: false
+  # Discord-specific inputs
+  discord_webhook_url:
+    description: Discord webhook URL to send notifications.
+    required: false
+
 
 runs:
   using: node16

action/index.js

@@ -6,8 +6,9 @@ const core = require("@actions/core");
 async function run() {
   try {
     const task = core.getInput("task");
-    const gitToken = core.getInput("git_token");
+    const gitToken = core.getInput("git_secret");
     const notifier = core.getInput("notifier"); // 'slack' or 'discord'
+    const alertTime = core.getInput("fetch_data_interval"); // in hours
 
     const owner = core.getInput("repo_owner");
     const repo = core.getInput("repo_name");
@@ -30,6 +31,7 @@ async function run() {
           notifier,
           slackConfig: { slackToken, slackChannel, slackIDType, slackID },
           discordConfig: { discordWebhookUrl },
+          alertTime,
         });
         break;
 
@@ -41,6 +43,7 @@ async function run() {
           notifier,
           slackConfig: { slackToken, slackChannel, slackIDType, slackID },
           discordConfig: { discordWebhookUrl },
+          alertTime,
         });
         break;
 
@@ -52,4 +55,4 @@ async function run() {
   }
 }
 
-run();
+run();

action/monitor-new-issue.js

@@ -8,13 +8,14 @@ const sendDiscordNotification = require("./integrations/discord");
  * @param {string} gitToken - GitHub API token for authentication.
  * @param {string} owner - Repository owner.
  * @param {string} repo - Repository name.
- * @param {number} hoursAgo - Timeframe in hours to fetch issues created since then.
+ * @param {number} alertTime - Timeframe in hours to fetch issues created since then.
  * @returns {Promise<Array>} - List of new issues created within the specified timeframe.
  */
-const fetchNewIssues = async (gitToken, owner, repo, hoursAgo) => {
+const fetchNewIssues = async (gitToken, owner, repo, alertTime) => {
   const apiUrl = `https://api.github.com/repos/${owner}/${repo}/issues`;
+
   const sinceDate = new Date(
-    new Date().getTime() - hoursAgo * 60 * 60 * 1000
+    new Date().getTime() - alertTime * 60 * 60 * 1000
   ).toISOString();
 
   let newIssues = [];
@@ -71,10 +72,9 @@ async function monitorIssues({
   notifier,
   slackConfig,
   discordConfig,
+  alertTime,
 }) {
-  const hoursAgo = 24;
-
-  const issues = await fetchNewIssues(gitToken, owner, repo, hoursAgo);
+  const issues = await fetchNewIssues(gitToken, owner, repo, alertTime);
 
   if (notifier === "slack") {
     const {

action/monitor-new-pr.js

@@ -3,25 +3,25 @@ const sendSlackNotification = require("./integrations/slack");
 const sendDiscordNotification = require("./integrations/discord");
 
 /**
- * Fetch new pull requests created within the last `daysAgo` days.
+ * Fetch new pull requests created within the last `alertTime` days.
  *
  * @param {string} gitToken - GitHub API token for authentication.
  * @param {string} owner - Repository owner.
  * @param {string} repo - Repository name.
- * @param {number} daysAgo - Timeframe in days to fetch PRs created since then. Default: 1 day.
+ * @param {number} alertTime - Timeframe in days to fetch PRs created since then. Default: 1 day.
  * @returns {Promise<Array>} - List of new pull requests created within the specified timeframe.
  */
-const fetchNewPRs = async (gitToken, owner, repo, daysAgo = 1) => {
+const fetchNewPRs = async (gitToken, owner, repo, alertTime) => {
   const apiUrl = `https://api.github.com/repos/${owner}/${repo}/pulls`;
   const cutoffDate = new Date(
-    Date.now() - daysAgo * 24 * 60 * 60 * 1000
+    Date.now() - alertTime * 60 * 60 * 1000
   ).toISOString();
 
   let newPRs = [];
   let page = 1;
 
   console.log(
-    `Fetching new PRs created in the last ${daysAgo} days from ${apiUrl}`
+    `Fetching new PRs created in the last ${alertTime} days from ${apiUrl}`
   );
 
   try {
@@ -76,11 +76,11 @@ async function monitorPRs({
   notifier,
   slackConfig,
   discordConfig,
-  daysAgo = 1,
+  alertTime,
 }) {
   console.log("Starting PR monitor...");
 
-  const prs = await fetchNewPRs(gitToken, owner, repo, daysAgo);
+  const prs = await fetchNewPRs(gitToken, owner, repo, alertTime);
   console.log(
     `Found ${prs.length} new PRs:`,
     prs.map((pr) => pr.title)