summaryrefslogtreecommitdiff
path: root/gerrit-widget
diff options
context:
space:
mode:
authorPavel Makhov <pmakhov@theoctavegroup.com>2019-11-05 22:02:56 -0500
committerPavel Makhov <pmakhov@theoctavegroup.com>2019-11-05 22:02:56 -0500
commita995b89701c4dc9082bc14515eeabfea3fb99198 (patch)
treeaa059c7c5c61f6803bbcff01af952685ee184114 /gerrit-widget
parentd7c5d291fd3ec83bc2120c43a2b580ff6e9572a7 (diff)
Update readme
Diffstat (limited to 'gerrit-widget')
-rw-r--r--gerrit-widget/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/gerrit-widget/README.md b/gerrit-widget/README.md
index 5682b9b..fde1fd8 100644
--- a/gerrit-widget/README.md
+++ b/gerrit-widget/README.md
@@ -20,6 +20,12 @@ It is possible to customize widget by providing a table with all or some of the
## Installation
1. This widget relies on Gerrit [REST API](https://gerrit-review.googlesource.com/Documentation/rest-api.html), so you need to have a permission to access it. You also need to setup [netrc](https://ec.haxx.se/usingcurl-netrc.html), as widget uses curl to communicate with API and you have to be authenticated.
+To test if you have access to API and netrc setup is correct run following command, you should have a json response:
+
+```bash
+ curl -s --request GET --netrc https://gerrit-host.com/a/changes/\?q\=status:open+AND+NOT+is:wip+AND+is:reviewer | tail -n +2
+```
+Note: `tail -n +2` is needed to skip first line of the response, as gerrit returns some characters there in order to prevent XSS hacks.
1. Download json parser for lua from [github.com/rxi/json.lua](https://github.com/rxi/json.lua) and place it under **~/.config/awesome/** (don't forget to star a repo):