https://github.com/senora-dev/self-service-slack-bot-blueprint
A Slack bot that enables self-service actions using AWS services. Easily extendable—just add an action folder with a modal.json (form UI) and buildspec.yaml (backend execution). 🚀
https://github.com/senora-dev/self-service-slack-bot-blueprint
bot developerexperience devex platform platformengineering self-service serverless slack slackbot
Last synced: 8 months ago
JSON representation
A Slack bot that enables self-service actions using AWS services. Easily extendable—just add an action folder with a modal.json (form UI) and buildspec.yaml (backend execution). 🚀
- Host: GitHub
- URL: https://github.com/senora-dev/self-service-slack-bot-blueprint
- Owner: Senora-dev
- Created: 2025-02-11T10:15:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-16T08:15:13.000Z (over 1 year ago)
- Last Synced: 2025-02-16T09:19:55.847Z (over 1 year ago)
- Topics: bot, developerexperience, devex, platform, platformengineering, self-service, serverless, slack, slackbot
- Language: Python
- Homepage: https://Senora.dev
- Size: 106 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🤖 Self-Service Slack Bot Blueprint
This project enables you to create and extend a Slack bot with custom actions using AWS services.
It allows you to add actions easily by simply creating a folder in the `actions` directory.
Each action folder includes:
- `modal.json` → Defines the form displayed to users.
- `buildspec.yaml` → Defines the backend commands executed by AWS CodeBuild.
---
## 📁 Project Structure
This project consists of three main components:
### 1. `bot/`
- Contains the Python source code for the Slack bot.
- Includes `template.yaml` for deployment.
- Reads configurations from the `actions/` folder to present actions to users.
### 2. `runners/`
- Contains Terraform code to create AWS CodeBuild projects for each action.
- Each project corresponds to an action and executes the respective `buildspec.yaml`.
### 3. `bot/src/slack_bot/actions/`
- Contains individual action folders.
- Each action folder must include:
- `modal.json` – Defines the Slack modal UI.
- `buildspec.yaml` – Defines the backend execution logic.
---
## ✨ How to Add a New Action
1. **Create an Action Folder**
- Under `bot/src/slack_bot/actions/`, create a new folder (action name should be without spaces).
- This name will be used for:
- The AWS CodeBuild project.
- The corresponding action in the Slack bot.
2. **Define `modal.json`**
- Use the [Slack Block Kit Builder](https://api.slack.com/tools/block-kit-builder) to create the modal UI.
- Save the JSON structure in `modal.json` inside the action folder.
3. **Define `buildspec.yaml`**
- This file contains the commands executed by AWS CodeBuild.
- Define automation logic such as provisioning resources, executing scripts, or running other tasks.
---
## ⚙️ How the Bot Works
1. The bot presents a list of available actions based on the folders in the `actions/` directory.
2. When a user selects an action, the corresponding `modal.json` is displayed.
3. After submission, the bot triggers the AWS CodeBuild project defined in `buildspec.yaml`.
### 🔧 Customizing Actions
- Modify `modal.json` to change the form fields.
- Update `buildspec.yaml` to adjust the backend logic.
For more details on modals, check the [Slack Block Kit Builder](https://app.slack.com/block-kit-builder).
---
## 📦 Deployment
1. Run the following command to deploy the bot and infrastructure:
```sh
make all
```
This command will:
- Deploy the CloudFormation stack (including the bot function and notifier function).
- Create the AWS CodeBuild projects ("Runners") using Terraform.
2. Set the API Gateway URL in the [Slash Command URL](https://api.slack.com/apps/A08769JU3HB/slash-commands?) & [Interactivity Request URL](https://api.slack.com/apps/A08769JU3HB/interactive-messages?) fields in the Slack App management console.
3. Fill the secret that has been created (```/${BotName}/slack-secret-token```) with the value:
```json
{
"slack_signing_secret":"[PUT_HERE_SECRET]",
"slack_bot_token":"[PUT_HERE_TOKEN]"
}
```
---
## 🤝 Contributing
Contributions are welcome!
Fork the repository and submit a pull request with bug fixes, improvements, or new features.
For more details, reach out to the repository owner.
Visit [Senora.dev](https://Senora.dev)💜 for more platform-related services.