Debugging instructions and launch config (#4)

* ignore .env coverage and .nyc_output

* add debugging instructions

* vscode launch configs for debugging

Author: robandpdx

.gitignore

@@ -2,4 +2,8 @@
 node_modules
 
 # Serverless directories
-.serverless
+.serverless
+
+.env
+coverage
+.nyc_output

.vscode/launch.json

@@ -0,0 +1,35 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Mocha",
+            "runtimeExecutable": "nyc",
+            "runtimeArgs": [
+                "--reporter=lcov",
+                "--reporter=cobertura",
+                "--reporter=text-summary",
+                "mocha",
+                "--timeout",
+                "999999",
+                "--colors",
+                "${workspaceFolder}"
+            ],
+            "console": "integratedTerminal",
+            "cwd": "${workspaceRoot}/",
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Probot",
+            "runtimeExecutable": "probot",
+            "runtimeArgs": ["run", "./app.js"],
+            "console": "integratedTerminal",
+            "cwd": "${workspaceRoot}/",
+        }
+    ]
+}

README.md

@@ -39,6 +39,16 @@ For continuous deployment via GitHub action, copy [this repository's deploy work
 1. `SERVERLESS_ACCESS_KEY` - You can create a Serverless access key at `https://app.serverless.com/<your org>/settings/accessKeys`
 2. `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` - you will likely find your AWS credentials in `~/.aws/credentials`
 
+### Debug via unit tests
+1. Intall nyc and mocha: `npm install -g nyc mocha`
+1. From the VSCode `RUN AND DEBUG` menu select `Mocha` and click the green arrow to start debugging.
+
+### Debug by launching probot locally and sending it a payload 
+
+1. Point your GitHub app to your local using something like smee.io
+1. Copy .env-sample to .env and populate with values specific for your GitHub app. For the `PRIVATE_KEY` replace newlines with `\\n` to make the string value a single line.
+1. From the VSCode `RUN AND DEBUG` menu select `Launch Probot` and click the green arrow to start debugging.
+
 ## License
 
 [ISC](LICENSE)