feat(Slack): optionally receive api documentation url to display on slack messages

Author: jaychang99

src/locale/en-us.ts

@@ -16,5 +16,7 @@ export const LOCALE_EN_US: Locale = {
   'status.unchanged': 'UNCHANGED',
 
   'required.required': 'Required',
-  'required.optional': 'Optional'
+  'required.optional': 'Optional',
+
+  'button.goto-api-documentation': 'Go to API documentation'
 }

src/locale/ko-kr.ts

@@ -16,5 +16,7 @@ export const LOCALE_KO_KR: Locale = {
   'status.unchanged': '변경되지 않음',
 
   'required.required': '필수',
-  'required.optional': '선택'
+  'required.optional': '선택',
+
+  'button.goto-api-documentation': 'API 문서 바로가기'
 }

src/main.ts

@@ -48,7 +48,8 @@ export async function run(): Promise<void> {
         config.slackConfig.token,
         config.slackConfig.channelId,
         config.slackConfig.memberIdListToMention,
-        config.githubConfig
+        config.githubConfig,
+        config.apiDocumentationUrl
       )
       // eslint-disable-next-line github/array-foreach
       diffFromExternalLibrary.forEach(diff => {

src/services/slack.ts

@@ -1,6 +1,7 @@
 import { DiffOutputItem } from 'openapi-diff-node'
 import {
   RichTextBlock,
+  RichTextElement,
   RichTextList,
   RichTextQuote,
   RichTextSection,
@@ -61,7 +62,8 @@ export class Slack {
     private token: string,
     private channelId: string,
     private memberIdListToMention: string[],
-    private githubConfig: Config['githubConfig']
+    private githubConfig: Config['githubConfig'],
+    private apiDocumentationUrl?: string
   ) {
     this.client = new WebClient(token)
   }
@@ -86,6 +88,37 @@ export class Slack {
     )} `
     const color = STATUS_TO_LOCALE_KEY[diff.status].color
 
+    const additionalInfoList: RichTextElement[] = [
+      {
+        type: 'text',
+        text: this.githubConfig.headCommitInfo.sha.slice(0, 7),
+        style: {
+          code: true
+        }
+      },
+      {
+        type: 'text',
+        text: ` - `
+      },
+      {
+        type: 'link',
+        url: `https://github.com/${this.githubConfig.repository}/commit/${this.githubConfig.headCommitInfo.sha}`,
+        text: this.githubConfig.headCommitInfo.message
+      }
+    ]
+
+    if (this.apiDocumentationUrl) {
+      additionalInfoList.push({
+        type: 'text',
+        text: `   |   `
+      })
+      additionalInfoList.push({
+        type: 'link',
+        url: this.apiDocumentationUrl,
+        text: `${translate('button.goto-api-documentation')}`
+      })
+    }
+
     const res = await this.client.chat.postMessage({
       channel: this.channelId,
       text: mainText,
@@ -145,24 +178,7 @@ export class Slack {
               elements: [
                 {
                   type: 'rich_text_section',
-                  elements: [
-                    {
-                      type: 'text',
-                      text: this.githubConfig.headCommitInfo.sha.slice(0, 7),
-                      style: {
-                        code: true
-                      }
-                    },
-                    {
-                      type: 'text',
-                      text: ` - `
-                    },
-                    {
-                      type: 'link',
-                      url: `https://github.com/${this.githubConfig.repository}/commit/${this.githubConfig.headCommitInfo.sha}`,
-                      text: this.githubConfig.headCommitInfo.message
-                    }
-                  ]
+                  elements: additionalInfoList
                 }
               ]
             }

src/types/config.ts

@@ -4,6 +4,7 @@ export interface Config {
   initialDelayInMilliseconds: number
   slackConfig: SlackDisabledOptions | SlackEnabledOptions
   githubConfig: GithubOptions
+  apiDocumentationUrl?: string
 }
 
 interface SlackDisabledOptions {

src/types/github-input.ts

@@ -38,4 +38,9 @@ export interface GithubInput {
    * The last commit message which triggered the action
    */
   headCommitMessage?: string
+
+  /**
+   * URL of the api documentation - Optional
+   */
+  apiDocumentationUrl?: string
 }

src/types/locale.ts

@@ -15,4 +15,6 @@ export interface Locale {
 
   'required.required': string
   'required.optional': string
+
+  'button.goto-api-documentation': string
 }

src/utils/validate-input.ts

@@ -53,6 +53,10 @@ export function validateInputAndSetConfig(): Config {
     ? process.env.MEMBER_ID_LIST_TO_MENTION
     : core.getInput('member_id_list_to_mention')
 
+  const apiDocumentationUrl = isLocal
+    ? process.env.API_DOCUMENTATION_URL
+    : core.getInput('api_documentation_url')
+
   if (memberIdListToMention !== undefined && memberIdListToMention !== '') {
     // check if memberIdListToMention is a string of comma separated strings
     const memberIdListToMentionArray = memberIdListToMention.split(',')
@@ -121,39 +125,38 @@ export function validateInputAndSetConfig(): Config {
     headFile
   }
 
+  let slackConfig: Config['slackConfig']
+
   if (isSlackEnabled === 'true') {
     if (
       slackAccessToken !== '' &&
       slackAccessToken !== undefined &&
       slackChannelId !== '' &&
       slackChannelId !== undefined
     ) {
-      return {
-        env,
-        locale,
-        initialDelayInMilliseconds: 500,
-        slackConfig: {
-          enabled: true,
-          token: slackAccessToken,
-          channelId: slackChannelId,
-          memberIdListToMention: memberIdListToMention?.split(',') ?? []
-        },
-        githubConfig
+      slackConfig = {
+        enabled: true,
+        token: slackAccessToken,
+        channelId: slackChannelId,
+        memberIdListToMention: memberIdListToMention?.split(',') ?? []
       }
+    } else {
+      throw new Error(
+        'slack_enabled is set to true, but slack_access_token and slack_channel_id are not set'
+      )
     }
-
-    throw new Error(
-      'slack_enabled is set to true, but slack_access_token and slack_channel_id are not set'
-    )
   } else {
-    return {
-      env,
-      locale,
-      initialDelayInMilliseconds: 500,
-      slackConfig: {
-        enabled: false
-      },
-      githubConfig
+    slackConfig = {
+      enabled: false
     }
   }
+
+  return {
+    env,
+    locale,
+    initialDelayInMilliseconds: 500,
+    slackConfig,
+    githubConfig,
+    apiDocumentationUrl
+  }
 }