feat: add main branch head commit sha to deployment payload (#2)

Author: radiantspace

action.yml

@@ -26,6 +26,9 @@ inputs:
   environment_url:
     required: false
     description: link for the deployment (e.g. http://staging.your.app/status)
+  main_branch:
+    required: false
+    description: name of main branch of the repo, to get and store sha of the head commit and track diff being deployed
 runs:
   using: 'node12'
   main: 'dist/index.js'

dist/index.js

@@ -3542,7 +3542,7 @@ function getInput(name, options) {
     return result;
 }
 function run() {
-    var _a, _b, _c, _d, _e, _f, _g;
+    var _a, _b, _c, _d, _e, _f, _g, _h;
     return __awaiter(this, void 0, void 0, function* () {
         let token;
         let type;
@@ -3552,6 +3552,7 @@ function run() {
         let environment;
         let environmentUrl;
         let deploymentId;
+        let mainBranch;
         const { actor, ref } = github.context;
         console.log('### context ###');
         console.log(`actor: ${actor}`);
@@ -3573,8 +3574,10 @@ function run() {
             console.log(`environment: ${environment}`);
             environmentUrl = (_f = getInput('environment_url')) !== null && _f !== void 0 ? _f : '';
             console.log(`environmentUrl: ${environmentUrl}`);
+            mainBranch = (_g = getInput('main_branch')) !== null && _g !== void 0 ? _g : 'master';
+            console.log(`main branch: ${mainBranch}`);
             const shouldRequireDeploymentId = type === 'finish' || type === 'delete';
-            deploymentId = (_g = getInput('deployment_id', { required: shouldRequireDeploymentId })) !== null && _g !== void 0 ? _g : '0';
+            deploymentId = (_h = getInput('deployment_id', { required: shouldRequireDeploymentId })) !== null && _h !== void 0 ? _h : '0';
             console.log(`deploymentId: ${deploymentId}`);
         }
         catch (error) {
@@ -3588,7 +3591,7 @@ function run() {
         switch (type) {
             case 'create':
                 try {
-                    deploymentId = yield create_1.create(client, logsUrl, description, status, environment, environmentUrl);
+                    deploymentId = yield create_1.create(client, logsUrl, description, status, environment, environmentUrl, mainBranch);
                     console.log(`setOutput::deployment_id: ${deploymentId}`);
                     core.setOutput('deployment_id', deploymentId);
                 }
@@ -8670,10 +8673,28 @@ function invalidatePreviousDeployments(client, environment) {
         })));
     });
 }
-function create(client, logUrl, description, initialStatus, environment, environmentUrl) {
+function getMainSha(client, branch) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const response = yield client.repos.getBranch(Object.assign(Object.assign({}, github_1.context.repo), { branch }));
+            const sha = response.data.commit.sha;
+            console.log(`${branch} branch sha: ${sha}`);
+            return sha;
+        }
+        catch (error) {
+            console.error(error.message);
+            return `no_${branch}`;
+        }
+    });
+}
+function create(client, logUrl, description, initialStatus, environment, environmentUrl, mainBranch) {
     return __awaiter(this, void 0, void 0, function* () {
         yield invalidatePreviousDeployments(client, environment);
-        const deployment = yield client.repos.createDeployment(Object.assign(Object.assign({}, github_1.context.repo), { ref: github_1.context.ref, required_contexts: [], environment, transient_environment: true, auto_merge: false, description, payload: JSON.stringify({ actor: github_1.context.actor }) }));
+        // get main branch sha to store in payload
+        const mainBranchSha = yield getMainSha(client, mainBranch);
+        const payload = JSON.stringify({ actor: github_1.context.actor, main_sha: mainBranchSha });
+        const deployment = yield client.repos.createDeployment(Object.assign(Object.assign({}, github_1.context.repo), { ref: github_1.context.ref, required_contexts: [], environment, transient_environment: true, auto_merge: false, description,
+            payload }));
         console.log(`created deployment: ${JSON.stringify(deployment.data, null, 2)}`);
         const status = yield client.repos.createDeploymentStatus(Object.assign(Object.assign({}, github_1.context.repo), { deployment_id: deployment.data.id, state: initialStatus, log_url: logUrl, environment_url: environmentUrl }));
         console.log(`created deployment status: ${JSON.stringify(status.data, null, 2)}`);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "action-deploy",
-  "version": "0.0.1",
+  "version": "1.0.1",
   "private": true,
   "description": "Action to manage GitHub deployments",
   "main": "lib/main.js",

src/create.ts

@@ -40,16 +40,34 @@ async function invalidatePreviousDeployments (
   )
 }
 
+async function getMainSha (client: GitHub, branch: string): Promise<string> {
+  try {
+    const response = await client.repos.getBranch({ ...context.repo, branch })
+    const sha = response.data.commit.sha
+    console.log(`${branch} branch sha: ${sha}`)
+    return sha
+  } catch (error) {
+    console.error(error.message)
+    return `no_${branch}`
+  }
+}
+
 export async function create (
   client: GitHub,
   logUrl: string,
   description: string,
   initialStatus: DeploymentStatus,
   environment: string,
-  environmentUrl: string
+  environmentUrl: string,
+  mainBranch: string
 ): Promise<string> {
   await invalidatePreviousDeployments(client, environment)
 
+  // get main branch sha to store in payload
+  const mainBranchSha = await getMainSha(client, mainBranch)
+
+  const payload = JSON.stringify({ actor: context.actor, main_sha: mainBranchSha })
+
   const deployment = await client.repos.createDeployment({
     ...context.repo,
     ref: context.ref,
@@ -58,7 +76,7 @@ export async function create (
     transient_environment: true,
     auto_merge: false,
     description,
-    payload: JSON.stringify({ actor: context.actor })
+    payload
   })
 
   console.log(`created deployment: ${JSON.stringify(deployment.data, null, 2)}`)

src/main.ts

@@ -28,6 +28,7 @@ export async function run (): Promise<void> {
   let environment: string
   let environmentUrl: string
   let deploymentId: string
+  let mainBranch: string
 
   const { actor, ref } = github.context
 
@@ -59,6 +60,9 @@ export async function run (): Promise<void> {
     environmentUrl = getInput('environment_url') ?? ''
     console.log(`environmentUrl: ${environmentUrl}`)
 
+    mainBranch = getInput('main_branch') ?? 'master'
+    console.log(`main branch: ${mainBranch}`)
+
     const shouldRequireDeploymentId = type === 'finish' || type === 'delete'
     deploymentId = getInput('deployment_id', { required: shouldRequireDeploymentId }) ?? '0'
     console.log(`deploymentId: ${deploymentId}`)
@@ -82,7 +86,8 @@ export async function run (): Promise<void> {
           description,
           status,
           environment,
-          environmentUrl
+          environmentUrl,
+          mainBranch
         )
         console.log(`setOutput::deployment_id: ${deploymentId}`)
         core.setOutput('deployment_id', deploymentId)

tests/main.test.ts

@@ -8,6 +8,7 @@ import nock from 'nock'
 nock.disableNetConnect()
 
 const listDeploymentsReply = [] as any
+const getBranchReply = { commit: { sha: "fake-sha" } } as any
 const postDeploymentReply = { id: 42 } as any
 const postStatusReply = {} as any
 
@@ -40,6 +41,10 @@ describe('create', () => {
       .get('/repos/owner/repo/deployments?ref=refs%2Fheads%2Fmaster&environment=master')
       .reply(200, listDeploymentsReply)
 
+    const getMainBranchSha = nock('https://api.github.com')
+      .get('/repos/owner/repo/branches/master')
+      .reply(200, getBranchReply)
+
     const postDeployment = nock('https://api.github.com')
       .post('/repos/owner/repo/deployments')
       .reply(200, postDeploymentReply)
@@ -53,6 +58,7 @@ describe('create', () => {
 
     // assert
     getListDeployments.done()
+    getMainBranchSha.done()
     postDeployment.done()
     postStatus.done()
   })
@@ -73,6 +79,10 @@ describe('create', () => {
       .get('/repos/owner/repo/deployments?ref=refs%2Fheads%2Fmaster&environment=master')
       .reply(200, listDeploymentsReply)
 
+    const getMainBranchSha = nock('https://api.github.com')
+      .get('/repos/owner/repo/branches/master')
+      .reply(200, getBranchReply)
+
     const postDeployment = nock('https://api.github.com')
       .post('/repos/owner/repo/deployments')
       .reply(400, {"resource":"DeploymentStatus","code":"custom","field":"environment_url","message":"environment_url must use http(s) scheme"})
@@ -88,6 +98,7 @@ describe('create', () => {
     // assert
     getListDeployments.done()
     postDeployment.done()
+    getMainBranchSha.done()
     expect(setFailedSpy.mock.calls).toHaveLength(1)
   })
 })