Output branch name

Output the name of the branch created when a pull request to update the .NET SDK is opened.

Author: martincostello

.github/workflows/update-dotnet-sdk-test.yml

@@ -32,5 +32,6 @@ jobs:
         echo "SDK updated: ${{ needs.update-sdk.outputs.sdk-updated }}"
         echo "SDK version: ${{ needs.update-sdk.outputs.sdk-version }}"
         echo "Security: ${{ needs.update-sdk.outputs.security }}"
+        echo "Branch name: ${{ needs.update-sdk.outputs.branch-name }}"
         echo "PR number: ${{ needs.update-sdk.outputs.pull-request-number }}"
         echo "PR URL: ${{ needs.update-sdk.outputs.pull-request-html-url }}"

README.md

@@ -200,6 +200,7 @@ jobs:
 
 | **Name** | **Description** |
 |:--|:--|
+| `branch-name` | The name of the Git branch associated with the Pull Request created by the action if the .NET SDK is updated. |
 | `pull-request-number` | The number of the Pull Request created by the action if the .NET SDK is updated. |
 | `pull-request-html-url` | The HTML URL of the Pull Request created by the action if the .NET SDK is updated. |
 | `sdk-updated` | Whether the .NET SDK was updated by the action. |

action.yml

@@ -45,6 +45,8 @@ inputs:
     required: false
     default: false
 outputs:
+  branch-name:
+    description: 'The name of the Git branch associated with the Pull Request created by the action if the .NET SDK is updated.'
   pull-request-number:
     description: 'The number of the Pull Request created by the action if the .NET SDK is updated.'
   pull-request-html-url:

dist/index.js

@@ -184,6 +184,7 @@ export class DotNetSdkUpdater {
     const update = DotNetSdkUpdater.getLatestRelease(sdkVersion, releaseChannel);
 
     const result: UpdateResult = {
+      branchName: '',
       pullRequestNumber: 0,
       pullRequestUrl: '',
       updated: false,
@@ -202,6 +203,7 @@ export class DotNetSdkUpdater {
 
       if (baseBranch) {
         const pullRequest = await this.createPullRequest(baseBranch, update);
+        result.branchName = pullRequest.branch;
         result.pullRequestNumber = pullRequest.number;
         result.pullRequestUrl = pullRequest.url;
 
@@ -249,6 +251,7 @@ export class DotNetSdkUpdater {
     if (this.options.dryRun) {
       core.info(`Skipped creating GitHub Pull Request for branch ${this.options.branch} to ${base}`);
       return {
+        branch: '',
         number: 0,
         url: '',
       };
@@ -262,6 +265,7 @@ export class DotNetSdkUpdater {
     core.info(`View the pull request at ${response.data.html_url}`);
 
     const result = {
+      branch: response.data.head.ref,
       number: response.data.number,
       url: response.data.html_url,
     };
@@ -476,6 +480,7 @@ interface CveInfo {
 }
 
 interface PullRequest {
+  branch: string;
   number: number;
   url: string;
 }

dist/index.js.map

@@ -2,6 +2,7 @@
 // Licensed under the Apache 2.0 license. See the LICENSE file in the project root for full license information.
 
 export interface UpdateResult {
+  branchName: string;
   pullRequestNumber: number;
   pullRequestUrl: string;
   security: boolean;

src/DotNetSdkUpdater.ts

@@ -43,6 +43,7 @@ export async function run(): Promise<void> {
     const updater = new DotNetSdkUpdater(options);
     const result = await updater.tryUpdateSdk();
 
+    core.setOutput('branch-name', result.branchName);
     core.setOutput('pull-request-number', result.pullRequestNumber);
     core.setOutput('pull-request-html-url', result.pullRequestUrl);
     core.setOutput('sdk-updated', result.updated);

src/UpdateResult.ts

@@ -68,7 +68,10 @@ describe('update-dotnet-sdk tests', () => {
             Promise.resolve({
               data: {
                 number: '42',
-                html_url: 'https://github.local/martincostello/update-dotnet-sdk/pull/42'
+                html_url: 'https://github.local/martincostello/update-dotnet-sdk/pull/42',
+                head: {
+                  ref: 'update-dotnet-sdk-3.1.201'
+                }
               }
             })
         }
@@ -80,6 +83,7 @@ describe('update-dotnet-sdk tests', () => {
     expect(core.error).toHaveBeenCalledTimes(0);
     expect(core.setFailed).toHaveBeenCalledTimes(0);
 
+    assertOutputValue('branch-name', 'update-dotnet-sdk-3.1.201');
     assertOutputValue('pull-request-html-url', 'https://github.local/martincostello/update-dotnet-sdk/pull/42');
     assertOutputValue('pull-request-number', '42');
     assertOutputValue('sdk-updated', 'true');