Merge pull request #38 from sendbird/fix/version-prefix

fix: add missing framework in version prefix builder

README.md

@@ -40,7 +40,7 @@ Make sure to set the required secret CircleCI API token in the repository settin
 The action requires the following inputs:
 
 | name                          | description                                                                                                                                                                | required |
-|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -------- |
+| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
 | `gh_token`                    | The GitHub access token used to authenticate with the Octokit instance.                                                                                                    | Yes      |
 | `circleci_token`              | The CircleCI API token used to trigger the build and deploy workflow.                                                                                                      | Yes      |
 | `product`                     | The name of the product's SDK, such as `chat`, `calls`, `uikit`, `live`, or `live_uikit`.                                                                                  | Yes      |
@@ -67,3 +67,6 @@ You can pass `--test` parameter to command: `/bot create ticket --test`
 
 It mentions the `@{{product}}-approver` Slack group to notify ticket creation in the channel.
 If it's a new product, you need to add a Slack group with the corresponding name so that the appropriate people can be mentioned.
+
+The Slack message is sent in the following format:
+`@{{product}}-approver 🔖{{product_jira_version_prefix}} {{version}} release ticket has been created!`

src/utils.ts

@@ -26,16 +26,21 @@ export function replaceVersion(link: string, version: string): string {
   return link.replace(target, version)
 }
 
-export function buildProductJiraVersion(
+function platformWithFramework(platform: string, framework?: string): string {
+  return platform + (framework ? `-${framework}` : '')
+}
+
+export function buildJiraVersionPrefix(
   platform: string,
-  product: string
+  product: string,
+  framework = ''
 ): string {
   // {product}-{platform}[-{framework}]?
   // chat-ios, chat-android, live-uikit-js-react, uikit-js-react
 
-  return `${product}-${platform}`
+  const platformAndFramework = platformWithFramework(platform, framework)
+  return `${product}-${platformAndFramework}`
 }
-
 export function buildReleaseJiraVersion(
   platform: string,
   product: string,
@@ -45,8 +50,7 @@ export function buildReleaseJiraVersion(
   // {product}-{platform}[-{framework}]?@{version}
   // live-uikit-js-react@0.0.0, chat-ios@0.0.0
 
-  const platformAndFramework = platformWithFramework(platform, framework)
-  return `${product}-${platformAndFramework}@${version}`
+  return `${buildJiraVersionPrefix(platform, product, framework)}@${version}`
 }
 
 export function buildReleaseJiraTicket(
@@ -62,14 +66,11 @@ export function buildReleaseJiraTicket(
   return `[${capitalizeProduct(product)}] ${platformAndFramework}@${version}`
 }
 
-function platformWithFramework(platform: string, framework?: string): string {
-  return platform + (framework ? `-${framework}` : '')
-}
-
 function capitalizeProduct(str?: string): string {
   if (!str) return ''
   if (str === 'uikit') return 'UIKit'
   if (str === 'live_uikit' || str === 'live-uikit') return 'Live-UIKit'
+  if (str === 'chat-ai-widget') return 'Chat-AI-Widget'
   return capitalize(str)
 }
 

src/workflow.ts

@@ -5,7 +5,7 @@ import fetch from 'node-fetch'
 import type {CommandArguments, CommandParameters} from './command/command'
 import {WORKFLOW_REPO, WORKFLOW_SCRIPT_VERSION, WORKFLOWS} from './constants'
 import {
-  buildProductJiraVersion,
+  buildJiraVersionPrefix,
   buildReleaseJiraTicket,
   buildReleaseJiraVersion,
   extractVersion,
@@ -121,7 +121,11 @@ async function buildCreateTicketParams(
     product_jira_project_key: core.getInput('product_jira_project_key'),
     product_jira_version_prefix:
       core.getInput('product_jira_version_prefix') ||
-      buildProductJiraVersion(basicParams.platform, basicParams.product),
+      buildJiraVersionPrefix(
+        basicParams.platform,
+        basicParams.product,
+        core.getInput('framework').toLowerCase()
+      ),
     release_branch: args.branch,
     release_version,
     release_gh_link: replaceVersion(latestReleaseLink, release_version),