1.2.0

CHANGELOG.md

@@ -1,5 +1,13 @@
 ### Changelog
 
+#### [v1.2.0](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.1.0...v1.2.0) (23 October 2018)
+- feat: add debugging output to script [`0dce327`](https://git.w33ble.com/w33ble/gh-action-bot/commit/0dce32781b0f8c138d7f8b28382289d67be730dd)
+- feat: debug logging and better timestamps [`08799b4`](https://git.w33ble.com/w33ble/gh-action-bot/commit/08799b48d74d12266d5ebb85811f5d3fa046b086)
+- docs: add note about using DEBUG=1 output [`872d9c7`](https://git.w33ble.com/w33ble/gh-action-bot/commit/872d9c790fc723f1b255536225be60f547cf5196)
+
+#### [v1.1.0](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.0.1...v1.1.0) (22 October 2018)
+- feat: add timestamp to log output [`725638e`](https://git.w33ble.com/w33ble/gh-action-bot/commit/725638ee6b7fbb816518239f5524f6c37056da2e)
+
 #### [v1.0.1](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.0.0...v1.0.1) (22 October 2018)
 - feat: add a force retest script [`def91e3`](https://git.w33ble.com/w33ble/gh-action-bot/commit/def91e35d3c8028b7f78772049b0e93c3c8d677e)
 - fix: add error handling code [`3b44968`](https://git.w33ble.com/w33ble/gh-action-bot/commit/3b4496864b0e9bd248e6d4ea12f2608dd41c0374)

README.md

@@ -17,6 +17,10 @@ You'll need to set some environment flags. Check `sample-env` for what is availa
 
 You will need to provide a Github [Personal Access Token](https://github.com/settings/tokens/new). It will need `write:org` access in order to create comments.
 
+### Debugging
+
+If the script isn't doing what you expect, you can get more output from it by prepending the script with `DEBUG=1`.
+
 #### License
 
 MIT © [w33ble](https://github.com/w33ble)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gh-action-bot",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "private": true,
   "description": "Action bot for Github",
   "main": "index",

src/index.mjs

@@ -1,4 +1,5 @@
 import dotenv from 'dotenv';
+import logger from './lib/logger.mjs';
 import createRepo from './lib/create_repo.mjs';
 import getComments from './lib/get_comments.mjs';
 import getPull from './lib/get_pull.mjs';
@@ -13,6 +14,7 @@ dotenv.config();
 async function ghActionBot() {
   // parse repo name from cli and create repo instance
   const repo = createRepo(process.argv.splice(2)[0]);
+
   const {
     COMMENT_BODY_REGEXP,
     COMMENT_BODY_REGEXP_FLAGS,
@@ -36,9 +38,18 @@ async function ghActionBot() {
     comments.map(async comment => {
       const pull = await getPull(repo, comment.number);
 
-      if (pull.state !== 'open') return false; // filter out any closed pulls
+      if (pull.state !== 'open') {
-      if (PULL_AUTHOR_FILTER && !pull.owner !== PULL_AUTHOR_FILTER) return false; // filter on owner
+        logger.debug(`SKIP #${pull.number}: state is ${pull.state}`);
-      if (PULL_LABEL_FILTER && !pull.labels.includes(PULL_LABEL_FILTER)) return false; // filter on label
+        return false; // filter out any closed pulls
+      }
+      if (PULL_AUTHOR_FILTER && !pull.owner !== PULL_AUTHOR_FILTER) {
+        logger.debug(`SKIP #${pull.number}: author is ${pull.owner}`);
+        return false; // filter on owner
+      }
+      if (PULL_LABEL_FILTER && !pull.labels.includes(PULL_LABEL_FILTER)) {
+        logger.debug(`SKIP #${pull.number}: labels are ${pull.labels.join(',')}`);
+        return false; // filter on label
+      }
 
       return { comment, pull };
     })
@@ -49,18 +60,25 @@ async function ghActionBot() {
       const commit = await getCommits(repo, pull.number, true);
       const buildStatus = await getCommitStatus(repo, commit.sha);
       // do nothing if the build has not started, or is pending or successful
-      if (!buildStatus || buildStatus.state === 'pending' || buildStatus.state === 'success')
+      if (!buildStatus || buildStatus.state === 'pending' || buildStatus.state === 'success') {
+        logger.debug(`SKIP #${pull.number}: build status is ${buildStatus.state}`);
         return false;
+      }
       return { comment, pull, commit, buildStatus };
     })
   )).filter(Boolean);
 
-  console.log(`Found ${records.length} outstanding failures`);
+  if (records.length) {
+    logger.log(`Found ${records.length} outstanding failures`);
+  } else {
+    logger.debug(`Found ${records.length} outstanding failures`);
+  }
 
   await Promise.all(
     records.map(async record => {
-      console.log(`Re-testing PR #${record.pull.number}`);
+      logger.log(`Re-testing PR #${record.pull.number}`);
       const comment = await createComment(repo, records[0].pull.number, PULL_RETEST_BODY);
+      logger.debug(`Created comment id ${comment.id}`);
       await deleteComment(repo, comment.id);
     })
   );
@@ -68,7 +86,7 @@ async function ghActionBot() {
 
 export default function() {
   return ghActionBot().catch(err => {
-    console.error(err);
+    logger.error(err);
     return process.exit(1);
   });
 }

src/lib/logger.mjs

@@ -0,0 +1,38 @@
+/* eslint no-console: 0 */
+const zeroPad = (str, len) => {
+  let output = `${str}`;
+  if (!len || len <= output.length) return str;
+
+  while (output.length < len) {
+    output = `0${output}`;
+  }
+  return output;
+};
+
+const wrapMessage = msg => {
+  const d = new Date();
+  const timestamp = `${[d.getFullYear(), zeroPad(d.getMonth(), 2), zeroPad(d.getDate(), 2)].join(
+    '/'
+  )} ${[zeroPad(d.getHours(), 2), zeroPad(d.getMinutes(), 2), zeroPad(d.getSeconds(), 2)].join(
+    ':'
+  )}`;
+  return `[${timestamp}]: ${msg.join(' ')}`;
+};
+
+const logger = {
+  log(...args) {
+    console.log(wrapMessage(args));
+  },
+  warn(...args) {
+    console.warn(wrapMessage(args));
+  },
+  error(...args) {
+    console.error(wrapMessage(args));
+  },
+  debug(...args) {
+    if (!process.env.DEBUG) return;
+    console.log(wrapMessage(args));
+  },
+};
+
+export default logger;