Skip to content

Slack extension to export decision knowledge from Slack to Jira and to notify developers about recent decision knowledge

Notifications You must be signed in to change notification settings

cures-hub/cures-condec-slack

Repository files navigation

cures-condec-slack

Build Status Codacy BadgeCodecoverage GitHub contributors

The CURES ConDec Slack plug-in enables the user to export decision knowledge from Slack to JIRA. Decision knowledge covers knowledge about decisions, the problems they address, solution proposals, their context, and justifications (rationale).

Installation

Prerequisites

The following prerequisites are necessary to compile and run the plug-in from source code:

  • Node.js

Download of executable JavaScript source code

The executable JavaScript source code files for the latest release can be found here: https://github.com/cures-hub/cures-condec-slack/releases/latest

Creation of a Slack App

Before you can CURES ConDec Slack, you need to create a new Slack App:

  1. go to https://api.slack.com/apps and click on 'Create New App'
  2. give it a meaningful name and choose the workspace you want to install the App on
  3. on 'Basic Information' you can customize your App with a description and an App icon
  4. on 'Interactive Components', use the toggle to turn it on, put in the URL of your http-server followed by /slack/events
  5. on 'Bot Users' add a bot-user and give it an expressive name
  6. on 'Install App' install the App to your Slack workspace
  7. on 'OAuth & Permissions' add these Permission Scopes:
  • 'channels:write'
  • 'chat:write:bot'
  • 'chat:write:user'
  • 'emoji:read'
  • 'bot'
  • 'reactions:read'
  1. on 'Event Subscriptions' use the toggle to turn it on and put in the URL of your http-server followed by /slack/events
  2. subscribe to these bot-events:
  • 'app_mention'
  • 'channel_created'
  • 'member_joined_channel'
  • 'message.channels'
  • 'reaction_added'

Configuration of environment variables

Copy the content of the env-Template.txt file, create a new .env file and paste the copied content into it. You can find the Slack Signing Secret on your 'Basic Information' page and the Bot User Token on the 'OAuth & Permission' page. Use the port of your http-server. The Jira server and project key are default values that you can use for the export of decision knowledge from slack to your Jira project. Put in the Jira username and pw of your Jira account. When you have added all values to the variables save the .env file. Next Step is to install all needed dependencies:

npm install

Then you can run the code via:

node app

Configuration of Slack workspace

Before you can use all functionality of CURES ConDec Slack, you need to add these custom emojis to your Slack workspace:

  • :issue:
  • :decision:
  • :alternative:
  • :pro:
  • :con: You can use the custom icons from images. You can add the app to any channel of your Slack workspace via the settings of that channel.

About

Slack extension to export decision knowledge from Slack to Jira and to notify developers about recent decision knowledge

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published