awesomewm-mirrors
/
awesome-wm-widgets
mirror of https://github.com/streetturtle/awesome-wm-widgets.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
awesome-wm-widgets/jira-widget
History
David Grajal 7ed2f25012
fix(jira): use assignee.name or assignee.displayName 
On *.atlassian.com hosts the api returns the name on 'displayName'

The jira API doesn't seem to send the field name anymore
https://docs.atlassian.com/software/jira/docs/api/7.1.0/com/atlassian/jira/user/UserDetails.html

After this commit we use one or the other, whatever is available.
 		2021-09-28 09:34:49 +02:00
..
icon [jira] improve the menu list 2021-04-12 20:55:05 -04:00
screenshot [jira] improve the menu list 2021-04-12 20:55:05 -04:00
README.md [jira] improve the menu list 2021-04-12 20:55:05 -04:00
jira.lua fix(jira): use assignee.name or assignee.displayName 2021-09-28 09:34:49 +02:00

README.md

Jira widget

The widget shows the number of tickets assigned to the user (or any other result of a JQL query, see customization section) and when clicked shows them in the list, grouped by the ticket status. Left-click on the item opens the issue in the default browser:

screenshot

How it works

Widget uses cURL to query Jira's REST API. In order to be authenticated, widget uses a netrc feature of the cURL, which is basically to store basic auth credentials in a .netrc file in home folder.

If you are on Atlassian Cloud, then instead of providing a password in netrc file you can set an API token which is a safer option, as you can revoke/change the token at any time.

Customization

It is possible to customize widget by providing a table with all or some of the following config parameters:

Name Default Description
host Required Ex: http://jira.tmnt.com
query jql=assignee=currentuser() AND resolution=Unresolved JQL query
icon ~/.config/awesome/awesome-wm-widgets/jira-widget/jira-mark-gradient-blue.svg Path to the icon
timeout 600 How often in seconds the widget refreshes

Installation

Create a .netrc file in you home directory with following content:

machine turtlejira.com
login mikey@tmnt.com
password cowabunga

Then change file's permissions to 600 (so only you can read/write it):

chmod 600 ~/.netrc

And test if it works by calling the API (-n option is to use the .netrc file for authentication):

curl -n 'https://turtleninja.com/rest/api/2/search?jql=assignee=currentuser()+AND+resolution=Unresolved'

Clone/download repo and use the widget in rc.lua:

local jira_widget = require("awesome-wm-widgets.jira-widget.jira")
...
s.mytasklist, -- Middle widget
	{ -- Right widgets
    	layout = wibox.layout.fixed.horizontal,
		...
		-- default
		jira_widget({host = 'http://jira.tmnt.com'}),
		...