feat: add notify-about-build-failure GHA (#211)

Author: sashuk

.changeset/little-cows-tap.md

@@ -0,0 +1,5 @@
+---
+'davinci-github-actions': minor
+---
+
+- add notify-about-build-failure action. It sends notifications about build failure to specified Slack channel and private Slack messages of failing commit author

.lintstagedrc.js

@@ -1,3 +1,5 @@
+const buildTargets = ['create-matrix', 'get-changeset-info', 'report-missing-changeset', 'notify-about-build-failure']
+
 module.exports = {
   '{**/*.{js,jsx,ts,tsx},.changeset/*.md}': [
     'davinci-syntax lint code',
@@ -7,16 +9,12 @@ module.exports = {
     paths.length > 0
       ? ['yarn documentation:generate', `git add */README.md`]
       : [],
-  'create-matrix/**/*.js': () => [
-    'yarn build:create-matrix',
-    'git add create-matrix/dist',
-  ],
-  'get-changeset-info/**/*.js': () => [
-    'yarn build:get-changeset-info',
-    'git add get-changeset-info/dist',
-  ],
-  'report-missing-changeset/**/*.js': () => [
-    'yarn build:report-missing-changeset',
-    'git add report-missing-changeset/dist',
-  ],
+  ...(buildTargets.reduce((acc, target) => {
+    acc[`${target}/**/*.js`] = () => [
+      `yarn ncc build ${target}/index.js -o ${target}/dist`,
+      `git add ${target}/dist`,
+    ]
+
+    return acc
+  }, {}))
 }

notify-about-build-failure/README.md

@@ -0,0 +1,45 @@
+## Notify about build failure
+
+Sends notifications about build failure to specified Slack channel and private Slack messages of failing commit author
+
+### Description
+
+Sends notification about build failure to specified Slack channel and direct Slack messages of failing commit author. In order to match GitHub name of commit authors and their Slack handles, the TopTeam API is used.
+
+### Inputs
+
+The list of arguments, that are used in GH Action:
+
+| name                        | type   | required | default | description                                                                                                                                |
+| --------------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| `slack-bot-token`           | string | ✅        |         | Slack API token, needed for sending messages in Slack                                                                                      |
+| `top-team-api-key`          | string | ✅        |         | TopTeam API key, needed for fetching Company structure to match GitHub name of commit author to Slack handle                               |
+| `slack-channel-name`        | string | ✅        |         | Slack channel name (for example, `#-test-channel`)                                                                                         |
+| `github-commit-author-name` | string | ✅        |         | GitHub name of commit author, needed for finding the Slack handle of commit author                                                         |
+| `github-action-run-url`     | string | ✅        |         | Failing GitHub Acton run URL (for example, `https://github.com/toptal/staff-portal/actions/runs/123`), needed for the notification message |
+
+### Outputs
+
+Not specified
+
+### ENV Variables
+
+Not specified
+
+### Usage
+
+GitHub Actions Notifications bot will send message to commit author and post a message in #-test-notifications-channel channel in Slack. The message will contain URL for the failing GitHub Action job run.
+
+```yaml
+jobs:
+  notify-build-breaker:
+    name: Notify about build failure
+    steps:
+      - uses: toptal/davinci-github-actions/notify-about-build-failure@master
+        with:
+          slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
+          top-team-api-key: ${{ secrets.TOP_TEAM_API_KEY }}
+          slack-channel-name: '#-test-notifications-channel'
+          github-commit-author-name: ${{ github.event.pusher.name }}
+          github-action-run-url: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
+```

notify-about-build-failure/action.yml

@@ -0,0 +1,22 @@
+name: Notify about build failure
+description: Sends notifications about build failure to specified Slack channel and private Slack messages of failing commit author
+inputs:
+  slack-bot-token:
+    description: Slack API token, needed for sending messages in Slack
+    required: true
+  top-team-api-key:
+    description: TopTeam API key, needed for fetching Company structure to match GitHub name of commit author to Slack handle
+    required: true
+  slack-channel-name:
+    description: Slack channel name (for example, `#-test-channel`)
+    required: true
+  github-commit-author-name:
+    description: GitHub name of commit author, needed for finding the Slack handle of commit author
+    required: true
+  github-action-run-url:
+    description: Failing GitHub Acton run URL (for example, `https://github.com/toptal/staff-portal/actions/runs/123`), needed for the notification message
+    required: true
+  
+runs:
+  using: node20
+  main: ./dist/index.js