diff --git a/README.rst b/README.rst index 4d72b67..0a086a3 100644 --- a/README.rst +++ b/README.rst @@ -34,6 +34,9 @@ Create a file at ``~/.gertty.yaml`` with the following contents:: password: git_root: ~/git/ +A sample file with several options configured for use with OpenStack's +Gerrit is available in ``gertty.yaml-sample``. + You can generate or retrieve your Gerrit password by navigating to Settings, then HTTP Password. Set ``git_root`` to a directory where Gertty should find or clone git repositories for your projects. diff --git a/gertty.yaml-sample b/gertty.yaml-sample new file mode 100644 index 0000000..4cb4714 --- /dev/null +++ b/gertty.yaml-sample @@ -0,0 +1,55 @@ +# This is an example ~/.gertty.yaml file for use with OpenStack's +# Gerrit. Most of these options are not required, rather, they +# customize Gertty to better deal with the particulars of OpenStack's +# Gerrit configuration. + +servers: + - name: openstack + url: https://review.openstack.org/ + username: CHANGEME + password: CHANGEME + git_root: ~/git/ + +palettes: + - name: default + test-SUCCESS: ['light green', '', ''] + test-FAILURE: ['light red', '', ''] + +commentlinks: + - match: "^- (?P.*?) (?P.*?) : (?P.*?) (?P.*)$" + replacements: + - link: + text: "{job:<42}" + url: "{url}" + - text: + color: "test-{result}" + text: "{result} " + - text: "{rest}" + - match: "(?PI[0-9a-fA-F]{40})" + replacements: + - search: + text: "{id}" + query: "changeid:{id}" + +dashboards: + - name: "My changes" + query: "owner:self status:open" + key: "f2" + +reviewkeys: + - key: 'meta 0' + approvals: [] + - key: 'meta 1' + approvals: + - category: 'Code-Review' + value: 1 + - key: 'meta 2' + approvals: + - category: 'Code-Review' + value: 2 + - key: 'meta 3' + approvals: + - category: 'Code-Review' + value: 2 + - category: 'Workflow' + value: 1