https://github.com/metabase/slack-recently-closed-issues-bot
Slack bot that posts message about recently closed GitHub issues with no milestone
https://github.com/metabase/slack-recently-closed-issues-bot
Last synced: 4 months ago
JSON representation
Slack bot that posts message about recently closed GitHub issues with no milestone
- Host: GitHub
- URL: https://github.com/metabase/slack-recently-closed-issues-bot
- Owner: metabase
- License: mit
- Created: 2021-05-13T04:31:17.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-13T05:50:07.000Z (about 4 years ago)
- Last Synced: 2024-12-27T12:09:17.906Z (6 months ago)
- Language: Clojure
- Size: 141 KB
- Stars: 0
- Watchers: 37
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Cam's Recently Closed GitHub Issues with no Milestone Slack Bot
A Slack app that will post a message when about recently closed GitHub issues that weren't tagged with a milestone.
### Running:
```sh
# To see a list of possible arguments
clojure -M -m closed-issues-bot.core --help
# To run the command (these tokens are fake, but the shape is correct)
clojure -M -m closed-issues-bot.core \
--slack-oauth-token xoxb-3104327438-7923114252020-rAaqkKTnbGy4dwLalHridEiu \
--github-token 17c52c6b16f7187c63813741266ab57c0ce72697 \
--slack-channel pod-product
# With compiled uberjar (see below)
java -jar closed-issues-bot.jar --help
```
### Building an uberjar:
```sh
clojure -X:uberjar
```
Will generate `closed-issues-bot.jar`.
### CLI Options:
You can also set any of these options via env var by using `SCREAMING_SNAKE_CASE` instead of `lisp-case`, e.g.
`SLACK_OAUTH_TOKEN` instead of `--slack-oauth-token`.
#### Required options
The following options are required:
##### `--slack-oauth-token`
Create a new Slack application by visiting https://api.slack.com/apps > `Create an app` > `From scratch`. Add it to
the desired workspace, then click `Add features and functionality` > `Bots` > `Review Scopes to Add`. Add the
following **Bot Token Scopes**:
- `chat:write`
- `chat:write.customize`
- `chat:write.public`
- `users:read`
Finally, click `Install to Workspace` to get the **Bot User OAuth Token**.
##### `--github-token`
Go to https://github.com/settings/tokens > `Personal access tokens` and create a new token. For public repos, this token doesn't need
any special permissions besides the default permission `public_repo`.
##### `--slack-channel`
The channel to post the message to. Does not need to start with `#`. Can also be a user (prefix with `@`).
#### Optional
The following additional configuration options are supported:
##### `--github-repo`
The GitHub repo to check for recently closed issues in. By default, `metabase/metabase`.
##### `--days`
The maximum number of days ago an issue could have been closed to be considered "recent". Issues closed longer than
this many days ago will not be posted by the bot, regardless of whether they have a milestone or not. By default, `14`.
##### `--slack-bot-name`
The name that should be used for the Slack app when it posts. By default, `GH Closed Issues With No Milestone Bot`.
##### `--slack-bot-emoji`
The emoji that should be used for the Slack app when it posts. By default, `:sad`.
##### `--excluded-github-labels`
GitHub labels that mean an issue should be ignored. Use commas to separate labels. By default these labels are ignored:
- `.Documentation`
- `.Duplicate`
- `.Unable to Reproduce`
- `.Won't Fix`
- `Type:Question`
### REPL Usage
To set options in the REPL, use `closed-issues-bot.config/set-option!`:
```clj
(closed-issues-bot.config/set-option! :excluded-github-labels #{"abc" "def"})
```
### Deploying to AWS Lambda
Use `closed_issues_bot.aws_lambda::handleRequest` as the handler. See https://github.com/metabase/cla-bot/ for more
hints on deploying a Clojure AWS lambda.
#### Updating the Lambda from the Command Line
Faster than using the AWS Console.
```sh
clojure -X:uberjar &&
aws lambda update-function-code \
--region us-east-1 \
--function-name Cams-Recently-Closed-GitHub-Issues-with-no-Milestone-Slack-Bot \
--zip-file fileb://./closed-issues-bot.jar
```
### License
Copyright 2021, Metabase, Inc. Licensed under the MIT License.