awesome-wm-widgets/gitlab-widget
pingarelho 4768d48a3b Fix documentation inconsistencies (mainly tables) 2023-09-20 23:01:55 +01:00
..
icons [gitlab] new widget \o/ 2020-10-21 23:11:39 -04:00
README.md Fix documentation inconsistencies (mainly tables) 2023-09-20 23:01:55 +01:00
gitlab.lua [gitlab] move error marker to the top right corner 2021-01-03 20:11:00 -05:00
screenshot.png fix #228 - add gitlab readme 2020-12-17 20:25:36 -05:00

README.md

Gitlab widget

GitHub issues by-label

The widget shows the number of merge requests assigned to the user and when clicked shows additional information, such as

  • author's name and avatar (opens user profile page when clicked);
  • MR name (opens MR when clicked);
  • source and target branches;
  • when was created;
  • number of comments;
  • number of approvals.

screenshot

Customization

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

Name Default Description
icon ./icons/gitlab-icon.svg Path to the icon
host Required e.g. https://gitlab.yourcompany.com
access_token Required e.g. h2v531iYASDz6McxYk4A
timeout 60 How often in seconds the widget should be refreshed

Note:

  • to get the access token, go to User Settings -> Access Tokens and generate a token with api scope

Installation

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

local gitlab_widget = require("awesome-wm-widgets.gitlab-widget.gitlab")
...
s.mytasklist, -- Middle widget
	{ -- Right widgets
    	layout = wibox.layout.fixed.horizontal,
		...
		-- default
        gitlab_widget{
            host = 'https://gitlab.yourcompany.com',
            access_token = 'h2v531iYASDz6McxYk4A'
        },
		...