diff --git a/README.rst b/README.rst index 871069e..1cb43f1 100644 --- a/README.rst +++ b/README.rst @@ -41,7 +41,7 @@ To install from a git checkout:: Gertty uses a YAML based configuration file that it looks for at ``~/.gertty.yaml``. Several sample configuration files are included. -You can find them in the examples/ directory of the +You can find them in the examples/ directory of the `source distribution `_ or the share/gertty/examples directory after installation. @@ -59,6 +59,10 @@ need to be supplied. The sample config files are as follows: A configuration designed for use with OpenStack's installation of Gerrit. +**gerrit-gertty.yaml** + A configuration designed for use with Gerrit's own installation of + Gerrit. + You will need your Gerrit password which you can generate or retrieve by navigating to ``Settings``, then ``HTTP Password``. diff --git a/examples/gerrit-gertty.yaml b/examples/gerrit-gertty.yaml new file mode 100644 index 0000000..3227586 --- /dev/null +++ b/examples/gerrit-gertty.yaml @@ -0,0 +1,62 @@ +# This is an example ~/.gertty.yaml file for use with Gerrit's own +# installation of Gerrit. Most of these options are not required, +# rather, they customize Gertty to better deal with the particulars of +# Gerrit's Gerrit configuration. See the reference-gertty.yaml file +# for more options. + +servers: + - name: gerrit-review + url: https://gerrit-review.googlesource.com/ + # Your gerrit username. + username: CHANGEME + # Set password at https://gerrit-review.googlesource.com/#/settings/http-password + # Note this is not your Google password. + password: CHANGEME + git-root: ~/git/ + +# Uncomment the next line if your terminal has a white background +# palette: light + +# Commentlinks are regexes that are applied to commit and review +# messages. They can be replaced with internal or external links, or +# have colors applied. +commentlinks: + # Match Gerrit change ids, and replace them with a link to an + # internal Gertty search for that change id. + - match: "(?PI[0-9a-fA-F]{40})" + replacements: + - search: + text: "{id}" + query: "change:{id}" + +# Uncomment the following line to use a unified diff view instead +# of the default side-by-side: +# diff-view: unified + +# This section defines customized dashboards. You can supply any +# Gertty search string and bind them to any key. They will appear in +# the global help text, and pressing the key anywhere in Gertty will +# discard the current display stack and replace it with the results of +# the query. +dashboards: + - name: "My changes" + query: "owner:self status:open" + key: "f2" + +# Reviewkeys are hotkeys that perform immediate reviews within the +# change screen. Any pending comments or review messages will be +# attached to the review; otherwise an empty review will be left. The +# approvals list is exhaustive, so if you specify an empty list, +# Gertty will submit a review that clears any previous approvals. +# They will appear in the help text for the change screen. +reviewkeys: + - key: 'meta 0' + approvals: [] + - key: 'meta 1' + approvals: + - category: 'Code-Review' + value: 1 + - key: 'meta 2' + approvals: + - category: 'Code-Review' + value: 2