devbotreviewers

README

Reviewers list event

The event which can help to understand which reviewers are available in the memory of the devbot.

Installation guide

Go to devbot project directory and run the next in CMD:

git clone git@github.com:sharovik/devbot-reviewers.git events/devbotreviewers

Then open the defined-events.go file and add there event

package events

import (
//...
	"github.com/sharovik/devbot/events/devbotreviewers"
//...
)

//DefinedEvents collects all the events which can be triggered by the messages
var DefinedEvents = base.Events{}

func init() {
	DefinedEvents.Events = make(map[string]base.Event)
//...
	DefinedEvents.Events[devbotreviewers.EventName] = devbotreviewers.Event
//...
}

After that, to install the event please run

make install

Usage

Write in PM or tag the bot user in the channel with this message

show reviewers

As the result you will see the list of available bitbucket reviewers. These reviewers bot will use during the pull-request validation and creation.

Documentation

Index

• Constants
• Variables
• type EventStruct
  • func (e EventStruct) Execute(message dto.BaseChatMessage) (dto.BaseChatMessage, error)
  • func (e EventStruct) Install() error
  • func (e EventStruct) Update() error

Constants

const (
	//EventName the name of the event
	EventName = "devbotreviewers"

	//EventVersion the version of the event
	EventVersion = "1.0.0"
)

Variables

var Event = EventStruct{
	EventName: EventName,
}

Event - object which is ready to use

Types

type EventStruct

type EventStruct struct {
	EventName string
}

EventStruct the struct for the event object. It will be used for initialisation of the event in defined-events.go file.

func (EventStruct) Execute

func (e EventStruct) Execute(message dto.BaseChatMessage) (dto.BaseChatMessage, error)

Execute method which is called by message processor

func (EventStruct) Install

func (e EventStruct) Install() error

Install method for installation of event

func (EventStruct) Update

func (e EventStruct) Update() error

Update for event update actions