https://github.com/ryotarai/slack-github-issues

Create GitHub issues via Slack Slash Command
https://github.com/ryotarai/slack-github-issues

Last synced: 21 days ago
JSON representation

Create GitHub issues via Slack Slash Command

• Host: GitHub
• URL: https://github.com/ryotarai/slack-github-issues
• Owner: ryotarai
• Created: 2020-06-15T14:39:12.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T19:09:29.000Z (almost 2 years ago)
• Last Synced: 2024-10-19T12:57:17.105Z (2 months ago)
• Language: TypeScript
• Size: 1.29 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# slack-github-issues

[![Docker Repository on Quay](https://quay.io/repository/ryotarai/slack-github-issues/status "Docker Repository on Quay")](https://quay.io/repository/ryotarai/slack-github-issues)

Create GitHub issues via Slack Slash Command

## How it works

### Inline

If Slash Command is called with text, GitHub issue will be created with the text.

e.g.

```

> /ask Something is wrong with my computer

< Opened https://github.com/org/repo/issues/1

```

### Modal dialog

If Slash Command is called without any text, a modal dialog appears:

![](doc/modal.png)

## Installation

In this instruction, assuming Slash Command name is `/ask` and this app is accessible as https://yourapp.example.com

### 1. Create a Slack App

1. Go to https://api.slack.com/apps and create a new app

1. Go to "Basic Information" page and get "Signing Secret"

1. Go to "OAuth & Permissions" page, add `chat:write` and `commands` to "Bot Token Scopes"

1. Install the App and get "Bot User OAuth Access Token".

1. Go to "Slash Commands" page and add `/ask` command with request URL `https://yourapp.example.com/slack/events`

1. Go to "Interactivity & Shortcuts" page, enable "Interactivity" and put `https://yourapp.example.com/slack/events` into Request URL

### 2. Deploy this app

Create a config file as follows:

```json

{

    "listeners": [

        {

            "commandName": "ask",

            "owner": "org",

            "repo": "repo",

            "labels": ["ask"],

            "modalTitle": "Ask me anything",

            "modalDescription": "Ask me anything :innocent:",

            "modalSubmissionMessage": "Thank you for submission :+1:"

        }

    ]

}

```

Deploy `quay.io/ryotarai/slack-github-issues` image with the following environment variables:

(Make sure this app is internet-accessible because Slack needs to send requests)

* `GITHUB_TOKEN`: GitHub Personal Access Token

* `SLACK_BOT_TOKEN`: "Bot User OAuth Access Token" from Slack App page

* `SLACK_SIGNING_SECRET`: "Signing Secret" from Slack App page

* `GITHUB_SLACK_CONFIG`: Path to config file

* `GITHUB_BASE_URL`: (Optional) If you are GitHub Enterprise user, set this to `https://ghe.example.com/api/v3`