Merge pull request #9 from aws-github-ops/defaultAreaFeat

feat: user can set default labels and assignees to apply when no keywords are detected

Author: peterwoodworth

README.md

@@ -32,7 +32,16 @@ Parameters should take the form
 ]
 ```
 
-### excluded expressions
+### default-area
+If no keywords are detected in your issue, set these default labels and assignees
+```
+{
+  "labels": ["labels"],
+  "assignees": ["assignees"]
+}
+```
+
+### excluded-expressions
 
 You can exclude certain expressions from being potentially counted as keywords. This is useful if you have issue templates which may contain keywords.
 The input should be an array with expressions to exclude separated by bars. Ex. `[ Expression 1 | Expression 2 ]`

action.yml

@@ -7,6 +7,9 @@ inputs:
   parameters:
     description: "JSON array of keywords to look for and labels and assignees to be set when there's a keyword match"
     required: true
+  default-area:
+    description: "Labels and assignees to apply when no keywords are detected"
+    required: false
   excluded-expressions:
     description: "Words to exclude from search"
     required: true

lib/index.js

@@ -28076,6 +28076,12 @@ function run() {
         const winningAreaData = issue.getWinningAreaData(issue.determineArea());
         if (winningAreaData.area === '') {
             console.log("Keywords not included in this issue");
+            if (issue.defaultArea) {
+                if (issue.defaultArea.assignees)
+                    github.setIssueAssignees(issue.defaultArea.assignees);
+                if (issue.defaultArea.labels)
+                    github.setIssueLabels(issue.defaultArea.labels);
+            }
         }
         else {
             if (winningAreaData.assignees)
@@ -28143,6 +28149,7 @@ class Issue {
             this.bodyIssueWords = body.split(/ |\(|\)|\./);
         }
         this.parameters = JSON.parse(core.getInput("parameters", { required: true }));
+        this.defaultArea = JSON.parse(core.getInput("default-area", { required: false }));
         this.similarity = +core.getInput("similarity", { required: false });
         this.bodyValue = +core.getInput("body-value", { required: false });
     }
@@ -28167,31 +28174,11 @@ class Issue {
                 potentialAreas = this.scoreArea(content, potentialAreas, this.bodyValue);
             });
         }
-        console.log("Area scores: ", ...potentialAreas);
-        let winningArea = '';
-        let winners = new Map();
-        for (let area of potentialAreas.entries()) {
-            if (winners.size === 0) {
-                winners.set(area[0], area[1]);
-            }
-            else if (area[1] > winners.values().next().value) {
-                winners = new Map();
-                winners.set(area[0], area[1]);
-            }
-            else if (area[1] === winners.values().next().value) {
-                winners.set(area[0], area[1]);
-            }
-        }
-        // tiebreaker goes to the area with more *exact* keyword matches
-        if (winners.size > 1 && this.similarity !== 0) {
-            this.similarity = 0;
-            winningArea = this.determineArea();
-        }
-        else if (winners.size > 0) {
-            winningArea = winners.keys().next().value;
-        }
-        winningArea = winners.keys().next().value;
-        console.log("Winning area: " + winningArea);
+        if (potentialAreas.size > 0)
+            console.log("Area scores: ", ...potentialAreas);
+        const winningArea = this.decideWinner(potentialAreas);
+        if (winningArea)
+            console.log("Winning area: " + winningArea);
         return winningArea;
     }
     getWinningAreaData(winningArea) {
@@ -28220,6 +28207,31 @@ class Issue {
         });
         return potentialAreas;
     }
+    decideWinner(potentialAreas) {
+        let winningArea = '';
+        let winners = new Map();
+        for (let area of potentialAreas.entries()) {
+            if (winners.size === 0) {
+                winners.set(area[0], area[1]);
+            }
+            else if (area[1] > winners.values().next().value) {
+                winners = new Map();
+                winners.set(area[0], area[1]);
+            }
+            else if (area[1] === winners.values().next().value) {
+                winners.set(area[0], area[1]);
+            }
+        }
+        // tiebreaker goes to the area with more *exact* keyword matches
+        if (winners.size > 1 && this.similarity !== 0) {
+            this.similarity = 0;
+            winningArea = this.determineArea();
+        }
+        else if (winners.size > 0) {
+            winningArea = winners.keys().next().value;
+        }
+        return winningArea;
+    }
     isSimilar(str1, str2) {
         return (((str1.length + str2.length) / 2) * this.similarity);
     }

src/index.ts

@@ -14,6 +14,10 @@ async function run() {
 
   if (winningAreaData.area === '') { 
     console.log("Keywords not included in this issue");
+    if(issue.defaultArea) {
+      if(issue.defaultArea.assignees) github.setIssueAssignees(issue.defaultArea.assignees);
+      if(issue.defaultArea.labels) github.setIssueLabels(issue.defaultArea.labels);   
+    }
   } else {
     if(winningAreaData.assignees) github.setIssueAssignees(winningAreaData.assignees);
     if(winningAreaData.labels) github.setIssueLabels(winningAreaData.labels);

src/issue.ts

@@ -15,6 +15,7 @@ export class Issue {
   private titleIssueWords?: string[];
   private bodyIssueWords?: string[];
   public parameters: IParameter[];
+  public defaultArea?: IDefaultArea;
   private similarity: number;
   private bodyValue: number;
 
@@ -35,6 +36,7 @@ export class Issue {
       this.bodyIssueWords = body.split(/ |\(|\)|\./);
     }
     this.parameters = JSON.parse(core.getInput("parameters", {required: true}));
+    this.defaultArea = JSON.parse(core.getInput("default-area", {required: false}));
     this.similarity = +core.getInput("similarity", {required: false});
     this.bodyValue = +core.getInput("body-value", {required: false});
   }
@@ -62,33 +64,12 @@ export class Issue {
       this.bodyIssueWords.forEach(content => {
         potentialAreas = this.scoreArea(content, potentialAreas, this.bodyValue);
       });
-    }
-      
-    console.log("Area scores: ", ...potentialAreas);
+    }    
 
-    let winningArea = '';
-    let winners: Map<string,number> = new Map();
-    for (let area of potentialAreas.entries()) {
-      if(winners.size === 0) {
-        winners.set(area[0], area[1]);
-      } else if (area[1] > winners.values().next().value) {
-        winners = new Map();
-        winners.set(area[0], area[1]);
-      } else if (area[1] === winners.values().next().value) {
-        winners.set(area[0], area[1]);
-      }
-    }
-    // tiebreaker goes to the area with more *exact* keyword matches
-    if(winners.size > 1 && this.similarity !== 0) {
-      this.similarity = 0;
-      winningArea = this.determineArea();
-    } else if (winners.size > 0) {
-      winningArea = winners.keys().next().value;
-    } 
-      
-    winningArea = winners.keys().next().value;
+    if(potentialAreas.size > 0) console.log("Area scores: ", ...potentialAreas);
 
-    console.log("Winning area: " + winningArea);
+    const winningArea = this.decideWinner(potentialAreas);
+    if(winningArea) console.log("Winning area: " + winningArea);
 
     return winningArea;
   }
@@ -123,6 +104,29 @@ export class Issue {
     return potentialAreas;
   }
 
+  private decideWinner(potentialAreas: Map<string, number>): string {
+    let winningArea = '';
+    let winners: Map<string,number> = new Map();
+    for (let area of potentialAreas.entries()) {
+      if(winners.size === 0) {
+        winners.set(area[0], area[1]);
+      } else if (area[1] > winners.values().next().value) {
+        winners = new Map();
+        winners.set(area[0], area[1]);
+      } else if (area[1] === winners.values().next().value) {
+        winners.set(area[0], area[1]);
+      }
+    }
+    // tiebreaker goes to the area with more *exact* keyword matches
+    if(winners.size > 1 && this.similarity !== 0) {
+      this.similarity = 0;
+      winningArea = this.determineArea();
+    } else if (winners.size > 0) {
+      winningArea = winners.keys().next().value;
+    } 
+    return winningArea;
+  }
+
   private isSimilar(str1: string, str2: string): number {
     return (((str1.length + str2.length) / 2) * this.similarity);
   }