README.md

Probot extensions

by Operate First

This is a collection of extensions to Probot. For details see individual packages

Package	Documentation	Tags
@operate-first/probot-kubernetes
@operate-first/probot-metrics
@operate-first/probot-issue-form

Development

We use NPM workspaces to manage this monorepo.

Build all packages

npm run build --workspaces

Link packages for local development

1. Go to the local package folder (let's say probot-metrics package) and advertize this package to NPM as linkable:

   pushd packages/probot-metrics
   npm link
   popd

2. Go to your project folder (e.g. peribolos-as-a-service and tell NPM to link the package in here:

   pushd ../peribolos-as-a-service
   npm link @operate-first/probot-metrics
   popd

To reverse this setup and restore using default packages from the registry use npm unlink as follows:

1. Go to your project folder (e.g. peribolos-as-a-service and tell NPM to unlink the package:

   pushd ../peribolos-as-a-service
   npm unlink --no-save @operate-first/probot-metrics
   popd

2. Additionally you can also remove the package from a global list of linkable packages by running:

   pushd packages/probot-metrics
   npm unlink
   popd