https://github.com/fedebertolini/slack-jira-query

Run a JIRA query and send the results to a Slack channel
https://github.com/fedebertolini/slack-jira-query

Last synced: 26 days ago
JSON representation

Run a JIRA query and send the results to a Slack channel

• Host: GitHub
• URL: https://github.com/fedebertolini/slack-jira-query
• Owner: fedebertolini
• License: mit
• Created: 2020-01-22T18:57:31.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-09T19:18:24.000Z (over 2 years ago)
• Last Synced: 2025-08-27T20:23:55.994Z (10 months ago)
• Language: JavaScript
• Size: 130 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## slack-jira-query

Run a JIRA query and send the results to a Slack channel.

This tool was created with the intension of running it every morning and send a report of outstanding bugs to a Slack channel to add visibility.

![Screenshot of report](./screenshot.png)

### Setup

The package should be installed globally with `npm install -g slack-jira-query` and the following environment variables must be set when running the application:

-   `SLACK_WEBHOOK`: url of the Slack webhook used for sending the message

-   `SLACK_CHANNEL`: the channel where the reports are going to be sent to

-   `SLACK_EMOJI` (optional): define the emoji used by the application when sending the reports. Defaults to `:robot_face:`.

-   `JIRA_HOST`: the Atlassian url (for example `https://your_company_name.atlassian.net`)

-   `JIRA_USERNAME`: Atlassian username that will be used to run the query

-   `JIRA_API_KEY`: API key created by `JIRA_USERNAME`. You can create one in https://id.atlassian.com/manage/api-tokens

-   `JIRA_QUERY`: the query in JQL to be executed (for example `issuetype=Bug AND resolution=Unresolved`)

-   `JIRA_QUERY_NAME`: this name will be included in the report's header

-   `MAX_ISSUES` (optional): the maximum number of issues to be included in the report. Cannot be greater than `20`, and defaults to `5`.