Support workflow_dispatch event type (#31)

Author: namoscato

dist/index.js

@@ -167,6 +167,52 @@ describe('postMessage', () => {
     })
   })
 
+  describe('first summary workflow_dispatch event', () => {
+    beforeEach(async () => {
+      github.context.eventName = 'workflow_dispatch'
+      github.context.sha = '05b16c3beb3a07dceaf6cf964d0be9eccbc026e8'
+
+      octokit.rest.repos.getCommit = jest.fn(async () => ({
+        data: {
+          commit: {
+            message: 'COMMIT-MESSAGE',
+            url: 'github.com/commit'
+          }
+        }
+      })) as any
+
+      ts = await postMessage(octokit, slack)
+    })
+
+    it('should fetch commit', () => {
+      expect(octokit.rest.repos.getCommit).toHaveBeenCalledWith({
+        owner: 'namoscato',
+        repo: 'action-testing',
+        ref: '05b16c3beb3a07dceaf6cf964d0be9eccbc026e8'
+      })
+    })
+
+    it('should post slack message', () => {
+      expect(slack.postMessage).toHaveBeenCalledWith(
+        expect.objectContaining({
+          text: 'Deploying action-testing: COMMIT-MESSAGE',
+          blocks: expect.arrayContaining([
+            {
+              type: 'context',
+              elements: expect.arrayContaining([
+                {
+                  type: 'image',
+                  alt_text: 'workflow_dispatch event',
+                  image_url: EVENT_NAME_IMAGE_MAP['workflow_dispatch']
+                }
+              ])
+            }
+          ])
+        })
+      )
+    })
+  })
+
   describe('stage push', () => {
     beforeEach(async () => {
       process.env.INPUT_THREAD_TS = '1662768000' // 2022-09-10T00:00:00.000Z
@@ -513,7 +559,7 @@ describe('postMessage', () => {
 
     it('should throw error', () => {
       expect(error.message).toBe(
-        'Unsupported "issues" event (currently supported events include: pull_request, push, schedule)'
+        'Unsupported "issues" event (currently supported events include: pull_request, push, schedule, workflow_dispatch)'
       )
     })
   })

dist/index.js.map

@@ -15,7 +15,9 @@ export const EVENT_NAME_IMAGE_MAP: Record<SupportedEventName, string> = {
     'https://user-images.githubusercontent.com/847532/193414326-5aaf5449-0c81-4a66-9b19-4e5e6baeee9e.png',
   push: 'https://user-images.githubusercontent.com/847532/193413878-d5fcd559-401d-4954-a44c-36de5d6a7adf.png',
   schedule:
-    'https://user-images.githubusercontent.com/847532/193414289-3b185a3b-aee8-40f9-99fe-0615d255c8dd.png'
+    'https://user-images.githubusercontent.com/847532/193414289-3b185a3b-aee8-40f9-99fe-0615d255c8dd.png',
+  workflow_dispatch:
+    'https://user-images.githubusercontent.com/847532/197601879-3bc8bf73-87c0-4216-8de7-c55d34993ef1.png'
 } as const
 
 export function getContextBlock(duration?: Duration): ContextBlock {

src/__tests__/message.test.ts

@@ -11,6 +11,7 @@ import {
   isPullRequestEvent,
   isPushEvent,
   isScheduleEvent,
+  isWorkflowDispatchEvent,
   SupportedContext
 } from './webhook'
 
@@ -105,7 +106,7 @@ async function getEventLink(octokit: OctokitClient): Promise<Link> {
     }
   }
 
-  if (isScheduleEvent(context)) {
+  if (isScheduleEvent(context) || isWorkflowDispatchEvent(context)) {
     const commit = (
       await octokit.rest.repos.getCommit({
         ...context.repo,

src/github/context.ts

@@ -5,7 +5,8 @@ import type {PullRequestEvent, PushEvent, User} from '@octokit/webhooks-types'
 export const SUPPORTED_EVENT_NAMES = [
   'pull_request',
   'push',
-  'schedule'
+  'schedule',
+  'workflow_dispatch'
 ] as const
 
 export type SupportedEventName = typeof SUPPORTED_EVENT_NAMES[number]
@@ -22,16 +23,26 @@ export interface ScheduleEvent {
   schedule: string
 }
 
+export interface WorkflowDispatchEvent {
+  workflow: string
+}
+
 export type PullRequestContext = Context<'pull_request', PullRequestEvent>
 
 export type PushContext = Context<'push', PushEvent>
 
 export type ScheduleContext = Context<'schedule', ScheduleEvent>
 
+export type WorkflowDispatchContext = Context<
+  'workflow_dispatch',
+  WorkflowDispatchEvent
+>
+
 export type SupportedContext =
   | PullRequestContext
   | PushContext
   | ScheduleContext
+  | WorkflowDispatchContext
 
 /**
  * @see https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull_request
@@ -58,6 +69,15 @@ export function isScheduleEvent(
   return 'schedule' === context.eventName
 }
 
+/**
+ * @see https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch
+ */
+export function isWorkflowDispatchEvent(
+  context: GitHubContext
+): context is WorkflowDispatchContext {
+  return 'workflow_dispatch' === context.eventName
+}
+
 export function isSupportedEvent(
   context: GitHubContext
 ): context is SupportedContext {