Merge pull request #22 from TinkurLab/patching-2022-11

Patching 2022-11

Author: adamzolyak

dev.example .env.exampledev.example renamed to .env.example

@@ -1,6 +1,3 @@
-
 export GITHUB_TOKEN="12345"
 export GITHUB_REPOSITORY="tinkurlab/actions-playground"
-export GITHUB_EVENT_PATH="/commit-issue-commenter-action/tests/fixtures/actionTrigger.json"
-
-node app.js
+export GITHUB_EVENT_PATH="/commit-issue-commenter-action/tests/fixtures/actionTrigger.json"

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 .DS_Store
-dev
+dev
+.env

CONTRIBUTING.md

@@ -15,23 +15,14 @@ Tests are written in [Jest](https://jestjs.io/en/). Tests automatically run on c
 ### To run tests locally
 
 1. run `npm install` to install dependencies
-2. run `npm test` to run tests
+1. run `npm test` to run tests
 
 ### To run action locally
 
 1. `npm install` to install dependencies
-2. create a `dev` file with the following contents:
-
-```bash
-export GITHUB_TOKEN="12345"
-export GITHUB_REPOSITORY="tinkurlab/actions-playground"
-export GITHUB_EVENT_PATH="/commit-issue-commenter-action/tests/fixtures/actionTrigger.json"
-
-node app.js
-```
-
-3. modify contents of [/tests/fixtures/actionTrigger.json](./tests/fixtures/actionTrigger.json) as needed for test data
-4. run `bash dev` to run locally
+1. create a `.env` file similar to `.env.example`
+1. modify contents of [/tests/fixtures/actionTrigger.json](./tests/fixtures/actionTrigger.json) as needed for test data
+1. run `npm start` to run locally
 
 ## Debugging
 

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:14
+FROM node:16
 
 LABEL "com.github.actions.name"="Comment on Issue from Commit"
 LABEL "com.github.actions.description"="Comment on issues from commit messages"

README.md

@@ -51,4 +51,6 @@ If you have suggestions for how this GitHub Action could be improved, or want to
 
 ## License
 
-[ISC](LICENSE) © 2021 Adam Zolyak <adam@tinkurlab.com> (www.tinkurlab.com)
+[ISC](LICENSE) © 2022 Adam Zolyak <adam@tinkurlab.com> (www.tinkurlab.com)
+
+![analytics](https://grabify.link/HBSUPY)

app.js

@@ -4,9 +4,9 @@ const helpers = require('./helpers')
 
 //require octokit rest.js
 //more info at https://github.com/octokit/rest.js
-const Octokit = require('@octokit/rest')
+const { Octokit } = require('@octokit/rest')
 const octokit = new Octokit({
-  auth: `token ${process.env.GITHUB_TOKEN}`
+  auth: `token ${process.env.GITHUB_TOKEN}`,
 })
 
 //set eventOwner and eventRepo based on action's env variables
@@ -15,35 +15,34 @@ const eventOwner = helpers.getOwner(eventOwnerAndRepo)
 const eventRepo = helpers.getRepo(eventOwnerAndRepo)
 
 async function commitChecker() {
-  //read contents of action's event.json
-  const eventData = await helpers.readFilePromise(
-    '..' + process.env.GITHUB_EVENT_PATH
-  )
-  const eventJSON = JSON.parse(eventData)
-
-  //check if branch name starts with an issue number
-  const branchIssueNumber = helpers.getIssueFromBranch(eventJSON.ref)
-
-  if (branchIssueNumber) {
-    //for each commit, check commit message for comment
-    eventJSON.commits.forEach(commit => {
-      const commitComment = helpers.checkForCommitActions(commit.message)
-
-      //if comment in commit message, add comment to related issue
-      if (commitComment) {
-        const comment = `${commitComment} *from @${
-          commit.author.username
-        } in [${commit.id.substring(0, 6)}](${commit.url})*`
-
-        helpers.addComment(
-          octokit,
-          eventOwner,
-          eventRepo,
-          branchIssueNumber,
-          comment
-        )
+  try {
+    //read contents of action's event.json
+    const eventData = await helpers.readFilePromise('..' + process.env.GITHUB_EVENT_PATH)
+
+    if (eventData) {
+      const eventJSON = JSON.parse(eventData)
+
+      //check if branch name starts with an issue number
+      const branchIssueNumber = helpers.getIssueFromBranch(eventJSON.ref)
+
+      if (branchIssueNumber) {
+        //for each commit, check commit message for comment
+        eventJSON.commits.forEach((commit) => {
+          const commitComment = helpers.checkForCommitActions(commit.message)
+
+          //if comment in commit message, add comment to related issue
+          if (commitComment) {
+            const comment = `${commitComment} *from @${
+              commit.author.username
+            } in [${commit.id.substring(0, 6)}](${commit.url})*`
+
+            helpers.addComment(octokit, eventOwner, eventRepo, branchIssueNumber, comment)
+          }
+        })
       }
-    })
+    }
+  } catch (error) {
+    console.log(error)
   }
 }