feat: Adds outputs for base_sha and head_sha (#8)

Author: caseycs

.github/workflows/pr-test.yml

@@ -33,8 +33,12 @@ jobs:
           STATE=success
           if [[ "${{ steps.refs_in_test.outputs.base_ref }}" == "" ]]; then
             STATE=failure
+          elif [[ "${{ steps.refs_in_test.outputs.base_sha }}" == "" ]]; then
+            STATE=failure
           elif [[ "${{ steps.refs_in_test.outputs.head_ref }}" == "" ]]; then
             STATE=failure
+          elif [[ "${{ steps.refs_in_test.outputs.head_sha }}" == "" ]]; then
+            STATE=failure
           elif [[ "${{ steps.refs_in_test.outcome }}" != "success" ]]; then
             STATE=failure
           fi

dist/index.js

@@ -40,9 +40,11 @@ const resolver_1 = __nccwpck_require__(7409);
 (() => __awaiter(void 0, void 0, void 0, function* () {
     try {
         const githubToken = core.getInput('token');
-        const { headRef, baseRef } = yield (0, resolver_1.resolveRefs)(githubToken);
+        const { headRef, headSha, baseRef, baseSha } = yield (0, resolver_1.resolveRefs)(githubToken);
         core.setOutput('base_ref', baseRef);
+        core.setOutput('base_sha', baseSha);
         core.setOutput('head_ref', headRef);
+        core.setOutput('head_sha', headSha);
     }
     catch (error) {
         core.setFailed(error.message);
@@ -101,8 +103,10 @@ const resolveRefs = (token) => __awaiter(void 0, void 0, void 0, function* () {
     const prDetails = yield octokit.request(`GET ${prUrl}`);
     const status = prDetails.status;
     const headRef = prDetails.data.head.ref;
+    const headSha = prDetails.data.head.sha;
     const baseRef = prDetails.data.base.ref;
-    return { status, headRef, baseRef };
+    const baseSha = prDetails.data.base.sha;
+    return { status, headRef, headSha, baseRef, baseSha };
 });
 exports.resolveRefs = resolveRefs;
 

index.ts

@@ -6,10 +6,12 @@ import { resolveRefs } from './src/resolver';
   try {
     const githubToken = core.getInput('token');
 
-    const { headRef, baseRef } = await resolveRefs(githubToken);
+    const { headRef, headSha, baseRef, baseSha } = await resolveRefs(githubToken);
 
     core.setOutput('base_ref', baseRef);
+    core.setOutput('base_sha', baseSha);
     core.setOutput('head_ref', headRef);
+    core.setOutput('head_sha', headSha);
   } catch (error: any) {
     core.setFailed(error.message);
   }

src/resolver.ts

@@ -18,7 +18,9 @@ export const resolveRefs = async (token: string) => {
 
   const status = prDetails.status;
   const headRef = prDetails.data.head.ref;
+  const headSha = prDetails.data.head.sha;
   const baseRef = prDetails.data.base.ref;
+  const baseSha = prDetails.data.base.sha;
 
-  return { status, headRef, baseRef };
+  return { status, headRef, headSha, baseRef, baseSha };
 };

test/index.test.ts

@@ -11,9 +11,21 @@ describe('resolveRefs', () => {
     expect(headRef).toEqual(mockPayload.octokitPayload.data.head.ref);
   });
 
+  it(`should return head_sha: ${mockPayload.getHeadSha()}`, async () => {
+    const { headSha } = await resolveRefs(token);
+
+    expect(headSha).toEqual(mockPayload.octokitPayload.data.head.sha);
+  });
+
   it(`should return base_ref: ${mockPayload.getBaseRef()}`, async () => {
     const { baseRef } = await resolveRefs(token);
 
     expect(baseRef).toEqual(mockPayload.octokitPayload.data.base.ref);
   });
+
+  it(`should return base_sha: ${mockPayload.getBaseSha()}`, async () => {
+    const { baseSha } = await resolveRefs(token);
+
+    expect(baseSha).toEqual(mockPayload.octokitPayload.data.base.sha);
+  });
 });

test/payload-provider.ts

@@ -1,6 +1,6 @@
 class PayloadProvider {
   contextPayload: any;
-  octokitPayload: { status: string; data: { head: { ref: string; }; base: { ref: string; }; }; };
+  octokitPayload: { status: string; data: { head: { ref: string; sha: string; }; base: { ref: string; sha: string; }; }; };
 
   constructor() {
     this.contextPayload = {
@@ -12,8 +12,8 @@ class PayloadProvider {
     this.octokitPayload = {
       status: '200',
       data: {
-        head: { ref: 'refs/heads/pr' },
-        base: { ref: 'refs/heads/main' },
+        head: { ref: 'refs/heads/pr', sha: 'shaHead' },
+        base: { ref: 'refs/heads/main', sha: 'shaBase' },
       },
     };
   }
@@ -27,7 +27,9 @@ class PayloadProvider {
   }
 
   getHeadRef() { return this.octokitPayload.data.head.ref; }
+  getHeadSha() { return this.octokitPayload.data.head.sha; }
   getBaseRef() { return this.octokitPayload.data.base.ref; }
+  getBaseSha() { return this.octokitPayload.data.base.sha; }
 }
 
 export default new PayloadProvider();