feat: add branch name output (#2995)

Author: peter-evans

README.md

@@ -117,6 +117,7 @@ The following outputs can be used by subsequent workflow steps.
 - `pull-request-url` - The URL of the pull request.
 - `pull-request-operation` - The pull request operation performed by the action, `created`, `updated` or `closed`.
 - `pull-request-head-sha` - The commit SHA of the pull request branch.
+- `pull-request-branch` - The branch name of the pull request.
 
 Step outputs can be accessed as in the following example.
 Note that in order to read the step outputs the action step must have an id.

action.yml

@@ -83,6 +83,8 @@ outputs:
     description: 'The pull request operation performed by the action, `created`, `updated` or `closed`.'
   pull-request-head-sha:
     description: 'The commit SHA of the pull request branch.'
+  pull-request-branch:
+    description: 'The pull request branch name'
 runs:
   using: 'node20'
   main: 'dist/index.js'

dist/index.js

@@ -458,6 +458,7 @@ function createPullRequest(inputs) {
                     core.setOutput('pull-request-operation', 'updated');
                 }
                 core.setOutput('pull-request-head-sha', result.headSha);
+                core.setOutput('pull-request-branch', inputs.branch);
                 // Deprecated
                 core.exportVariable('PULL_REQUEST_NUMBER', pull.number);
                 core.endGroup();

src/create-pull-request.ts

@@ -223,6 +223,7 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
         core.setOutput('pull-request-operation', 'updated')
       }
       core.setOutput('pull-request-head-sha', result.headSha)
+      core.setOutput('pull-request-branch', inputs.branch)
       // Deprecated
       core.exportVariable('PULL_REQUEST_NUMBER', pull.number)
       core.endGroup()