Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flexoid/pivotal-slack-preview
Slack app that provides preview of the pivotal tracker stories when story URLs are posted to the channels.
https://github.com/flexoid/pivotal-slack-preview
golang pivotal-tracker pivotaltracker preview slack slack-bot
Last synced: 27 days ago
JSON representation
Slack app that provides preview of the pivotal tracker stories when story URLs are posted to the channels.
- Host: GitHub
- URL: https://github.com/flexoid/pivotal-slack-preview
- Owner: flexoid
- Created: 2021-01-13T21:36:45.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-30T13:07:42.000Z (almost 3 years ago)
- Last Synced: 2024-10-12T07:44:16.532Z (3 months ago)
- Topics: golang, pivotal-tracker, pivotaltracker, preview, slack, slack-bot
- Language: Go
- Homepage:
- Size: 2.1 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pivotal Tracker Slack Preview
Slack app that provides preview of the pivotal tracker stories when story URLs
are posted to the channels.
## Features
* Automatically post preview of Pivotal Tracker stories mentioned in the message.
* Expand story details with message only visible to single user.
* Configurable number of stories in a single message to ask if preview is needed.
## Installation
1. Deploy this app using preferred way, you can refer to [Deployment](#deployment) section. The port needs to be publically available.
2. Go to Pivotal Tracker [profile](https://www.pivotaltracker.com/profile) page. Generate API token, use it as a `PIVOTAL_TOKEN` environment variable value.
3. Go to [My Apps](https://api.slack.com/apps) slack page and create new app. Choose the name (e.g "Pivotal Tracker Slack Preview") and select desired workspace.
4. On the Basic Information page, copy "Signing Secret" and use it as a `SLACK_SIGNING_SECRET` environment variable value.
5. Go to OAuth & Permissions page. Copy "Bot User OAuth Access Token" and use it as a `SLACK_TOKEN` value.
6. Add the following OAuth scopes:
* `channels:history`
* `channels:read`
* `chat:write`
* `groups:history`
* `im:history`
7. Go to the Event Subscriptions page. Subscribe to the following bot events:
* `message.channels`
* `message.groups`
* `message.im`
8. Enable events and configure Request URL in the form `http://:/events-endpoint`. It is more secure to use `https`, but it will require some reverse proxy with certificate configured.
9. Go to Interactivity & Shortcuts page. Enable interactivity and add Request URL like `http://:/interactive-endpoint`.
10. Add app to the channel. In Slack open:
* "Channel Details"
* "(...) More"
* "Add apps"
* Find an app in a list
## Configuration
Environment variables:
| Env | Description | Default |
| ---------------------- | ------------------------------------------------------------------------------ | ------- |
| `SLACK_TOKEN` | Bot User OAuth Access Token | - |
| `SLACK_SIGNING_SECRET` | Slack Signing Secret | - |
| `PIVOTAL_TOKEN` | Pivotal Tracker API token | - |
| `PORT` | HTTP port to listen | 8080 |
| `STORIES_COUNT_TO_ASK` | Number of stories in a single message to start asking if needs to post preview | 2 |
## Deployment
### Docker Compose
Edit `./configs/.env.prod` file to add all required configuration parameters.
Then run:
```console
$ docker-compose -f ./deployment/docker-compose.yml --env-file ./configs/.env.prod up -d
```
To update:
```console
$ docker-compose -f ./deployment/docker-compose.yml pull
$ docker-compose -f ./deployment/docker-compose.yml --env-file ./configs/.env.prod up --no-deps -d web
```