[skip ci] Update README.md

This commit is contained in:
Ole Morud
2023-05-16 15:50:59 +02:00
committed by GitHub
parent a6513910aa
commit bd96baa61f

View File

@@ -1,6 +1,11 @@
# Mattermost Coffee Bot
Pings a set of people when someone writes a message starting with a keyword.
![image](https://github.com/olemorud/mattermost-coffee-ping/assets/82065181/244fcc06-2c9c-4e5e-961a-d92a2f253178)
## Setup
These instructions have not been thoroughly tested, open an issue if something
@@ -10,14 +15,15 @@ does not work or is unclear.
Open the Channel you want the bot integration for in Mattermost.
On the top-left there is a waffle menu icon: (looks kind of like: ☷)
On the top-left there is a waffle menu icon: ![image](https://github.com/olemorud/mattermost-coffee-ping/assets/82065181/3ebe3023-9bac-4c4b-801a-209c37633cfe)
Open ** -> Integrations -> Outgoing Webhooks -> Add Outgoing Webhook**
Open **![image](https://github.com/olemorud/mattermost-coffee-ping/assets/82065181/7ba5a126-e138-472d-8820-9a77e2b63f7e) -> Integrations -> Outgoing Webhooks -> Add Outgoing Webhook**
Add required and optional fields as you wish, but leave the Callback URLs field
empty for now. When saved, a card with information containing a _Token_ should
be displayed. This will be used later.
### Setting up Google Cloud
#### Setting up the project
@@ -57,6 +63,7 @@ Open **Google Cloud -> Security -> Secret Manager** ([link](https://console.clou
with appropriate values.
### GitHub repository setup
#### Adding secrets
@@ -76,6 +83,7 @@ add the following repository secrets:
Open **Actions -> Deploy Google Cloud Function** and press **Run workflow**.
Deploying a function usually takes a around 5 minutes.
### Verify and final fixes
Open **Google Cloud -> Cloud Functions** [link](https://console.cloud.google.com/functions/list)