@balena/jellyfish-plugin-flowdock

Flowdock Jellyfish Plugin

Usage no npm install needed!

<script type="module">
  import balenaJellyfishPluginFlowdock from 'https://cdn.skypack.dev/@balena/jellyfish-plugin-flowdock';
</script>

README

Jellyfish Flowdock Plugin

Provides a sync integration for Flowdock.

Usage

Below is an example how to use this library:

import { cardMixins } from '@balena/jellyfish-core';
import { FlowdockPlugin } from '@balena/jellyfish-plugin-flowdock';

const plugin = new FlowdockPlugin();

// Load cards from this plugin, can use custom mixins
const cards = plugin.getCards(context, cardMixins);
console.dir(cards);

Documentation

Publish Documentation

Visit the website for complete documentation: https://product-os.github.io/jellyfish-plugin-flowdock

Testing

Unit tests can be easily run with the command npm test.

The integration tests require Postgres and Redis instances. The simplest way to run the tests locally is with docker-compose.

$ git secret reveal
$ npm run test:compose

You can also run tests locally against Postgres and Redis instances running in docker-compose:

$ git secret reveal
$ npm run compose
$ export INTEGRATION_FLOWDOCK_TOKEN=$(cat .balena/secrets/integration_flowdock_token)
$ export INTEGRATION_FLOWDOCK_SIGNATURE_KEY=$(cat .balena/secrets/integration_flowdock_signature_key)
$ REDIS_HOST=localhost POSTGRES_HOST=localhost npx jest test/integration/flowdock-translate.spec.ts

You can also access these Postgres and Redis instances:

$ PGPASSWORD=docker psql -hlocalhost -Udocker
$ redis-cli -h localhost