awesome-wm-widgets/github-prs-widget
pingarelho 4768d48a3b Fix documentation inconsistencies (mainly tables) 2023-09-20 23:01:55 +01:00
..
icons new github prs widget 2021-09-19 21:10:39 -04:00
screenshots new github prs widget 2021-09-19 21:10:39 -04:00
README.md Fix documentation inconsistencies (mainly tables) 2023-09-20 23:01:55 +01:00
init.lua fix luacheck 2021-09-19 22:02:40 -04:00

README.md

GitHub PRs Widget

GitHub issues by-label

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

  • author's name and avatar (opens user profile page when clicked);
  • PR name (opens MR when clicked);
  • name of the repository;
  • when was created;
  • number of comments;

Customization

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

Name Default Description
reviewer Required GitHub username

Installation

Install and setup GitHub CLI Clone/download repo and use widget in rc.lua:

local github_prs_widget = require("awesome-wm-widgets.github-prs-widget")
...
s.mytasklist, -- Middle widget
{ -- Right widgets
    layout = wibox.layout.fixed.horizontal,
    ...
    github_prs_widget {
        reviewer = 'streetturtle'
    },
}
...