Add tips for tracker approval 💡

src/action.ts

@@ -12,6 +12,7 @@ import { PullRequestMetadata } from './schema/input';
 import {
   getFailedMessage,
   getSuccessMessage,
+  getTipMessage,
   raise,
   removeLabel,
   setLabels,
@@ -57,6 +58,7 @@ async function action(
 
   let message: string[] = [];
   let err: string[] = [];
+  let tip: string[] = [];
   let labels: { add: string[]; remove: string[] } = { add: [], remove: [] };
 
   const labelsFromPR = z
@@ -160,6 +162,7 @@ async function action(
     err.push(
       `🔴 Tracker ${trackerController.adapter.getMarkdownUrl()} has not been approved`
     );
+    tip.push(`🔵 ${trackerController.adapter.tips.approval}`);
   } else {
     if (labelsFromPR.includes(config.labels.unapproved)) {
       removeLabel(octokit, prMetadata.number, config.labels.unapproved);
@@ -185,7 +188,13 @@ async function action(
   setLabels(octokit, prMetadata.number, labels.add);
 
   if (err.length > 0) {
-    raise(getFailedMessage(err) + '\n\n' + getSuccessMessage(message));
+    raise(
+      getFailedMessage(err) +
+        '\n\n' +
+        getSuccessMessage(message) +
+        '\n\n' +
+        getTipMessage(tip)
+    );
   }
 
   return getSuccessMessage(message);

src/bugzilla.ts

@@ -9,6 +9,10 @@ export class Bugzilla implements Adapter<BugzillaAPI> {
   readonly api: BugzillaAPI;
   issueDetails: IssueDetails | undefined;
 
+  readonly tips = {
+    approval: 'Bugzilla is approved if it has `release` flag set to `+`',
+  };
+
   constructor(
     readonly instance: string,
     private apiToken: string

src/controller.ts

@@ -7,6 +7,7 @@ import { Jira } from './jira';
 export interface Adapter<T> {
   readonly api: T;
   readonly instance: string;
+  readonly tips: Tips;
 
   getIssueDetails(id: string): Promise<IssueDetails>;
 
@@ -20,6 +21,10 @@ export interface Adapter<T> {
   addLink(urlType: string, bugId: string): Promise<string>;
 }
 
+export type Tips = {
+  approval: string;
+};
+
 export type IssueDetails = {
   id: string;
   product: string;

src/jira.ts

@@ -9,6 +9,10 @@ export class Jira implements Adapter<Version2Client> {
   readonly api: Version2Client;
   issueDetails: IssueDetails | undefined;
 
+  readonly tips = {
+    approval: 'Jira is approved if it has set Fix Version/s',
+  };
+
   constructor(
     readonly instance: string,
     apiToken: string

src/util.ts

@@ -62,6 +62,14 @@ export function getSuccessMessage(message: string[]): string {
   return '#### Success' + '\n\n' + message.join('\n');
 }
 
+export function getTipMessage(tip: string[]): string {
+  if (tip.length === 0) {
+    return '';
+  }
+
+  return '> [!TIP]' + '\n>\n' + tip.map(t => `> ${t}`).join('\n');
+}
+
 export async function setLabels(
   octokit: Octokit,
   issueNumber: number,

test/bugzilla.test.ts → test/unit/bugzilla.test.ts

@@ -1,8 +1,8 @@
 import { beforeEach, describe, expect, test } from 'vitest';
 
-import { Bugzilla } from '../src/bugzilla';
+import { Bugzilla } from '../../src/bugzilla';
 import BugzillaAPI from 'bugzilla';
-import { IssueDetails, Flag } from '../src/controller';
+import { IssueDetails, Flag } from '../../src/controller';
 
 interface TestContext {
   bugzilla: Bugzilla;

test/controller.test.ts → test/unit/controller.test.ts

@@ -7,10 +7,10 @@ import {
   Controller,
   SupportedAdapters,
   SupportedControllers,
-} from '../src/controller';
+} from '../../src/controller';
 
-import { Bugzilla } from '../src/bugzilla';
-import { Jira } from '../src/jira';
+import { Bugzilla } from '../../src/bugzilla';
+import { Jira } from '../../src/jira';
 
 describe('test class Controller', () => {
   test('type SupportedControllers', () => {

test/jira.test.ts → test/unit/jira.test.ts

@@ -1,8 +1,8 @@
 import { beforeEach, describe, expect, test } from 'vitest';
 
-import { Jira } from '../src/jira';
+import { Jira } from '../../src/jira';
 import { Version2Client } from 'jira.js';
-import { IssueDetails, Flag } from '../src/controller';
+import { IssueDetails, Flag } from '../../src/controller';
 
 interface TestContext {
   jira: Jira;

test/util.test.ts → test/unit/util.test.ts

@@ -1,6 +1,11 @@
 import { describe, expect, test } from 'vitest';
 
-import { getFailedMessage, getSuccessMessage, raise } from '../src/util';
+import {
+  getFailedMessage,
+  getSuccessMessage,
+  getTipMessage,
+  raise,
+} from '../../src/util';
 
 describe('test basic utility functions', () => {
   test.todo('updateStatusCheck()', async () => {});
@@ -39,6 +44,23 @@ describe('test basic utility functions', () => {
     `);
   });
 
+  test('getTipMessage()', () => {
+    let tip: string[] = [];
+    let message = getTipMessage(tip);
+
+    expect(message).toEqual('');
+
+    tip = ['success1', 'success2'];
+    message = getTipMessage(tip);
+
+    expect(message).toMatchInlineSnapshot(`
+      "> [!TIP]
+      >
+      > success1
+      > success2"
+    `);
+  });
+
   test('raise()', () =>
     expect(() => raise('new error')).toThrow(new Error('new error')));