Add debug logging; update readme (#5)

Author: opsless-bot

README.md

@@ -1 +1,37 @@
-# MS Team Github Actions integration
+# MS Team Github Actions integration
+
+### Usage
+
+1. Add `MS_TEAMS_WEBHOOK_URI` on your repository's configs on Settings > Secrets. It is the [webhook URI](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) of the dedicated Microsoft Teams channel for notification.
+
+2) Add a new `step` on your workflow code as last step of workflow job:
+
+```yaml
+name: MS Teams Github Actions integration
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: opsless/ms-teams-github-actions@main
+        if: always() # to let this step always run even if previous step failed
+        with:
+          github-token: ${{ github.token }}
+          webhook-uri: ${{ secrets.MS_TEAMS_WEBHOOK_URI }}
+```
+
+### Known Issues
+
+- Always set this step with `if: always()` when there are steps between `actions/checkout@v2` and this step.
+
+### Roadmap
+
+- add error message if workflow failed
+- add files changed list
+- add workflow run duration
+
+Feel free to create issue if you have an idea in mind

dist/main/index.js

@@ -1,6 +1,6 @@
 {
   "name": "@opsless/ms-teams-github-actions",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "private": true,
   "description": "MS Teams Github Actions integration",
   "main": "lib/main.js",

package.json

@@ -11,32 +11,45 @@ function sleep(ms: number) {
 async function run() {
   try {
     const token = core.getInput("github-token");
+    if (!token) {
+      core.setFailed("'github-token' input can't be empty")
+      return
+    }
+
     const webhookUri = core.getInput("webhook-uri")
+    if (!webhookUri) {
+      core.setFailed("'webhook-uri' input can't be empty")
+      return
+    }
     const ctx = github.context;
     const o = github.getOctokit(token);
 
+    core.debug(JSON.stringify(ctx))
+
     await sleep(5000)
 
     const jobList = await o.actions.listJobsForWorkflowRun({
       repo: ctx.repo.repo,
       owner: ctx.repo.owner,
       run_id: ctx.runId,
     });
-    
+
     const jobs = jobList.data.jobs
+    core.debug(JSON.stringify(jobs))
+    
     const job = jobs.find(job => job.name === ctx.job);
 
     const stoppedStep = job?.steps.find(s => s.conclusion === "failure" || s.conclusion === "timed_out" || s.conclusion === "cancelled" || s.conclusion === "action_required")
     const lastStep = stoppedStep ? stoppedStep : job?.steps.reverse().find(s => s.status === "completed")
 
-    core.info(JSON.stringify(jobList))
-
     const wr = await o.actions.getWorkflowRun({
       owner: ctx.repo.owner,
       repo: ctx.repo.repo,
       run_id: ctx.runId
     })
 
+    core.debug(JSON.stringify(wr.data))
+
     const repository_url = ctx.payload.repository?.html_url
     const commit_author = ctx.actor
 
@@ -59,7 +72,7 @@ async function run() {
             },
             {
               name: ctx.eventName === "pull_request" ? "Pull request" : "Branch",
-              value: ctx.eventName === "pull_request" ? `[${ctx.payload.pull_request?.html_url}](${ctx.payload.pull_request?.html_url})` : `${ctx.payload.repository?.html_url}/tree/${ctx.ref}`
+              value: ctx.eventName === "pull_request" ? `[${ctx.payload.pull_request?.html_url}](${ctx.payload.pull_request?.html_url})` : `[${ctx.payload.repository?.html_url}/tree/${ctx.ref}](${ctx.payload.repository?.html_url}/tree/${ctx.ref})`
             },
             {
               name: "Workflow run details",
@@ -71,6 +84,7 @@ async function run() {
       ]
     }
     const response = await axios.default.post(webhookUri, webhookBody)
+    core.debug(JSON.stringify(response.data))
     // TODO: check response status, if not succesful, mark workflow as failed
   } catch (error) {
     core.setFailed(error.message);