feat: filtering of event types (#131)

---------

Signed-off-by: Jan Larwig <jan@larwig.com>
Co-authored-by: Jan Larwig <jan@larwig.com>

Author: DogeTheBeast

README.md

@@ -58,6 +58,7 @@ Use the following `input params` to customize it for your use case:-
 | `EMPTY_COMMIT_MSG` | :memo: empty commit to keep workflow active after 60 days of no activity | Commit message used when there are no updates             |
 | `MAX_LINES`        | 5                                                                        | The maximum number of lines populated in your readme file |
 | `TARGET_FILE`      | README.md                                                                | The file to insert recent activity into                   |
+| `FILTER_EVENTS`    | IssueCommentEvent,IssuesEvent,PullRequestEvent,ReleaseEvent              | Display specific event type                               |
 
 ```yml
 name: Update README

action.yml

@@ -31,6 +31,11 @@ inputs:
     description: "Commit message used when there are no updates"
     default: ":memo: empty commit to keep workflow active after 60 days of no activity"
     required: false
+  FILTER_EVENTS:
+    description: "Events that should be displayed on profile"
+    default: "IssueCommentEvent,IssuesEvent,PullRequestEvent,ReleaseEvent"
+    required: false
+
 branding:
   color: yellow
   icon: activity

dist/index.js

@@ -19869,6 +19869,7 @@ const COMMIT_MSG = core.getInput("COMMIT_MSG");
 const MAX_LINES = core.getInput("MAX_LINES");
 const TARGET_FILE = core.getInput("TARGET_FILE");
 const EMPTY_COMMIT_MSG = core.getInput("EMPTY_COMMIT_MSG");
+const FILTER_EVENTS = core.getInput("FILTER_EVENTS");
 
 /**
  * Returns the sentence case representation
@@ -20059,7 +20060,11 @@ Toolkit.run(
 
     const content = events.data
       // Filter out any boring activity
-      .filter((event) => serializers.hasOwnProperty(event.type))
+      .filter(
+        (event) =>
+          serializers.hasOwnProperty(event.type) &&
+          FILTER_EVENTS.includes(event.type),
+      )
       // We only have five lines to work with
       .slice(0, MAX_LINES)
       // Call the serializer to construct a string

index.js

@@ -11,6 +11,7 @@ const COMMIT_MSG = core.getInput("COMMIT_MSG");
 const MAX_LINES = core.getInput("MAX_LINES");
 const TARGET_FILE = core.getInput("TARGET_FILE");
 const EMPTY_COMMIT_MSG = core.getInput("EMPTY_COMMIT_MSG");
+const FILTER_EVENTS = core.getInput("FILTER_EVENTS");
 
 /**
  * Returns the sentence case representation
@@ -201,7 +202,11 @@ Toolkit.run(
 
     const content = events.data
       // Filter out any boring activity
-      .filter((event) => serializers.hasOwnProperty(event.type))
+      .filter(
+        (event) =>
+          serializers.hasOwnProperty(event.type) &&
+          FILTER_EVENTS.includes(event.type),
+      )
       // We only have five lines to work with
       .slice(0, MAX_LINES)
       // Call the serializer to construct a string

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "github-activity-readme",
-  "version": "0.4.6",
+  "version": "0.5.0",
   "description": "Updates README with the recent GitHub activity of a user",
   "main": "index.js",
   "keywords": [],