Merge pull request #57 from homoluctus/feature/commit

[WIP] Include commit message
lazy-actions · Nov 21, 2019 · 9dcaaf0 · 9dcaaf0
2 parents 5cddadc + 3ee4bcd
commit 9dcaaf0
Show file tree

Hide file tree

Showing 9 changed files with 1,376 additions and 1,160 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -14,7 +14,7 @@ jobs:
         if: always()
         with:
           type: ${{ job.status }}
-          job_name: ':robot_face: *Check action*'
+          job_name: ':robot_face: *Success*'
           mention: 'here'
           mention_if: 'failure'
           channel: '#develop'
@@ -31,7 +31,7 @@ jobs:
         if: always()
         with:
           type: ${{ job.status }}
-          job_name: ':robot_face: *Check action*'
+          job_name: ':robot_face: *Success no mention*'
           channel: '#develop'
           url: ${{ secrets.SLACK_WEBHOOK }}
 
@@ -41,20 +41,26 @@ jobs:
     steps:
       - uses: actions/checkout@master
 
-      - name: Exit 1
+      - name: Forced failure
         run: exit 1
 
       - name: Slack Notification
         uses: ./
         if: always()
         with:
           type: ${{ job.status }}
-          job_name: ':robot_face: *Check action*'
+          job_name: ':robot_face: *Failure*'
           mention: 'here'
           mention_if: 'failure'
           channel: '#develop'
           url: ${{ secrets.SLACK_WEBHOOK }}
 
+      - name: Check if work properly
+        if: failure()
+        run: |
+          echo 'Slack failure notification succeeded'
+          exit 0
+
   cancel:
     # You have to cancel this job
     name: Works canceled
@@ -71,8 +77,29 @@ jobs:
         if: always()
         with:
           type: ${{ job.status }}
-          job_name: ':robot_face: *Check action*'
+          job_name: ':robot_face: *Cancel*'
           mention: 'here'
           mention_if: 'always'
           channel: '#develop'
-          url: ${{ secrets.SLACK_WEBHOOK }}
+          url: ${{ secrets.SLACK_WEBHOOK }}
+
+      - name: Check if work properly
+        if: cancelled()
+        run: |
+          echo 'Slack cancelled notification succeeded'
+          exit 0
+
+  commit:
+    name: Include commit data
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@master
+
+      - uses: ./
+        with:
+          type: ${{ job.status }}
+          job_name: ':robot_face: *Commit*'
+          channel: '#develop'
+          url: ${{ secrets.SLACK_WEBHOOK }}
+          commit: 'true'
+          token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/README.md b/README.md
@@ -31,11 +31,14 @@ You can customize the following parameters:
 |icon_emoji|optional|Use Slack Incoming Webhook configuration|Slack icon|
 |username|optional|Use Slack Incoming Webhook configuration|Slack username|
 |channel|optional|Use Slack Incoming Webhook configuration|Slack channel name|
+|commit|optional|false|If true, slack notification includes the latest commit message and author.|
+|token|case by case|N/A|This token is used to get commit data.<br>If commit parameter is true, this parameter is required.<br>${{ secrets.GITHUB_TOKEN }} is recommended.|
 
 Please refer `action.yml` for more details.
 
-## Example
-```..github/workflows/main.yml
+## Examples
+
+```..github/workflows/example1.yml
 - name: Slack Notification
   uses: homoluctus/slatify@master
   if: always()
@@ -48,9 +51,28 @@ Please refer `action.yml` for more details.
     url: ${{ secrets.SLACK_WEBHOOK }}
 ```
 
+↓ Including the latest commit data
+
+```..github/workflows/example2.yml
+- name: Slack Notification
+  uses: homoluctus/slatify@master
+  if: always()
+  with:
+    type: ${{ job.status }}
+    job_name: '*Lint Check*'
+    mention: 'here'
+    mention_if: 'failure'
+    channel: '#random'
+    url: ${{ secrets.SLACK_WEBHOOK }}
+    commit: true
+    token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+<img src="./images/slack2.png" alt="Notification Preview" width="90%">
+
 # Slack UI Example
 
-<img src="./images/slack.png" alt="Notification Preview" width="70%">
+<img src="./images/slack.png" alt="Notification Preview" width="90%">
 
 # Contribute
 1. Fork this repository

diff --git a/action.yml b/action.yml
@@ -26,6 +26,13 @@ inputs:
   url:
     description: 'slack incoming webhook url'
     required: false
+  commit:
+    description: 'whether include commit data or not (true or false)'
+    required: false
+    default: 'false'
+  token:
+    description: 'need to get commit data'
+    required: false
 runs:
   using: 'node12'
   main: 'dist/index.js'