wtf/_site/content/posts/modules/jira.md

title, date, draft

title	date	draft
Jira	2018-05-10T10:44:35-07:00	false

Displays all Jira issues assigned to you for the specified project.

Source Code

wtf/jira/

Required ENV Variables

Key: WTF_JIRA_API_KEY
Value: Your Jira API key.

Keyboard Commands

None.

Configuration

Single Jira Project

jira:
  colors:
    rows:
      even: "lightblue"
      odd: "white"
  domain: "https://umbrellacorp.atlassian.net"
  email: "chriscummer@me.com"
  enabled: true
  jql: "issueType = Story"
  position:
    top: 4
    left: 1
    height: 1
    width: 2
  project: "ProjectA"
  refreshInterval: 900
  username: "chris.cummer"

Multiple Jira Projects

If you want to monitor multiple Jira projects, use the following configuration (note the difference in project):

jira:
  colors:
    rows:
      even: "lightblue"
      odd: "white"
  domain: "https://umbrellacorp.atlassian.net"
  email: "chriscummer@me.com"
  enabled: true
  jql: "issueType = Story"
  position:
    top: 4
    left: 1
    height: 1
    width: 2
  project: ["ProjectA", "ProjectB"]
  refreshInterval: 900
  username: "chris.cummer"

Attributes

colors.rows.even
Define the foreground color for even-numbered rows.
Values: Any X11 color name.

colors.rows.odd
Define the foreground color for odd-numbered rows.
Values: Any X11 color name.

domain
Your Jira corporate domain.
Values: A valid URI.

email
The email address associated with your Jira account.
Values: A valid email address string.

enabled
Determines whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

jql
Optional
Custom JQL to be appended to the search query.
Values: See Search Jira like a boss with JQL for details.

position
Defines where in the grid this module's widget will be displayed.

project
The Jira project to fetch information for.

refreshInterval
How often, in seconds, this module will update its data.
Values: A positive integer, 0..n.

username
Your Jira username.