https://github.com/serokell/hermetic
Slack bot that links to YouTrack issues
https://github.com/serokell/hermetic
elixir slack-bot youtrack
Last synced: 5 months ago
JSON representation
Slack bot that links to YouTrack issues
- Host: GitHub
- URL: https://github.com/serokell/hermetic
- Owner: serokell
- License: agpl-3.0
- Created: 2018-07-18T21:23:59.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-18T14:40:00.000Z (over 1 year ago)
- Last Synced: 2025-05-08T01:47:57.069Z (5 months ago)
- Topics: elixir, slack-bot, youtrack
- Language: Elixir
- Homepage:
- Size: 164 KB
- Stars: 5
- Watchers: 21
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: COPYING.md
Awesome Lists containing this project
README
# Hermetic
Hermetic is a Slack bot for YouTrack integration. It has the following features:
- Reply with an issue overview attachment whenever an issue code is mentioned.
- Add a new YouTrack issue right from the chat.
- Run an arbitrary YouTrack command on an issue right from the chat.
## Build instructions
Run `nix-shell` in the root of the repo to pull in elixir. Run `mix deps.get` to
pull in dependencies and install hex if asked. Run `iex -S mix` to get a repl,
`mix test` to check no tests are breaking and `mix dialyzer` to do type
checking. The last one takes a while on the first run.
## Usage
### Adding Hermetic to the Slack
Copy `config/example-config.exs` to `config/config.exs` and fill in the secrets
(Slack, Youtrack and Github API tokens).
[Set up a Slack app](https://api.slack.com/slack-apps) and create two slash
commands that point to `https://yourdomain.tld/yt-add` and
`https://yourdomain.tld/yt-cmd`. Make sure to enable user escaping so Hermetic
can translate Slack users (by email) to YouTrack users. You can use `nginx` for
example to handle `https` and routing.
#### Oauth scopes
The app needs the following OAuth scopes to function:
* channels:history
* chat:write
* commands
* groups:history
* im:history
* mpim:history
* users.profile:read
### Using the bot
Run those slash commands in a chat with Hermetic:
- `/yt-add ProjectID [@assignee] [#tag] Title text` Add a YouTrack issue. A link to a previous message in the chat is added to an issue description.
- `/yt-cmd issue-ID youtrack command` Run a YouTrack command on an issue.
Also, Hermetic will automatically reply to any message containing `issue-ID` (e.
g. `AD-150`) with a link to this issue.
## Issue tracker
We use [YouTrack](https://issues.serokell.io/issues/INT) as our issue tracker.
You can login using your GitHub account to leave a comment or create a new issue.
## About Serokell
Hermetic is maintained by [Serokell](https://serokell.io/).
We love open source software.
See which [services](https://serokell.io/#services) we provide and [drop us a line](mailto:hi@serokell.io) if you are interested.