Skip to content

Commit 562be09

Browse files
jfkonecnzhx828calvinlu3
authored
Added testing slack section in the README (#1116)
* Added testing slack section in the README * Update README.md Co-authored-by: Calvin Lu <[email protected]> * Addressed PR Comments --------- Co-authored-by: Hongxin <[email protected]> Co-authored-by: Calvin Lu <[email protected]>
1 parent bf11bc6 commit 562be09

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

+35
Original file line numberDiff line numberDiff line change
@@ -223,3 +223,38 @@ For more information refer to [Using Docker and Docker-Compose][], this page als
223223
[definitelytyped]: https://definitelytyped.org/
224224
[puppeteer]: https://developers.google.com/web/tools/puppeteer
225225
[cdp]: https://chromedevtools.github.io/devtools-protocol/
226+
227+
## Testing Slack Integration
228+
229+
1. Ensure you can access the MSK secret server
230+
2. Ensure you can access the [Slack API Manager](https://api.slack.com/apps/AQC1QUJQK/interactive-messages)
231+
3. Install [ngrok](https://ngrok.com/download)
232+
4. Update the `/src/main/resources/config/application-dev.yml` file
233+
234+
- Change `spring.mail.username` to [email protected]
235+
- Change `spring.mail.password` to the password for [email protected] found in the secret server
236+
- Change `application.slack.user-registration-webhook` to the slack hook.
237+
- Change `application.slack.slack-base-url` to https://oncokb.slack.com
238+
- Change `application.slack.user-registration-channel-id` to C03EASPQ8AZ
239+
- If you need to use a slack endpoint that requires a token, update
240+
`application.slack.slack-bot-oauth-token` with the token get from this [page](https://api.slack.com/apps/AQC1QUJQK/oauth).
241+
242+
5. Start up ngrok
243+
244+
```sh
245+
ngrok http http://localhost:9090
246+
```
247+
248+
6. Copy the forwarding URL generated by ngrok.
249+
250+
- Should be something like https://xxxx-xxx-xxx-xx-xx.ngrok-free.app
251+
252+
7. Update the Request URL in the slack message configuration [in the Request URL](https://api.slack.com/apps/AQC1QUJQK/interactive-messages) to https://xxxx-xxx-xxx-xx-xx.ngrok-free.app/api/slack
253+
254+
- Replace the base URL with the URL generated by ngrok for forwarding
255+
256+
8. Register an account in your local instance of OncoKB public
257+
258+
- Ensure the email you use is one you have access to
259+
260+
9. Check the slack-app-dev channel for a message and approve it

0 commit comments

Comments
 (0)