Mention author in summary message (#55)

Author: namoscato

.eslintrc.json

@@ -36,7 +36,7 @@
     "semi": "off",
     "@typescript-eslint/semi": ["error", "never"],
     "@typescript-eslint/type-annotation-spacing": "error",
-    "filenames/match-regex": ["error", "^[a-z0-9-]+(.d|.config|.test)?$"]
+    "filenames/match-regex": "off"
   },
   "env": {
     "node": true,

.github/workflows/check-dist.yml

@@ -32,9 +32,7 @@ jobs:
         run: npm ci
 
       - name: Rebuild the dist/ directory
-        run: |
-          npm run build
-          npm run package
+        run: npm run build
 
       - name: Compare the expected and actual dist/ directories
         run: |

.vscode/settings.json

@@ -1,5 +1,11 @@
 {
-  "cSpell.words": ["endregion", "Fieldguide", "mrkdwn", "namoscato"],
+  "cSpell.words": [
+    "endregion",
+    "Fieldguide",
+    "mrkdwn",
+    "namoscato",
+    "USLACKBOT"
+  ],
   "files.exclude": {
     "dist": true,
     "lib": true

README.md

@@ -6,24 +6,26 @@ Post [GitHub Action](https://github.com/features/actions) deploy workflow progre
 
 <br />
 
-<img width="482" alt="Slack Deploy Pipeline Notifications example thread" src="https://user-images.githubusercontent.com/847532/196043237-bf16fcf7-ff45-443b-a3b2-ec3d51f17ee5.jpg">
+<img width="524" alt="Slack Deploy Pipeline Notifications example thread" src="https://user-images.githubusercontent.com/847532/230737887-1d18a062-af7f-4c7f-a78c-e604fc9803c2.jpg">
 
 ## Features
 
 - Posts summary message at beginning of the deploy workflow, surfacing commit message and author
+- Maps GitHub commit author to Slack user by full name, mentioning them in the summary message
 - Threads intermediate stage completions, sending unexpected failures back to the channel
 - Updates summary message duration at conclusion of the workflow
-- Supports `pull_request`, `push`, and `schedule` [event types](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows)
+- Supports `pull_request`, `push`, `schedule`, and `workflow_dispatch` [event types](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows)
 
 ## Setup
 
 1. [Create a Slack App](https://api.slack.com/apps) for your workspace
 1. Under **OAuth & Permissions**, add two Bot Token Scopes:
    1. [`chat:write`](https://api.slack.com/scopes/chat:write) to post messages
-   1. [`chat:write.customize`](https://api.slack.com/scopes/chat:write.customize) to customize messages with GitHub username and avatar
+   1. [`chat:write.customize`](https://api.slack.com/scopes/chat:write.customize) to customize messages with GitHub commit author
+   1. [`users:read`](https://api.slack.com/scopes/users:read) to map GitHub user to Slack user
 1. Install the app to your workspace
 1. Copy the app's **Bot User OAuth Token** from the **OAuth & Permissions** page
-1. [Create a GitHub repository secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with this token, named `SLACK_DEPLOY_BOT_TOKEN`
+1. [Create a GitHub secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets) with this token, named `SLACK_DEPLOY_BOT_TOKEN`
 1. Invite the bot user into the Slack channel you will post messages to (`/invite @bot_user_name`)
 1. Click the Slack channel name in the header, and copy its **Channel ID** from the bottom of the dialog