Log before writing a PR comment (#24)

* Log before writing a PR comment

If the github-token provided in the workflow file does not have
permissions to publish comments in the PR's target repo, then the
github-token will evaluate to empty string even if it was provided in
the workflow file. Adding logs will explain the situation better and
avoid user confusions.

Signed-off-by: Balaji Srinivasan <balaji.srinivasan@nordicsemi.no>

* Run prepare

Co-authored-by: Zennon Gosalvez <1798166+zgosalvez@users.noreply.github.com>

Author: Balaji Srinivasan

dist/main/index.js

@@ -37,12 +37,16 @@ async function run() {
         body += `\n:no_entry: ${errorMessage}`;
       }
 
+      core.debug("Creating a comment in the PR.")
       await octokit.issues.createComment({
         owner: github.context.repo.owner,
         repo: github.context.repo.repo,
         issue_number: github.context.payload.pull_request.number,
         body: body,
       });
+    } else {
+      core.info("github-token received is empty. Skipping writing a comment in the PR.");
+      core.info("Note: This could happen even if github-token was provided in workflow file. It could be because your github token does not have permissions for commenting in target repo.")
     }
 
     if (isFailure) {