https://github.com/klothoplatform/slack-notifier
Slack notification bot
https://github.com/klothoplatform/slack-notifier
Last synced: 2 months ago
JSON representation
Slack notification bot
- Host: GitHub
- URL: https://github.com/klothoplatform/slack-notifier
- Owner: klothoplatform
- License: mit
- Created: 2022-08-17T19:07:50.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-07T20:17:02.000Z (about 3 years ago)
- Last Synced: 2025-01-16T06:58:18.257Z (over 1 year ago)
- Language: TypeScript
- Size: 222 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Klotho slack-notifier bot
A GitHub → Slack notification bot that emphasizes a signal-to-noise ratio. Our bot posts pull request notifications in a thread (one thread per pull request) to keep the chatter down and let you actually keep track of what's going on.
To get up and running quickly, see our [installation tutorial][tutorial].
# Building and deploying
### Requirements
- [Klotho CLI](https://klo.dev/docs/tutorials/built_with_klotho/slackbot)
- Node.js 14.x+ (& NPM)
### Building
```bash
npm run klotho build
```
This will compile the TypeScript, run the tests, and run Klotho on the application.
### Deploying
1. Just once, run:
```bash
npm run klotho pulumi config set aws:region # e.g. us-east-1
```
2. Make sure you have your env set up with AWS credentials (see [our tutorial][tutorial-aws].
3. ```bash
npm run klotho pulumi up
```
### Different application names
By default, the Klotho application name (`klotho --app ...`) is `klotho-slack-notifier-bot`, and Klotho will compile to a directory `./compiled`.
To change this, set an env variable `KLOTHO_APP_NAME`. If you do, the application name will be what you set in that variable, and Klotho will compile to `./compiled-klotho/$KLOTHO_APP_NAME`.
# Contributing
We welcome pull requests, or you can open an issue to provide feedback or make a suggestion. You can also find us at our [Discord server](https://klo.dev/discordurl).
We don't have any formal contribution requirements or style guides yet for pull requests. Please:
* format your code reasonably
* add unit tests if reasonable
[tutorial]: https://klo.dev/docs/tutorials/slackbot
[tutorial-aws]: http://klo.dev/docs/tutorials/built_with_klotho/slackbot#prerequisites