Merge pull request #2 from adamzolyak/patching

Patching and Actions YAML

Author: adamzolyak

CONTRIBUTING.md

@@ -29,7 +29,7 @@ export GITHUB_TOKEN="12345"
 export GITHUB_REPOSITORY="adamzolyak/actions-playground"
 export GITHUB_EVENT_PATH="/commit-issue-commenter-action/tests/fixtures/actionTrigger.json"
 
-node index.js
+node app.js
 ```
 
 3. modify contents of [/tests/fixtures/actionTrigger.json](./tests/fixtures/actionTrigger.json) as needed for test data

README.md

@@ -25,19 +25,22 @@ To use this GitHub Action, you must have access to [GitHub Actions](https://gith
 
 To setup this action:
 
-1. Create a `.github/main.workflow` in your GitHub repo.
-2. Add the following code to the `main.workflow` file and commit it to the repo's `master` branch.
-
-```
-workflow "Commit Issue Commenter" {
-  resolves = ["Comment From Commit"]
-  on = "push"
-}
-
-action "Comment From Commit" {
-  uses = "adamzolyak/commit-issue-commenter-action@master"
-  secrets = ["GITHUB_TOKEN"]
-}
+1. Create a `.github/worksflows/main.yml` in your GitHub repo ([more info](https://help.github.com/en/articles/configuring-a-workflow)).
+2. Add the following code to the `main.yml` file and commit it to the repo's `master` branch.
+
+```yaml
+name: Commit Issue Commenter
+
+on: push
+
+jobs:
+  checkCommit:
+    name: Comment From Commit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: adamzolyak/commit-issue-commenter-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 3. Whenever you push changes to GitHub, the action will run!
@@ -48,4 +51,4 @@ If you have suggestions for how this GitHub Action could be improved, or want to
 
 ## License
 
-[ISC](LICENSE) © 2018 Adam Zolyak <adam@tinkurlab.com> (www.tinkurlab.com)
+[ISC](LICENSE) © 2019 Adam Zolyak <adam@tinkurlab.com> (www.tinkurlab.com)

dev.example

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

helpers.js

@@ -1,58 +1,67 @@
 const fs = require('fs')
 
 module.exports.readFilePromise = function(filename) {
-    return new Promise((resolve, reject) => {
-        fs.readFile(filename, 'utf8', (err, data) => {
-        if (err) reject(err);
-        else resolve(data);
-        })
-    }).catch(err => {
-        console.log(err)
+  return new Promise((resolve, reject) => {
+    fs.readFile(filename, 'utf8', (err, data) => {
+      if (err) reject(err)
+      else resolve(data)
     })
+  }).catch(err => {
+    console.log(err)
+  })
 }
 
 module.exports.getOwner = function(eventOwnerAndRepo) {
-    const slicePos1 = eventOwnerAndRepo.indexOf("/")
-    return eventOwnerAndRepo.slice(0, slicePos1)
+  const slicePos1 = eventOwnerAndRepo.indexOf('/')
+  return eventOwnerAndRepo.slice(0, slicePos1)
 }
 
 module.exports.getRepo = function(eventOwnerAndRepo) {
-    const slicePos1 = eventOwnerAndRepo.indexOf("/")
-    return eventOwnerAndRepo.slice(slicePos1 + 1, eventOwnerAndRepo.length)
+  const slicePos1 = eventOwnerAndRepo.indexOf('/')
+  return eventOwnerAndRepo.slice(slicePos1 + 1, eventOwnerAndRepo.length)
 }
 
-module.exports.getIssueFromBranch = function(pushRef) {      
-    let regex1 = /refs\/heads\/(\d+)/i
-    let found = pushRef.match(regex1)
+module.exports.getIssueFromBranch = function(pushRef) {
+  let regex1 = /refs\/heads\/(\d+)/i
+  let found = pushRef.match(regex1)
 
-    if(found) {
-        return found[1]
-        console.log('function: ' + found)
-    } else {
-        return false
-    }
+  if (found) {
+    return found[1]
+    console.log('function: ' + found)
+  } else {
+    return false
+  }
 }
 
-module.exports.checkForCommitActions = function(commitMessage) {      
-    let regex1 = /#comment (.*)/i
-    let found = commitMessage.match(regex1)
+module.exports.checkForCommitActions = function(commitMessage) {
+  let regex1 = /#comment (.*)/i
+  let found = commitMessage.match(regex1)
 
-    if(found) {
-        return found[1]
-    } else {
-        return false
-    }
+  if (found) {
+    return found[1]
+  } else {
+    return false
+  }
 }
 
-module.exports.addComment = function(octokit, eventOwner, eventRepo, branchIssueNumber, comment) {
-    octokit.issues.createComment({
-        owner: eventOwner,
-        repo: eventRepo,
-        number: branchIssueNumber,
-        body: comment
-    }).then(({ data, headers, status }) => {
-        // handle data
-    }).catch(err => {
-        console.log(err)
+module.exports.addComment = function(
+  octokit,
+  eventOwner,
+  eventRepo,
+  branchIssueNumber,
+  comment
+) {
+  octokit.issues
+    .createComment({
+      owner: eventOwner,
+      repo: eventRepo,
+      issue_number: branchIssueNumber,
+      body: comment
+    })
+    .then(({ data, headers, status }) => {
+      // handle data
+    })
+    .catch(err => {
+      console.log(err)
     })
 }