feat: no comment if badgeDescription not set

.github/workflows/tester.yml

@@ -27,5 +27,4 @@ jobs:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           badges: '[1 :trophy:,top 3 :fire:,top 5 :sunglasses:]'
           thresholds: '[1,2,3]'
-          badge-descriptions: '[You''re top 2 and you''re not number 2!,You are on the podium!,You have broken into the top 5!]'
           badge-type: 'leaderboard'

.projenrc.js

@@ -16,7 +16,7 @@ const project = new GitHubActionTypeScriptProject({
       },
       'badge-descriptions': {
         description: 'badge descriptions corresponding 1-1 with badges',
-        required: true,
+        required: false,
       },
       'thresholds': {
         description: 'thresholds corresponding 1-1 with badges',

src/badger.ts

@@ -7,14 +7,14 @@ export interface BadgerProps {
   readonly days?: number;
   readonly token: string;
   readonly badges: string[];
-  readonly badgeDescriptions: string[];
+  readonly badgeDescriptions?: string[];
   readonly thresholds: number[];
   readonly ignoreUsernames: string[];
 }
 
 interface BadgeInfo {
   readonly name: string;
-  readonly description: string;
+  readonly description?: string;
   readonly threshold: number;
 }
 
@@ -24,6 +24,7 @@ export abstract class Badger {
   private pullRequestNumber: number;
   private timestampDate?: Date;
   private ignoreUsernames?: string[];
+  private doWriteComment: boolean;
   public badges: BadgeInfo[] = [];
 
   constructor(props: BadgerProps) {
@@ -39,11 +40,12 @@ export abstract class Badger {
 
     this.timestampDate = props.days ? daysToDate(props.days) : undefined;
     this.ignoreUsernames = props.ignoreUsernames;
+    this.doWriteComment = props.badgeDescriptions ? true : false;
 
     for (let i = 0; i < props.badges.length; i++) {
       this.badges.push({
         name: props.badges[i],
-        description: props.badgeDescriptions[i],
+        description: props.badgeDescriptions ? props.badgeDescriptions[i] : undefined,
         threshold: props.thresholds[i],
       });
     }
@@ -131,6 +133,8 @@ export abstract class Badger {
   }
 
   protected async writeComment(badgeIndex: number, username: string, additionalInfo?: string) {
+    if (!this.doWriteComment) { return; }
+
     const badge = this.badges[badgeIndex];
     const comment = [
       `${BADGER_METADATA}\n`,

src/index.ts

@@ -20,7 +20,7 @@ async function run() {
     return;
   }
 
-  if (badgeDescriptions.length !== badges.length || badges.length !== thresholds.length) {
+  if (badges.length !== thresholds.length || (badgeDescriptions.length > 0 && badgeDescriptions.length !== badges.length)) {
     core.setFailed('badge, badgeDescriptions, and thresholds must be lists with the same number of elements');
     return;
   }
@@ -31,7 +31,7 @@ async function run() {
       token,
       badges,
       thresholds,
-      badgeDescriptions,
+      badgeDescriptions: badgeDescriptions.length === 0 ? undefined : badgeDescriptions,
       ignoreUsernames,
       days,
     });
@@ -40,7 +40,7 @@ async function run() {
       token,
       badges,
       thresholds,
-      badgeDescriptions,
+      badgeDescriptions: badgeDescriptions.length === 0 ? undefined : badgeDescriptions,
       ignoreUsernames,
       days,
     });