summaryrefslogtreecommitdiff
path: root/github-prs-widget/README.md
blob: 123a593408e04771cb7148a07de18c34cee94c00 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# GitHub PRs Widget

<p align="center">
  <a href="https://github.com/streetturtle/awesome-wm-widgets/labels/github-prs" target="_blank"><img alt="GitHub issues by-label" src="https://img.shields.io/github/issues/streetturtle/awesome-wm-widgets/github-prs"></a>
</p>

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;

![screenshot](./screenshots/screenshot1.png)

## 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 user login |

## Installation

Install and setup [GitHub CLI](https://cli.github.com/)  
Clone/download repo and use widget in **rc.lua**:

```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'
    },
}	
...
```