Mention author in summary message #55
Conversation
| */ | ||
| async getRealUsers(): Promise<Member[] | null> { | ||
| try { | ||
| const {members} = await this.web.users.list() |
There was a problem hiding this comment.
This API method falls under Tier 2 rate limiting:
Most methods allow at least 20 requests per minute, while allowing for occasional bursts of more requests.
The Node.js Slack SDK retries such errors by default, which seems useful at the expense of increasing the GitHub workflow step duration. Probably something to keep an eye on.
| const matchingSlackUsers = slackUsers.filter( | ||
| (user): user is MemberWithProfile => { | ||
| return Boolean( | ||
| user.profile?.real_name === githubUser.name && |
There was a problem hiding this comment.
Both GitHub and Slack email APIs are separately restrictive, so I didn't want to go down that path. If we find this (naive) algorithm to be problematic, we could consider introducing some optional JSON environment variable that maps GitHub usernames to Slack member IDs (which we would have to maintain).
There was a problem hiding this comment.
Yeah, I think we go with this and only start maintaining some GitHub->Slack KV structure if we have to.
| warning( | ||
| `Slack API call failed due to rate limiting. Retrying in ${numSeconds} seconds.` | ||
| ) |
There was a problem hiding this comment.
The Slack Node.js SDK will also log to the console, but this will notably get surfaced in the run summary, i.e.
|
[sc-21819] |
|
This pull request has been linked to Shortcut Story #21819: Mention Slack user in deploy notifications. |
…ine into mention * 'main' of github.com:namoscato/action-slack-deploy-pipeline: Bump json5 from 1.0.1 to 1.0.2 (#67) Bump @vercel/ncc from 0.34.0 to 0.36.1 (#66) Bump prettier from 2.7.1 to 2.8.7 (#65) Bump @slack/web-api from 6.7.2 to 6.8.1 (#64) Bump typescript from 4.8.4 to 5.0.4 (#61) Bump @actions/github from 5.0.3 to 5.1.1 (#60) Bump eslint-plugin-jest from 27.1.3 to 27.2.1 (#62) Bump @types/node from 16.11.56 to 16.18.23 (#63) Bump eslint from 8.23.0 to 8.38.0 (#59) Bump eslint-plugin-github from 4.3.7 to 4.7.0 (#58) Bump @typescript-eslint/parser from 5.40.1 to 5.57.1 (#57) Bump @octokit/webhooks-types from 6.3.6 to 6.11.0 (#56)
Resolves #41
Summary
getMessageAuthor, attempting to match GitHub user to Slack user by full namepackagescript intobuildEnvironmentVariableenumRelease Notes
v1.3.0attempts to match a Slack workspace user to the GitHub commit author by full name. When found, the Slack user is mentioned in the initial summary message, conventionally notifying them of all subsequent deploy messages in the thread:This feature requires the Slack API
users:readOAuth Scope which can be added to your Slack app under OAuth & Permissions. If the scope is missing or the user cannot be matched, the action will fallback to the GitHub username and avatar as before.