Merge pull request #41 from github/fork-outputs

Fork Outputs

Author: GrantBirki

README.md

@@ -263,6 +263,10 @@ As seen above, we have two steps. One for a noop deploy, and one for a regular d
 | comment_id | The comment id which triggered this deployment |
 | type | The type of trigger that was detected (examples: deploy, lock, unlock) |
 | continue | The string "true" if the deployment should continue, otherwise empty - Use this to conditionally control if your deployment should proceed or not |
+| fork | The string "true" if the pull request is a fork, otherwise "false" |
+| fork_ref | The true ref of the fork |
+| fork_label | The API label field returned for the fork |
+| fork_checkout | The console command presented in the GitHub UI to checkout a given fork locally |
 
 ## Custom Deployment Messages ✏️
 

__tests__/functions/prechecks.test.js

@@ -5,6 +5,8 @@ import dedent from 'dedent-js'
 beforeEach(() => {
   // jest.resetAllMocks()
   jest.spyOn(core, 'info').mockImplementation(() => {})
+  jest.spyOn(core, 'debug').mockImplementation(() => {})
+  jest.spyOn(core, 'setOutput').mockImplementation(() => {})
 })
 
 // Globals for testing
@@ -430,6 +432,7 @@ test('runs prechecks and finds that the IssueOps command is valid for a branch d
       head: {
         sha: 'abcde12345',
         ref: 'test-ref',
+        label: 'test-repo:test-ref',
         repo: {
           fork: true
         }

action.yml

@@ -76,6 +76,14 @@ outputs:
     description: "The type of trigger that was detected (examples: deploy, lock, unlock)"
   continue:
     description: 'The string "true" if the deployment should continue, otherwise empty - Use this to conditionally control if your deployment should proceed or not'
+  fork:
+    description: 'The string "true" if the pull request is a fork, otherwise "false"'
+  fork_ref:
+    description: 'The true ref of the fork'
+  fork_label:
+    description: 'The API label field returned for the fork'
+  fork_checkout:
+    description: 'The console command presented in the GitHub UI to checkout a given fork locally'
 runs:
   using: "node16"
   main: "dist/index.js"

dist/index.js

@@ -49,17 +49,30 @@ export async function prechecks(
   // Determine whether to use the ref or sha depending on if the PR is from a fork or not
   if (pr.data.head.repo?.fork === true) {
     core.info(`PR is from a fork, using sha instead of ref`)
+    core.setOutput('fork', 'true')
 
     // If this Action's inputs have been configured to explicitly prevent forks, exit
     if (allowForks === false) {
       message = `### ⚠️ Cannot proceed with deployment\n\nThis Action has been explicity configured to prevent deployments from forks. You can change this via this Action's inputs if needed`
       return {message: message, status: false}
     }
 
+    // Set some outputs specific to forks
+    const label = pr.data.head.label
+    const forkRef = pr.data.head.ref
+    const forkCheckout = `${label.replace(':', '-')} ${forkRef}`
+    core.setOutput('fork_ref', forkRef)
+    core.setOutput('fork_label', label)
+    core.setOutput('fork_checkout', forkCheckout)
+    core.debug(`fork_ref: ${forkRef}`)
+    core.debug(`fork_label: ${label}`)
+    core.debug(`fork_checkout: ${forkCheckout}`)
+
     // If this pull request is a fork, use the exact SHA rather than the branch name
     ref = pr.data.head.sha
   } else {
     // If this PR is NOT a fork, we can safely use the branch name
+    core.setOutput('fork', 'false')
     ref = pr.data.head.ref
   }