Clear on change (#67)

*Close voting when a PR gets a new commit pushed to it or when it's close and reopened.
*Updated the format of the voting comment to be more clear
*Update Docs
*Updated package.json
** author
** version
** other metadata

README.md

@@ -20,8 +20,11 @@ posted by the action on the PR automatically as a place for :thumbsup:/
 :thumbsdown: votes to be cast.
 
 Only configured voters are counted. Votes are counted when the action is rerun
-either by an update to the PR or manual rerunning it. Failed votes will list
-reasons why the vote failed in the action's error messaging.
+by manual rerunning it. Failed votes will list reasons why the vote failed in
+the action's error messaging.
+
+When a Pull Request is update, it will clear the voting and restart the vote
+with the default settings.
 
 ## Usage
 
@@ -33,14 +36,15 @@ Create a new workflow in `.github/workflows/` as a new `.yaml` file.
 name: 'Voting'
 on:
   pull_request_target:
+    types: [opened, synchronize, reopened, closed]
 
 jobs:
   democracy:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - name: Evaluate vote
-        uses: myyk/git-democracy@main
+        uses: myyk/git-democracy@v1
 ```
 
 The name of the workflow must be `Voting` to match the badge that will be

package.json

@@ -1,8 +1,8 @@
 {
-  "name": "typescript-action",
-  "version": "0.0.0",
+  "name": "git-democracy",
+  "version": "1.1.0",
   "private": true,
-  "description": "TypeScript template action",
+  "description": "Adds voting to github projects.",
   "main": "lib/main.js",
   "scripts": {
     "build": "tsc",
@@ -15,14 +15,14 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/actions/typescript-action.git"
+    "url": "git+https://github.com/myyk/git-democracy.git"
   },
   "keywords": [
     "actions",
     "node",
     "setup"
   ],
-  "author": "",
+  "author": "Myyk Seok",
   "license": "MIT",
   "dependencies": {
     "@actions/core": "^1.2.6",

src/comments.ts

@@ -9,19 +9,22 @@ type Octokit = InstanceType<typeof GitHub>
 export class Comment {
   id: number
   createdAt: Date
+  body: string
 
   constructor(commentResponse: CommentResponse) {
     this.id = commentResponse.id
     this.createdAt = new Date(commentResponse.created_at)
+    this.body = commentResponse.body
   }
 }
 
 interface CommentResponse {
   id: number
   created_at: string
+  body: string
 }
 
-export async function findVotingCommentId(
+export async function findVotingComment(
   octokit: Octokit,
   owner: string,
   repo: string,
@@ -47,27 +50,27 @@ export async function findVotingCommentId(
     return Promise.reject(Error('commentId not a number'))
   }
 
-  core.info(`reactions: ${inspect(comment)}`)
+  core.info(`comment: ${inspect(comment)}`)
   return new Comment(comment)
 }
 
-export async function findOrCreateVotingCommentId(
+export async function findOrCreateVotingComment(
   octokit: Octokit,
   owner: string,
   repo: string,
   issueNumber: number,
   bodyIncludes: string,
   createCommentBody: Promise<string>
 ): Promise<Comment> {
-  const comment = await findVotingCommentId(
+  const comment = await findVotingComment(
     octokit,
     owner,
     repo,
     issueNumber,
     bodyIncludes
   )
   if (!comment) {
-    return createVotingCommentId(
+    return createVotingComment(
       octokit,
       owner,
       repo,
@@ -79,7 +82,7 @@ export async function findOrCreateVotingCommentId(
   return comment
 }
 
-export async function createVotingCommentId(
+export async function createVotingComment(
   octokit: Octokit,
   owner: string,
   repo: string,
@@ -99,7 +102,7 @@ export async function createVotingCommentId(
   return new Comment(comment)
 }
 
-export async function updateVotingCommentId(
+export async function updateVotingComment(
   octokit: Octokit,
   owner: string,
   repo: string,
@@ -126,7 +129,7 @@ export async function createVotingCommentBody(
   const votes = await votesPromise
   const acceptanceCriteria = await acceptanceCriteriaPromise
   let commentBody = `
-![${bodyIncludes}](${serverURL}/${owner}/${repo}/workflows/Voting/badge.svg?branch=${ref})
+**${bodyIncludes}** ![Voting](${serverURL}/${owner}/${repo}/workflows/Voting/badge.svg?branch=${ref})
 Vote on this comment with 👍 or 👎.
 
 Vote Summary:
@@ -143,6 +146,35 @@ Acceptance Criteria:
   return commentBody
 }
 
+export async function closeVotingComment(
+  octokit: Octokit,
+  owner: string,
+  repo: string,
+  comment: Comment,
+  bodyIncludes: string,
+  closedVotingBodyTag: string
+): Promise<void> {
+  if (bodyIncludes === closedVotingBodyTag) {
+    return Promise.reject(
+      Error(
+        'voting comment identifier and closed comment identifier cannot be equal'
+      )
+    )
+  }
+
+  const closedBody = comment.body.replace(bodyIncludes, closedVotingBodyTag)
+
+  await updateVotingComment(
+    octokit,
+    owner,
+    repo,
+    Promise.resolve(comment.id),
+    Promise.resolve(closedBody)
+  )
+
+  return
+}
+
 export async function commentToId(commit: Promise<Comment>): Promise<number> {
   return (await commit).id
 }