Link to the dependabot job on failure

github · Oct 21, 2021 · 461ba8c · 461ba8c
1 parent 135c765
commit 461ba8c
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 11 deletions.
diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -75,7 +75,7 @@ describe('run', () => {
       context = new Context()
     })
 
-    test('it fails the workflow', async () => {
+    test('it skips the rest of the job', async () => {
       await run(context)
 
       expect(core.setFailed).not.toHaveBeenCalled()
@@ -98,7 +98,7 @@ describe('run', () => {
       context = new Context()
     })
 
-    test('it fails the workflow', async () => {
+    test('it skips the rest of the job', async () => {
       await run(context)
 
       expect(core.setFailed).not.toHaveBeenCalled()

diff --git a/src/main.ts b/src/main.ts
@@ -18,20 +18,23 @@ export enum DependabotErrorType {
   UpdateRun = 'actions_workflow_updater'
 }
 
+let jobId: number
+
 export async function run(context: Context): Promise<void> {
   try {
-    core.info('🤖 ~ starting update ~')
+    botSay('starting update')
 
     // Retrieve JobParameters from the Actions environment
     const params = getJobParameters(context)
 
     // The parameters will be null if the Action environment
     // is not a valid Dependabot-triggered dynamic event.
     if (params === null) {
-      core.info('🤖 ~ finished: nothing to do ~')
+      botSay('finished: nothing to do')
       return // TODO: This should be setNeutral in future
     }
 
+    jobId = params.jobId
     core.setSecret(params.jobToken)
     core.setSecret(params.credentialsToken)
 
@@ -77,18 +80,18 @@ export async function run(context: Context): Promise<void> {
         // reported the error and marked the job as processed, so we only need to
         // set an exit status.
         if (error instanceof UpdaterFetchError) {
-          core.setFailed(
+          setFailed(
             'Dependabot was unable to retrieve the files required to perform the update'
           )
-          core.info('🤖 ~ finished: unable to fetch files ~')
+          botSay('finished: unable to fetch files')
           return
         } else {
           core.error('Error performing update')
           await failJob(apiClient, error, DependabotErrorType.UpdateRun)
           return
         }
       }
-      core.info('🤖 ~ finished ~')
+      botSay('finished')
     } catch (error) {
       await failJob(apiClient, error)
       return
@@ -99,8 +102,8 @@ export async function run(context: Context): Promise<void> {
     //
     // We output the raw error in the Action logs and defer
     // to workflow_run monitoring to detect the job failure.
-    core.setFailed(error)
-    core.info('🤖 ~ finished: unexpected error ~')
+    setFailed(error)
+    botSay('finished: unexpected error')
   }
 }
 
@@ -116,8 +119,30 @@ async function failJob(
     }
   })
   await apiClient.markJobAsProcessed()
-  core.setFailed(error.message)
-  core.info('🤖 ~ finished: error reported to Dependabot ~')
+  setFailed(error.message)
+  botSay('finished: error reported to Dependabot')
+}
+
+function botSay(message: string): void {
+  core.info(`🤖 ~ ${message} ~`)
+}
+
+function setFailed(message: string | Error): void {
+  core.setFailed(message)
+  if (jobId) {
+    core.error(`For more information see: ${dependabotJobUrl(jobId)}`)
+  }
+}
+
+function dependabotJobUrl(id: number): string {
+  const url_parts = [
+    process.env.GITHUB_SERVER_URL,
+    process.env.GITHUB_REPOSITORY,
+    'network/updates',
+    id
+  ]
+
+  return url_parts.filter(Boolean).join('/')
 }
 
 run(github.context)