Feat/always latest delete comment (#184)

* feat: add deleteComment function to GitHub client and update comment handling logic

Author: Ma11hewThomas

README.md

@@ -223,15 +223,15 @@ Requires a `GITHUB_TOKEN` with issue or pull request write permission.
 
 ### Comment Management Inputs
 
-`--update-comment` An existing tagged comment is found, the new report is
+`update-comment` An existing tagged comment is found, the new report is
 appended to it. Otherwise, a new comment is created.
 
-`--overwrite-comment` An existing tagged comment is found, that comment's entire
+`overwrite-comment` An existing tagged comment is found, that comment's entire
 content is replaced with the new report. Otherwise, a new comment is created.
 
-`--always-latest-comment` Create a new comment if the existing comment is not the latest in the thread. Use with `--update-comment` or `--overwrite-comment`. Default is false
+`always-latest-comment` Create a new comment if the existing comment is not the latest in the thread. Use with `update-comment` or `overwrite-comment`. Default is false
 
-`--comment-tag` A unique identifier for comments posted. Used to find and
+`comment-tag` A unique identifier for comments posted. Used to find and
 update/overwrite existing comments.
 
 For example, the following command creates or updates a comment tagged with the

badges/coverage.svg

@@ -86,3 +86,26 @@ export async function listComments(
   })
   return response.data
 }
+
+/**
+ * Deletes a comment on a specified pull request on GitHub.
+ *
+ * @param comment_id - The ID number of the comment
+ * @param owner - The owner of the repository (organization or user).
+ * @param repo - The name of the repository.
+ * @param issue_number - The pull request number to which the comment will be added.
+ */
+export async function deleteComment(
+  comment_id: number,
+  owner: string,
+  repo: string,
+  issue_number: number
+): Promise<void> {
+  const octokit = await createGitHubClient()
+  await octokit.issues.deleteComment({
+    comment_id,
+    owner,
+    repo,
+    issue_number
+  })
+}

dist/index.js

@@ -3,7 +3,8 @@ import { context } from '@actions/github'
 import {
   updateComment,
   listComments,
-  addCommentToIssue
+  addCommentToIssue,
+  deleteComment
 } from '../client/github'
 import { CtrfReport, Inputs } from '../types'
 import { generateViews, annotateFailed } from './core'
@@ -130,6 +131,7 @@ export async function handleComment(
 
   if (updateConfig.alwaysLatestComment && existingComment && !isLatest) {
     await addCommentToIssue(owner, repo, issue_number, `${body}\n${marker}`)
+    await deleteComment(existingComment.id, owner, repo, issue_number)
     return
   }
 
@@ -208,7 +210,6 @@ async function postOrUpdatePRComment(
           'For forked PRs, you should use the pull_request_target event instead of pull_request.'
       )
     } else if (error instanceof Error) {
-      // Log other errors
       core.warning(`Failed to post PR comment: ${error.message}`)
     }
   }