README.md

Botkube Plugins

This repository contains additional Botkube plugins.

Requirements

• Go >= 1.21
• GoReleaser >= 1.21
• golangci-lint >= 1.55

Development

Prerequisite

• You are able to start the Botkube Agent.

Steps

1. Start the local plugins server to serve binaries from dist folder:

   make serve-local-plugins

   Tip If Botkube runs inside the k3d cluster, export the PLUGIN_SERVER_HOST=http://host.k3d.internal environment variable.

2. Export the Botkube plugins cache directory:

   export BOTKUBE_PLUGINS_CACHE__DIR="/tmp/plugins"

3. Add a additional-plugins entry for your Agent plugins repository:

   plugins:
     repositories:
       additional-plugins:
         url: http://localhost:3010/botkube.yaml

4. In another terminal window, run:

   # rebuild plugins only for the current GOOS and GOARCH
   make build-plugins-single &&
   # remove cached plugins
   rm -rf $BOTKUBE_PLUGINS_CACHE__DIR &&
   # start Botkube to download fresh plugins
   ./botkube-agent

   Each time you make a change to the source or executors plugins, rerun the above command.

   Tip To build specific plugin binaries, use PLUGIN_TARGETS. For example, PLUGIN_TARGETS="helm,argocd" make build-plugins-single.

Release

To release the plugins, follow the instructions in the Release document.