standup-bot

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 6, 2022 License: MPL-2.0 Imports: 1 Imported by: 0

README

Description

This is a simple standup bot for slack.

Setup

  1. Create standup bot with app-manifest.yaml file provided in the root of this directory
  2. Get bot and bot user tokens and set environment variables defined in lib/config/main.go
  3. Set up s3 bucket and provide AWS Creds if you would like standup settings to persists between restarts

Docker

# quickstart
docker run \
    -e SLACK_BOT_TOKEN=xoxb-blahblah \
    -e SLACK_APP_TOKEN=xapp-blahblah \
    -t justmiles/standup-bot

# with persistant brain
docker run \
    -e SLACK_BOT_TOKEN=xoxb-blahblah \
    -e SLACK_APP_TOKEN=xapp-blahblah \
    -e S3_BRAIN_BUCKET=some_s3_bucket \
    -e S3_BRAIN_KEY=brain.json \
    -e AWS_REGION \
	-e AWS_ACCESS_KEY_ID \
	-e AWS_SECRET_ACCESS_KEY \
	-e AWS_SESSION_TOKEN \
    -t justmiles/standup-bot

Configure your bot

In slack just type /standup

Test your bot

In a channel type the below commands - this will create a mock standup with you as the sole participant. /standup solicit /standup share

Users in multiple standups Scenarios

If User recieves a standup solicitation from multiple channel configurations at the same time, then:

  • If User replies as normal, then both standups will receive the same notes.
  • If user replies in thread, then only the thread response will be used for the standup notes.

Roadmap

  • Provide terraform module for quick setup in fargate
  • Update readme with a "how to"

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
lib

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL