feat: add commit sha to comment (#5)

closes #2

.projenrc.ts

@@ -34,6 +34,7 @@ const project = new GitHubActionTypeScriptProject({
     },
   },
   deps: [
+    '@octokit/webhooks-definitions',
     '@aws-cdk/cloudformation-diff',
     '@aws-cdk/cloud-assembly-schema',
     '@actions/exec@^1.1.1',

src/action.ts

@@ -13,7 +13,6 @@ export async function run() {
   };
   const octokit = github.getOctokit(inputs.githubToken);
   const context = github.context;
-
   try {
     const assembly = AssemblyManifestReader.fromPath('cdk.out');
     let stages = assembly.stages;

src/comment.ts

@@ -1,13 +1,17 @@
 import { Context } from '@actions/github/lib/context';
 import { GitHub } from '@actions/github/lib/utils';
+import { PullRequestEvent } from '@octokit/webhooks-definitions/schema';
 
 export class Comments {
   private readonly issueNumber: number;
+  private readonly commitSha: string;
   constructor(
     private readonly octokit: InstanceType<typeof GitHub>,
     private readonly context: Context,
   ) {
-    if (!context.payload.pull_request?.number) {
+    const payload = context.payload as PullRequestEvent;
+    this.commitSha = payload.pull_request.head.sha;
+    if (!payload.pull_request.number) {
       throw new Error('Cannot find PR number, is this from a pull request?');
     }
     this.issueNumber = this.context.payload.pull_request?.number!;
@@ -18,7 +22,7 @@ export class Comments {
       ...this.context.repo,
       issue_number: this.issueNumber,
     });
-    return comments.data.find(comment => comment.body_text?.includes(hash))?.id;
+    return comments.data.find(comment => comment.body?.includes(hash))?.id;
   }
 
   public async updateComment(commentId: number, hash: string, content: string[]) {
@@ -27,6 +31,8 @@ export class Comments {
       body: [
         `<!-- cdk diff action with hash ${hash} -->`,
         ...content,
+        '',
+        `_Generated for commit ${this.commitSha}_`,
       ].join('\n'),
       comment_id: commentId,
     });
@@ -38,6 +44,8 @@ export class Comments {
       body: [
         `<!-- cdk diff action with hash ${hash} -->`,
         ...content,
+        '',
+        `_Generated for commit ${this.commitSha}_`,
       ].join('\n'),
       issue_number: this.issueNumber,
     });

test/comment.test.ts

@@ -16,10 +16,11 @@ const context: Context = {
       full_name: 'some-repo',
     },
     pull_request: {
+      head: { sha: '123' },
       number: 1,
     },
   },
-} as Context;
+} as unknown as Context;
 // const pullRequestData = {
 //   data: {
 //     items: [
@@ -34,11 +35,11 @@ const commentDataWithTag = {
   data: [
     {
       id: 1,
-      body_text: 'some comment',
+      body: 'some comment',
     },
     {
       id: 2,
-      body_text: `<!-- cdk diff action with hash ${hash} -->\nprevious-message`,
+      body: `<!-- cdk diff action with hash ${hash} -->\nprevious-message`,
     },
   ],
 };
@@ -47,11 +48,11 @@ const commentDataWithUnMatchedTag = {
   data: [
     {
       id: 1,
-      body_text: 'some comment',
+      body: 'some comment',
     },
     {
       id: 2,
-      body_text: '<!-- cdk diff action with hash SOME-DIFFERENT-HASH -->\nprevious-message',
+      body: '<!-- cdk diff action with hash SOME-DIFFERENT-HASH -->\nprevious-message',
     },
   ],
 };
@@ -89,6 +90,8 @@ describe('comments', () => {
       body: [
         `<!-- cdk diff action with hash ${hash} -->`,
         'message',
+        '',
+        `_Generated for commit ${context.payload.pull_request?.head.sha}_`,
       ].join('\n'),
       comment_id: 1,
     });
@@ -103,6 +106,8 @@ describe('comments', () => {
       body: [
         `<!-- cdk diff action with hash ${hash} -->`,
         'message',
+        '',
+        `_Generated for commit ${context.payload.pull_request?.head.sha}_`,
       ].join('\n'),
       issue_number: context.payload.pull_request?.number,
     });