feat: configurable promotion comment

.github/ubiquibot-config.yml

@@ -31,3 +31,4 @@ priority-labels:
 auto-pay-mode: true
 analytics-mode: true
 max-concurrent-bounties: 2
+promotion-comment: `\n<h6>If you enjoy the DevPool experience, please follow <a href="https://github.com/ubiquity">Ubiquity on GitHub</a> and star <a href="https://github.com/ubiquity/devpool-directory">this repo</a> to show your support. It helps a lot!</h6>`

src/bindings/config.ts

@@ -20,6 +20,7 @@ export const loadConfig = async (context: Context): Promise<BotConfig> => {
     incentiveMode,
     chainId,
     issueCreatorMultiplier,
+    promotionComment,
   } = await getWideConfig(context);
 
   const publicKey = await getScalarKey(process.env.X25519_PRIVATE_KEY);
@@ -37,6 +38,9 @@ export const loadConfig = async (context: Context): Promise<BotConfig> => {
       priorityLabels,
       commentElementPricing,
     },
+    comments: {
+      promotionComment: promotionComment,
+    },
     payout: {
       chainId: chainId,
       rpc: rpc,

src/configs/strings.ts

@@ -1,5 +1,4 @@
 export const GLOBAL_STRINGS = {
   unassignComment: "Releasing the bounty back to dev pool because the allocated duration already ended!",
   askUpdate: "Do you have any updates",
-  promotionComment: `\n<h6>If you enjoy the DevPool experience, please follow <a href="https://github.com/ubiquity">Ubiquity on GitHub</a> and star <a href="https://github.com/ubiquity/devpool-directory">this repo</a> to show your support. It helps a lot!</h6>`,
 };

src/handlers/comment/handlers/index.ts

@@ -12,7 +12,6 @@ import { multiplier } from "./multiplier";
 import { addCommentToIssue, createLabel, addLabelToIssue } from "../../../helpers";
 import { getBotContext } from "../../../bindings";
 import { handleIssueClosed } from "../../payout";
-import { GLOBAL_STRINGS } from "../../../configs";
 
 export * from "./assign";
 export * from "./wallet";
@@ -42,11 +41,12 @@ export const commentParser = (body: string): IssueCommentCommands[] => {
 
 export const issueClosedCallback = async (): Promise<void> => {
   const { payload: _payload } = getBotContext();
+  const { comments } = getBotConfig();
   const issue = (_payload as Payload).issue;
   if (!issue) return;
   try {
     const comment = await handleIssueClosed();
-    if (comment) await addCommentToIssue(comment + GLOBAL_STRINGS.promotionComment, issue.number);
+    if (comment) await addCommentToIssue(comment + comments.promotionComment, issue.number);
   } catch (err: unknown) {
     return await addCommentToIssue(`Error: ${err}`, issue.number);
   }

src/types/config.ts

@@ -62,6 +62,10 @@ export const SodiumSchema = Type.Object({
   privateKey: Type.String(),
 });
 
+export const CommentsSchema = Type.Object({
+  promotionComment: Type.String(),
+});
+
 export const BotConfigSchema = Type.Object({
   log: LogConfigSchema,
   price: PriceConfigSchema,
@@ -72,6 +76,7 @@ export const BotConfigSchema = Type.Object({
   mode: ModeSchema,
   assign: AssignSchema,
   sodium: SodiumSchema,
+  comments: CommentsSchema,
 });
 
 export type BotConfig = Static<typeof BotConfigSchema>;

src/utils/helpers.ts

@@ -82,6 +82,16 @@ export const getAnalyticsMode = (parsedRepo: WideRepoConfig | undefined, parsedO
   }
 };
 
+export const getPromotionComment = (parsedRepo: WideRepoConfig | undefined, parsedOrg: WideOrgConfig | undefined): string => {
+  if (parsedRepo && parsedRepo["promotion-comment"] && typeof parsedRepo["promotion-comment"] === "string") {
+    return parsedRepo["promotion-comment"];
+  } else if (parsedOrg && parsedOrg["promotion-comment"] && typeof parsedOrg["promotion-comment"] === "string") {
+    return parsedOrg["promotion-comment"];
+  } else {
+    return "";
+  }
+};
+
 export const getIncentiveMode = (parsedRepo?: WideRepoConfig, parsedOrg?: WideOrgConfig): boolean => {
   if (parsedRepo && parsedRepo["incentive-mode"] && typeof parsedRepo["incentive-mode"] === "boolean") {
     return parsedRepo["incentive-mode"];

src/utils/private.ts

@@ -13,6 +13,7 @@ import {
   getPriorityLabels,
   getTimeLabels,
   getCommentItemPrice,
+  getPromotionComment,
 } from "./helpers";
 
 const CONFIG_REPO = "ubiquibot-config";
@@ -53,6 +54,7 @@ export interface WideConfig {
   "time-labels"?: WideLabel[];
   "priority-labels"?: WideLabel[];
   "auto-pay-mode"?: boolean;
+  "promotion-comment"?: string;
   "analytics-mode"?: boolean;
   "incentive-mode"?: boolean;
   "max-concurrent-bounties"?: number;
@@ -137,6 +139,7 @@ export const getWideConfig = async (context: Context) => {
     bountyHunterMax: getBountyHunterMax(parsedRepo, parsedOrg),
     incentiveMode: getIncentiveMode(parsedRepo, parsedOrg),
     commentElementPricing: getCommentItemPrice(parsedRepo, parsedOrg),
+    promotionComment: getPromotionComment(parsedRepo, parsedOrg),
   };
 
   return configData;