https://github.com/fshchudlo/merge-it-hot
Slack Bot that improves GitHub Pull Requests review experience by sending notifications to the Slack channels for the PR author and all the participants.
https://github.com/fshchudlo/merge-it-hot
codereview developer-experience devex github slack
Last synced: 5 months ago
JSON representation
Slack Bot that improves GitHub Pull Requests review experience by sending notifications to the Slack channels for the PR author and all the participants.
- Host: GitHub
- URL: https://github.com/fshchudlo/merge-it-hot
- Owner: fshchudlo
- License: mit
- Created: 2024-02-29T09:06:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-25T06:57:06.000Z (7 months ago)
- Last Synced: 2025-11-28T14:42:18.294Z (7 months ago)
- Topics: codereview, developer-experience, devex, github, slack
- Language: TypeScript
- Homepage: https://merge-it-hot.com/
- Size: 2.63 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# merge-it-hot
[Slack Bot](https://slack.dev/bolt-js/tutorial/getting-started) that keeps code review participants in the loop by
sending pull requests notifications to the Slack.
### Configuring dev environment
- Install [Node.js and npm](https://nodejs.org) on your machine
- Run `npm i` from the repo root directory
### Running unit tests
- Easy as ```npm run test```. Unit tests are not tied to Slack or GitHub, thus, you can run them in isolation.
- Since I'm a lazy guy, tests use snapshots. You can update them by running ```npm run test:update-snapshots```
### Running an app
- Create [your own Slack application](https://slack.dev/bolt-js/tutorial/getting-started#create-an-app)
and [obtain required tokens](https://tools.slack.dev/bolt-js/getting-started/#tokens-and-installing-apps) to the
project env variables
> 💡 You can use [slack_app_manifest.yml](assets/slack_app_manifest.yml) file as a basis to create an app and
> assign all the required oauth scopes.
- Run ```npm run docker:init``` to configure Postgres
- Open [merge-it-hot-compose.yml](assets/merge-it-hot-compose.yml) `environment` section and provide relevant tokens
- Run ```npm run docker:start``` to start an app in docker container
> 💡 If you'd like to run app locally, create the `.env` file in the project root directory and provide it with the
> values identical to [merge-it-hot-compose.yml](assets/merge-it-hot-compose.yml) `environment` section
> After that you can simply run an app with ```npm run start```
### Running e2e-tests with an app
- e2e tests will require real Slack and GitHub connections. Please refer to [Running an app](#running-an-app)
section above.
- e2e-tests are implemented with [HTTP Client CLI](https://www.jetbrains.com/help/idea/http-client-cli.html). Thus, it
should be installed.
- Fill `http-client.env.json` file with parameters you find relevant. If you want to use real data, consider creating
your own `http-client.private.env.json` config. It is already added to the `.gitignore`
- Run ```npm run docker:start``` or ```npm run start``` to start the service
- Run ```ijhttp .e2e-tests/e2e-test-requests.http``` from the project root directory.
### Deploying the service
- You can use provided `Dockerfile` to build an image and run it with ENV variables identical to variables
specified in `.env.example` described above
- Please, be aware that _service is stateful_ since it caches channels and comments info. State stored in memory (
see `InMemoryCache` class and its' usages), that keeps implementation simple and efficiently serves
hundreds of pull requests. In case of service restart, cache will be gracefully restored. However,
if you need to run multiple instances or experience `Slack API` requests limit exceeding, you'll need to implement
some external cache.
### Managing database structure
- This project uses [TypeORM](https://typeorm.io/migrations) for database migrations. After modifying the schema, you
can apply migrations using
```npm run migration:generate ./src/api-adapters/organization-settings-provider/migrations/```
- Migrations are automatically applied when the app starts, so no manual intervention is typically needed.
- You can manage migrations process on your own with `npm run migration:run` and `npm run migration:revert` commands.
### Useful links
- [Slack apps configuration page](https://api.slack.com/apps)
- [Slack blocks kit builder](https://app.slack.com/block-kit-builder)
and [full controls reference](https://api.slack.com/reference/block-kit/block-elements)