Notifies in Slack channel with a list of jira tickets that have pending review from x days. Adds the reviewer and PR details if exists.
Project description
Slack Bot Jira Review Reminder
Notifies in Slack channel with a list of jira tickets that have pending review from x days. Adds the reviewer and PR details if exists.
Reviewer's names will be tagged in Slack notifications only if Jira email and slack email are same for all users
Installation
pip install jira-reviews-reminder
Usage
After installing the package run below command:
SLACK_TOKEN=XXXXXXXX SLACK_CHANNEL=catalog-team JIRA_PROJECT=catalog-proj JIRA_USER=abc@org.com JIRA_TOKEN=XXXXXX JIRA_SERVER=https://org.atlassian.net JIRA_REVIEWER_FIELD=customfield_10200 jira-reviews-reminder
This script will run and exit. So, preferably schedule a cron job.
Example:
To run every day 11 AM and 5 PM
0 11,17 * * * SLACK_TOKEN=XXXXXXXX SLACK_CHANNEL=catalog-team JIRA_PROJECT=catalog-proj JIRA_USER=abc@org.com JIRA_TOKEN=XXXXXX JIRA_SERVER=https://org.atlassian.net JIRA_REVIEWER_FIELD=customfield_10200 jira-reviews-reminder
Environment Variables
SLACK_TOKEN
Create a slack bot app and get the Bot User OAuth Token. Use it as Env variable.
Instructions to create Slack Bot
Make sure your bot has all necessary permissions/scopes:
users:read.email
,chat:write.public
,channels:read
,channels:join
SLACK_CHANNEL
Slack channel of your team/jira project. No need to prefix with #
JIRA_PROJECT
The jira project key of your team. Tickets belonging to these projects will be processed.
TODO: Pass comma separated projects, if multiple projects need to be assessed.
JIRA_USER and JIRA_TOKEN
Jira user ID/email and user/app token - need this to authorize the jira client.
IGNORE_JIRA (Optional)
Comma separated Jira IDs. Any jira ID passed in this env variable will not be processed.
ISSUE_CHANGED_BEFORE (Optional)
This variable is used to trigger reminder if the ticket is in review state from x unti of time.
Example:
If the variable value is -1d
. Only those jira will be processed which are in In Review
state for more than 1 day.
default to
-1d
JIRA_SERVER
Jira hosted server - to establish connection.
Example: https://something.atlassian.net
ISSUE_PAGE_SIZE (Optional)
Maximum number of issues to assess that are In review
.
defaults to 20
SLACK_USERS_GROUP (Optional)
This is your team's slack user group. If a ticket doesn't have any reviewer, this user group is tagged in Slack notification.
JIRA_REVIEWER_FIELD
A few of the attributes in jira ticket are placed in dynamic fields/custom fields. This could be different for different projects.
Find out which field in the API response corresponds to the Reviewers
field.
Example: customfield_10200
API Details:
GET /rest/api/2/issue/your_jira_ID
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for jira_reviews_reminder-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d90d117c5b459751e52315d7e5f0de4167e8cdcacffddbf7004827869ebdccdd |
|
MD5 | 76ded334a1705dc3cff12837cf38d3cd |
|
BLAKE2b-256 | 732e181ef5ffdfa66b2d312fef15a76c5cdc59ec12866e46390fd008de03d8c8 |