Magit plugin for Gerrit Code Review
If you have a recent Emacs with package.el
, you can install magit-gerrit
from MELPA.
Otherwise, you'll have to download magit-gerrit.el
and ensure it is in
a directory in your load-path
.
Then:
(require 'magit-gerrit)
;; if remote url is not using the default gerrit port and
;; ssh scheme, need to manually set this variable
(setq-default magit-gerrit-ssh-creds "myid@gerrithost.org")
;; if necessary, use an alternative remote instead of 'origin'
(setq-default magit-gerrit-remote "gerrit")
;; if your remote contains too much reviews, itcan become slow,
;; and you can choose to fetch only your watched reviews.
(setq-default magit-gerrit-extra-options "is:watched is:owner")
;; display review label header, off by default
(setq-default magit-gerrit-show-review-labels t)
;; if your project uses custom labels you can enable them
;; by adding custom labels to to the list, syntax is
;; (add-to-list (list "Review-label-fullname-as-displayed-in-Gerrit-UI"
;; "2-char-abbreviation-for-header") t)
(add-to-list 'magit-gerrit-review-labels (list "Zuul-Gate" "ZG") t)
(add-to-list 'magit-gerrit-review-labels (list "StaticAnalysis" "SA") t)
- Check out branch, make changes, and commit...
- Gerrit Push Commit for Code Review => R P
- Gerrit Add Reviewer => R A (optional)
- Wait for code review and verification (approvals updated in magit-status)
- Gerrit Submit Review => R S
For simple setups, it should be enough to set the default value for
magit-gerrit-ssh-creds
and magit-gerrit-remote
as shown above.
For per project configurations, consider using buffer local or directory local variables.
/home/dev/code/prj1/.dir-locals.el
:
((magit-mode .
((magit-gerrit-ssh-creds . "dev_a@prj1.server.com")
(magit-gerrit-remote . "gerrit"))))
Brian Fransioli ( assem@terranpro.org )
Thanks for using and improving magit-gerrit! Enjoy!
Please help improve magit-gerrit! Pull requests welcomed!