Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/int128/jira-to-slack
Slack / Mattermost Integration to notify JIRA events
https://github.com/int128/jira-to-slack
appengine golang jira kubernetes mattermost slack
Last synced: 4 months ago
JSON representation
Slack / Mattermost Integration to notify JIRA events
- Host: GitHub
- URL: https://github.com/int128/jira-to-slack
- Owner: int128
- License: apache-2.0
- Created: 2018-01-26T08:33:39.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-29T04:09:47.000Z (over 3 years ago)
- Last Synced: 2024-06-19T02:11:04.435Z (7 months ago)
- Topics: appengine, golang, jira, kubernetes, mattermost, slack
- Language: Go
- Homepage: https://jira-to-slack-4fz6yhbo6a-uc.a.run.app
- Size: 147 KB
- Stars: 9
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jira-to-slack [](https://github.com/int128/jira-to-slack/actions/workflows/go.yaml)
This is a chat integration to notify Jira events.
Supported chat platforms:
- Slack
- Mattermost
Supported runtime:
- Standalone binary
- Docker
- Kubernetes
- Google Cloud Run
- Google App Engine
- AWS Lambda
## Examples
### Slack
### Mattermost
## Getting Started
### 1. Setup Slack/Mattermost
Create an Incoming Webhook on your [Slack](https://my.slack.com/services/new/incoming-webhook) or [Mattermost](https://docs.mattermost.com/developer/webhooks-incoming.html).
### 2. Setup Jira
Create a [Webhook](https://developer.atlassian.com/server/jira/platform/webhooks/) on your Jira cloud or server.
Set the URL of the Webhook as follows:
```
https://jira-to-slack-4fz6yhbo6a-uc.a.run.app/?webhook=https://hooks.slack.com/YOUR_HOOK
```
You can add the following query parameters:
Name | Value | Default | Example
-----|-------|---------|--------
`webhook` | Slack/Mattermost Webhook URL | Mandatory | `https://hooks.slack.com/YOUR_HOOK`
`username` | BOT username | - | `JIRA`
`channel` | Channel to show messages at | - | `some-public-channel`
`icon` | BOT icon emoji or URL | - | `:speech_baloon:` or `https://.../jira.png`
`dialect` | API dialect | `slack` | `slack` or `mattermost`
`debug` | Dump Jira and Slack messages to console | `0` | `0` or `1`
For example,
You can deploy jira-to-slack to your server as well.
See the later section for details.
### 3. Test notification
Create a ticket on your Jira and a message will be sent to your Slack/Mattermost.
You can turn on debug logs by setting the query parameter `debug=1`.
## Deploy to your server
### Standalone
Download the latest release and run the command:
```sh
./jira-to-slack
```
It binds port 3000 by default.
You can set the port by `PORT` environment variable.
```sh
PORT=8080 ./jira-to-slack
```
### Docker / Docker Compose
You can deploy the image [`ghcr.io/int128/jira-to-slack`](https://ghcr.io/int128/jira-to-slack).
```sh
docker run --rm -p 3000:3000 ghcr.io/int128/jira-to-slack:v1.10.0
```
As well as you use Docker Compose.
```yaml
services:
jira-to-slack:
image: ghcr.io/int128/jira-to-slack:v1.10.0
# Expose host port 8080
ports: "8080:3000"
```
### Kubernetes
Deploy the manifests in the [`kubernetes`](kubernetes/) folder.
```sh
kubectl -k kubernetes/
```
You can expose the service via an [Ingress](kubernetes/ingress.yaml).
### Google Cloud Run
You can deploy the image [`gcr.io/jira-to-slack/jira-to-slack`](https://gcr.io/jira-to-slack/jira-to-slack) to the Google Cloud Run.
Click the button to deploy the image to the Google Cloud Run.
[](https://console.cloud.google.com/cloudshell/editor?shellonly=true&cloudshell_image=gcr.io/jira-to-slack/jira-to-slack&cloudshell_git_repo=https://github.com/int128/jira-to-slack.git)
### Google App Engine
You can deploy the application to Google App Engine.
```sh
# Install SDK
brew cask install google-cloud-sdk
gcloud components install app-engine-go
# Run locally
make -C appengine run
# Deploy to cloud
gcloud app deploy --project=jira-to-slack appengine/app.yaml
```
### AWS Lambda
You can deploy the application to AWS Lambda.
```sh
# Run locally
make -C lambda run
# Deploy to cloud
make -C lambda deploy SAM_S3_BUCKET_NAME=YOUR_BUCKET_NAME
```
You need to create a S3 bucket in the same region before deploying.
## How it works
It sends a message to the channel on the following triggers:
- User created an issue.
- User commented to an issue.
- User assigned an issue.
- User updated summary or description of an issue.
- User deleted an issue.
If an issue or comment has mentions (Slack style `@foo` or JIRA style `[~foo]`), they will be converted to the chat platform specific format.
## Other solutions
[JIRA Mattermost Webhook Bridge](https://github.com/vrenjith/jira-matter-bridge). Great work. This is almost perfect but notifies many events so it may be noisy.
[Mattermost official JIRA Webhook Plugin](https://docs.mattermost.com/integrations/jira.html). This is still beta and in progress. Currently this does not notify comment.
## Contribution
This is an open source software licensed under Apache License 2.0.
Feel free to open your issues or pull requests.
### Development
Start the server:
```sh
make
./jira-to-slack
```
### E2E Test
You can send actual payloads of actual Jira events by the following script:
```sh
# Slack
SLACK_WEBHOOK="https://hooks.slack.com/xxx&username=JIRA&icon=https://lh3.googleusercontent.com/GkgChJMixx9JAmoUi1majtfpjg1Ra86gZR0GCehJfVcOGQI7Ict_TVafXCtJniVn3R0" ./pkg/formatter/testdata/post_jira_events.sh
# Mattermost
SLACK_WEBHOOK="https://mattermost.example.com/hooks/xxx&username=JIRA&icon=https://lh3.googleusercontent.com/GkgChJMixx9JAmoUi1majtfpjg1Ra86gZR0GCehJfVcOGQI7Ict_TVafXCtJniVn3R0&dialect=mattermost" ./pkg/formatter/testdata/post_jira_events.sh
```