feat: update slackWebhookUrls to allow multiple hooks (#23)

thedaviddias · Aug 3, 2023 · f14c145 · f14c145
1 parent 24cb334
commit f14c145
Show file tree

Hide file tree

Showing 10 changed files with 44 additions and 37 deletions.
diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml
@@ -97,7 +97,7 @@ jobs:
  uses: ./
  with:
  github_token: ${{ secrets.GITHUB_TOKEN }}
- slack_webhook_url: ${{ secrets.SLACK_WEBHOOK_URL }}
+ slack_webhook_urls: ${{ secrets.SLACK_WEBHOOK_URL }}
  sentry_project_name: ${{ secrets.SENTRY_PROJECT_NAME }}
  sentry_project_id: ${{ secrets.SENTRY_PROJECT_ID }}
  grafana_dashboard_link: https://example.grafana.net/d/xxxx/web-overview?orgId=1

diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ jobs:
  uses: thedaviddias/[email protected]
  with:
  github_token: ${{ secrets.GITHUB_TOKEN }}
- slack_webhook_url: https://hooks.slack.com/services/XXXXXX/XXXXX/XXXXXXX
+ slack_webhook_urls: https://hooks.slack.com/services/XXXXXX/XXXXX/XXXXXXX
  jira_ticket_prefix: ABC
  jira_instance_url: https://your-jira-instance.com
  sentry_project_name: MyProject
@@ -56,7 +56,7 @@ jobs:
 | `tag_regex` | no | ^v[0-9]+\\.[0-9]+\\.[0-9]+$ | Regex to accommodate varying tag formatting |
 | `contributor_replace_regex` | no | | Regular expression (regex) pattern to identify characters in the `contributor` name that will be replaced |
 | `contributor_replace_char` | no | | The character that will replace specific characters in the `contributor` name |
-| `slack_webhook_url`  | no | | Slack webhook URL to receive release notifications |
+| `slack_webhook_urls` | no | | Slack webhook URL to receive release notifications |
 | `jira_ticket_prefix` | no | | Prefix for JIRA ticket references in PR titles (e.g. ABC) |
 | `jira_instance_url` | no | | URL for your JIRA instance to generate JIRA ticket links (e.g. https://your-jira-instance.com) |
 | `sentry_project_name` | no | | ID of the Sentry project for error tracking |

diff --git a/action.yml b/action.yml
@@ -37,8 +37,8 @@ inputs:
  description: The custom URL of the JIRA instance.
  required: false
 
- slack_webhook_url:
- description: The URL of the Slack Webhook to which the action will send a message with the changelog and release details.
+ slack_webhook_urls:
+ description: Comma-separated list of Slack Webhook URLs to which the action will send a message with the changelog and release details.
  required: false
 
  sentry_project_name:

diff --git a/dist/index.js b/dist/index.js
diff --git a/src/__tests__/index.test.ts b/src/__tests__/index.test.ts
@@ -38,12 +38,12 @@ describe('run function', () => {
  grafanaDashboardLink: 'http://mock-grafana-link',
  sentryProjectName: 'mock-sentry-project-name',
  sentryProjectId: 'mock-sentry-project-id',
- slackWebhookUrl: 'http://mock-webhook-url',
+ slackWebhookUrls: 'http://mock-webhook-url',
  jiraInstanceUrl: 'http://mock-jira-instance-url',
  jiraTicketPrefix: 'ABC',
  contributorReplaceChar: '.',
  contributorReplaceRegex: '-',
- tagRegex: '^v[0-9]+\\.[0-9]+\\.[0-9]+$'
+ tagRegex: '^v[0-9]+\\.[0-9]+\\.[0-9]+$',
  })
 
  const getOwnerAndRepoMock = jest.spyOn(getOwnerAndRepoModule, 'getOwnerAndRepo')
@@ -107,7 +107,6 @@ describe('run function', () => {
  )
  generateReleaseLinkMock.mockReturnValue('http://mock-release-link')
 
-
  // const getCommitOfTagMock = jest.spyOn(getCommitOfTagModule, 'getCommitOfTag')
  // getCommitOfTagMock.mockResolvedValue({ data: { html_url: 'http://mock-commit-url' } })
 

diff --git a/src/index.ts b/src/index.ts
@@ -49,9 +49,9 @@ export async function run(): Promise<void> {
  return
  }
 
-  // Use the first capture group as the version number
-  const currentVersion = currentVersionMatch[1];
-  const previousVersion = previousVersionMatch[1];
+ // Use the first capture group as the version number
+ const currentVersion = currentVersionMatch[1]
+ const previousVersion = previousVersionMatch[1]
 
  const comparisonResult = compareSemVer(currentVersion, previousVersion)
 
@@ -97,14 +97,14 @@ export async function run(): Promise<void> {
  )
 
  // Get the Slack webhook URL from the GitHub Action input
- const slackWebhookUrl = core.getInput('slack_webhook_url')
+ const slackWebhookUrls = core.getInput('slack_webhook_urls').split(',')
 
- if (!slackWebhookUrl) {
+ if (!slackWebhookUrls.length) {
  // If the Slack webhook URL is not provided, skip sending the notification to Slack
  core.debug(
- 'Missing slack_webhook_url input, no publication to Slack with be done but the release info will be available as output.'
+ 'Missing slack_webhook_urls input, no publication to Slack with be done but the release info will be available as output.'
  )
- // Prepare output data even if slackWebhookUrl is not present
+ // Prepare output data even if slackWebhookUrls is not present
  const outputData = {
  repo,
  repoLink,
@@ -166,8 +166,10 @@ export async function run(): Promise<void> {
  currentDate
  )
 
- await axios.post(slackWebhookUrl, slackData)
- core.info('Message sent to Slack.')
+ for (const url of slackWebhookUrls) {
+ await axios.post(url.trim(), slackData)
+ core.info(`Message to Slack`)
+ }
  } catch (error) {
  // If an error occurs during the script execution, fail the GitHub Action and output the error message
  if (error instanceof Error) {

diff --git a/src/utils/__tests__/__mocks__/testData.ts b/src/utils/__tests__/__mocks__/testData.ts
@@ -58,7 +58,7 @@ export const MOCK_GET_INPUTS = {
  sentryProjectName: 'myProject',
  sentryProjectId: '123',
  grafanaDashboardLink: 'https://grafana.myProject.com',
- slackWebhookUrl: 'https://hooks.slack.com/services/123/456/789',
+ slackWebhookUrls: 'https://hooks.slack.com/services/123/456/789',
  jiraTicketPrefix: 'ABC',
  jiraInstanceUrl: 'https://jira.myProject.com',
  contributorReplaceChar: '.',

diff --git a/src/utils/__tests__/generateSlackMessage.test.ts b/src/utils/__tests__/generateSlackMessage.test.ts
@@ -74,7 +74,7 @@ describe('generateSlackMessage', () => {
  sentryProjectName: '',
  sentryProjectId: '',
  grafanaDashboardLink: '',
- slackWebhookUrl: '',
+ slackWebhookUrls: '',
  }
  const slackMessage = generateSlackMessage(
  MOCK_REPO_LINK,

diff --git a/src/utils/__tests__/getInputs.test.ts b/src/utils/__tests__/getInputs.test.ts
@@ -14,7 +14,7 @@ describe('getInputs', () => {
  return 'my-project-name'
  case 'sentry_project_id':
  return 'invalid-project-id' // Note: this is not a valid numeric ID
- case 'slack_webhook_url':
+ case 'slack_webhook_urls':
  return 'invalid-webhook-url' // Note: this is not a valid URL that starts with 'https://hooks.slack.com'
  case 'jira_instance_url':
  return 'invalid-jira-ticket-link' // Note: this is not a valid URL
@@ -39,20 +39,20 @@ describe('getInputs', () => {
  grafanaDashboardLink: 'my-dashboard-link',
  sentryProjectName: 'my-project-name',
  sentryProjectId: 'invalid-project-id',
- slackWebhookUrl: 'invalid-webhook-url',
+ slackWebhookUrls: 'invalid-webhook-url',
  jiraInstanceUrl: 'invalid-jira-ticket-link/browse/',
  jiraTicketPrefix: 'ABC',
  contributorReplaceChar: '.',
  contributorReplaceRegex: '-',
- tagRegex: 'my-tag-regex'
+ tagRegex: 'my-tag-regex',
  }
 
  expect(getInputs()).toEqual(expectedInputs)
  expect(core.getInput).toHaveBeenCalledWith('repo')
  expect(core.getInput).toHaveBeenCalledWith('grafana_dashboard_link')
  expect(core.getInput).toHaveBeenCalledWith('sentry_project_name')
  expect(core.getInput).toHaveBeenCalledWith('sentry_project_id')
- expect(core.getInput).toHaveBeenCalledWith('slack_webhook_url')
+ expect(core.getInput).toHaveBeenCalledWith('slack_webhook_urls')
  expect(core.getInput).toHaveBeenCalledWith('jira_instance_url')
  expect(core.getInput).toHaveBeenCalledWith('jira_ticket_prefix')
  expect(core.getInput).toHaveBeenCalledWith('tag_regex')
@@ -85,8 +85,8 @@ describe('getInputs', () => {
  return 'my-project-name'
  case 'sentry_project_id':
  return '1234'
- case 'slack_webhook_url':
- return 'https://hooks.slack.com/services/XXXX/XXXX/XXXX'
+ case 'slack_webhook_urls':
+ return 'https://hooks.slack.com/services/XXXX/XXXX/XXXX,https://hooks.slack.com/services/XXXX/XXXX/XXXX'
  case 'jira_instance_url':
  return 'https://example.atlassian.net' // Note: this is a valid URL
  case 'jira_ticket_prefix':
@@ -110,7 +110,8 @@ describe('getInputs', () => {
  grafanaDashboardLink: 'https://grafana.com/dashboards/my-dashboard-link',
  sentryProjectName: 'my-project-name',
  sentryProjectId: '1234',
- slackWebhookUrl: 'https://hooks.slack.com/services/XXXX/XXXX/XXXX',
+ slackWebhookUrls:
+ 'https://hooks.slack.com/services/XXXX/XXXX/XXXX,https://hooks.slack.com/services/XXXX/XXXX/XXXX',
  jiraInstanceUrl: 'https://example.atlassian.net/browse/',
  jiraTicketPrefix: 'ABC',
  contributorReplaceChar: '.',
@@ -124,7 +125,7 @@ describe('getInputs', () => {
  expect(core.getInput).toHaveBeenCalledWith('grafana_dashboard_link')
  expect(core.getInput).toHaveBeenCalledWith('sentry_project_name')
  expect(core.getInput).toHaveBeenCalledWith('sentry_project_id')
- expect(core.getInput).toHaveBeenCalledWith('slack_webhook_url')
+ expect(core.getInput).toHaveBeenCalledWith('slack_webhook_urls')
  expect(core.getInput).toHaveBeenCalledWith('jira_instance_url')
  expect(core.getInput).toHaveBeenCalledWith('jira_ticket_prefix')
  expect(core.getInput).toHaveBeenCalledWith('contributor_replace_char')

diff --git a/src/utils/getInputs.ts b/src/utils/getInputs.ts
@@ -26,7 +26,7 @@ export interface GetInputsType {
  sentryProjectName: string
  sentryProjectId: string
  grafanaDashboardLink: string
- slackWebhookUrl: string
+ slackWebhookUrls: string
  jiraTicketPrefix: string
  jiraInstanceUrl: string
  contributorReplaceChar: string
@@ -48,7 +48,7 @@ export function getInputs(): GetInputsType {
  const grafanaDashboardLink = core.getInput('grafana_dashboard_link') || ''
  const sentryProjectName = core.getInput('sentry_project_name') || ''
  const sentryProjectId = core.getInput('sentry_project_id') || ''
- const slackWebhookUrl = core.getInput('slack_webhook_url') || ''
+ const slackWebhookUrls = core.getInput('slack_webhook_urls') || ''
  const contributorReplaceChar = core.getInput('contributor_replace_char') || ''
  const contributorReplaceRegex = core.getInput('contributor_replace_regex') || ''
 
@@ -57,12 +57,17 @@ export function getInputs(): GetInputsType {
  core.warning(`Invalid Grafana dashboard link: ${grafanaDashboardLink}`)
  }
 
- if (
- slackWebhookUrl &&
- (!isValidUrl(slackWebhookUrl) ||
- !slackWebhookUrl.startsWith('https://hooks.slack.com'))
- ) {
- core.warning(`Invalid Slack webhook URL: ${slackWebhookUrl}`)
+ // Now split the slackWebhookUrls and validate each one
+ const slackWebhookUrlArray = slackWebhookUrls.split(',')
+
+ for (const url of slackWebhookUrlArray) {
+ const trimmedUrl = url.trim()
+ if (
+ !isValidUrl(trimmedUrl) ||
+ !trimmedUrl.startsWith('https://hooks.slack.com')
+ ) {
+ core.warning(`Invalid Slack webhook URL: ${trimmedUrl}`)
+ }
  }
 
  // Input value checking for repo format
@@ -100,7 +105,7 @@ export function getInputs(): GetInputsType {
  grafanaDashboardLink,
  sentryProjectName,
  sentryProjectId,
- slackWebhookUrl,
+ slackWebhookUrls,
  jiraTicketPrefix,
  jiraInstanceUrl: jiraInstanceUrlProcessed,
  contributorReplaceChar,