Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/creisle/rocketchat_standup_bot
Standup Bot for use with Rocketchat
https://github.com/creisle/rocketchat_standup_bot
bot hubot rocketchat rocketchat-hubot
Last synced: 7 days ago
JSON representation
Standup Bot for use with Rocketchat
- Host: GitHub
- URL: https://github.com/creisle/rocketchat_standup_bot
- Owner: creisle
- License: mit
- Created: 2020-03-29T07:09:47.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T08:20:41.000Z (almost 2 years ago)
- Last Synced: 2023-08-19T06:10:31.221Z (about 1 year ago)
- Topics: bot, hubot, rocketchat, rocketchat-hubot
- Language: JavaScript
- Size: 106 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hubot-Rocketchat StandUp Bot
This was built from https://github.com/RocketChat/hubot-rocketchat-boilerplate
- [Using the Bot](#using-the-bot)
- [Create a StandUp](#create-a-standup)
- [Adding Members](#adding-members)
- [Scheduling the Reminder](#scheduling-the-reminder)
- [Install Instructions (Developers)](#install-instructions-developers)
- [Configuration](#configuration)
This bot adds a standup functionality to any rocketchat chat room. Stand ups are initiate and
members are pinged in direct messages to avoid spamming the channel. The
result is posted back to the stand up room channel
## Using the Bot
This bot adds up to 1 standup per chat room. If you want to use it with a private room you will
need to add the bot user to the room.
### Create a StandUp
In the room you want to run stand up from
```
bot show
```
This will show you the details of the current stanup in this room. If no one has joined the stand up
and it has not been scheduled it will look something like this
```
Current Standup Settings
Members:
Currently not scheduled
```
#### Adding Members
To join the stanup, each user must run the following in the room
```
bot join
```
They should see a reply like the following
```
Added USERNAME to the list of standup members
```
After each member joins they should open a conversation with the bot and send a private message to
ensure the channel is available for the bot to ping the user later
You can see the list of members joined by running the `bot show` command
#### Scheduling the Reminder
Stand up can be initiated manually from the room it is set in with
```
bot init
```
but it can also be scheduled to automate this process
```
bot sched
```
This will ask the user for days of the week and a time to run at. It will use
these to set the cron-job reminder
## Install Instructions (Developers)
```
git clone https://svn.bcgsc.ca/bitbucket/scm/dat/rocketchat_standup_bot.git
cd rocketchat_standup_bot
npm install
```
Create a _.env_ file with content:
```
export ROCKETCHAT_URL=myserver.com
export ROCKETCHAT_USER=mybotuser
export ROCKETCHAT_PASSWORD=mypassword
export ROCKETCHAT_ROOM=general
export ROCKETCHAT_USESSL=false
export RESPOND_TO_DM=true
export HUBOT_ADAPTER=rocketchat
export HUBOT_ALIAS=bot
```
Adjust the content to fit your server and user credentials. Make sure `myuser` has **BOT role** on the server, if you don't know what that means, ask your server administrator to set it up for you.
Then run the bot:
```
npm start
```
On the server, login as a regular user (not the BOT user), go to GENERAL, and try:
```
bot help
```
Which will show you the available commands
## Configuration
When running locally, we've used `dotenv` to load configs from the
`./.env` file. That makes it easy for setting environment variables.