blob: a97cae15fc4e203d86f73ec7fedf09ed6199c121 [file] [log] [blame] [raw]
Gitiles - A simple JGit repository browser
==========================================
Gitiles is a simple repository browser for Git repositories, built on JGit. Its
guiding principle is simplicity: it has no formal access controls, no write
access, no fancy Javascript, etc.
BUILDING
Gitiles requires Maven (http://maven.apache.org/) to build.
sudo apt-get install maven
cd gitiles
mvn compile
TESTING
cd gitiles
mvn package
./tools/run_dev.sh
open http://localhost:8080/ to view your local copy of gitiles.
ECLIPSE
If you'd like to use Eclipse to edit Gitiles, you will need the m2e
Eclipse plugin: http://eclipse.org/m2e/
File -> Import -> Maven -> Existing Maven Project
Make sure that all 4 projects are imported:
gitiles-parent, gitiles-dev, gitiles-servlet, gitiles-war
CODE REVIEW
Gitiles uses Gerrit for code review:
https://gerrit-review.googlesource.com/
Gitiles uses the "git push" workflow described here:
http://gerrit.googlecode.com/svn/documentation/2.0/user-upload.html
With the server https://gerrit.googlesource.com/gitiles
You'll need a password from: https://gerrit.googlesource.com/new-password
Gerrit depends on "Change-Id" annotations in your commit message.
If you try to push a commit without one, it will explain how to
install the proper git-hook:
curl -Lo `git rev-parse --git-dir`/hooks/commit-msg \
https://gerrit-review.googlesource.com/tools/hooks/commit-msg
chmod +x `git rev-parse --git-dir`/hooks/commit-msg
Before you create your local commit (which you'll push to Gerrit)
you will need to set your email to match your Gerrit account:
git config --local --add user.email foo@bar.com
Normally you'll create code reviews for pushes to master:
git push origin HEAD:refs/for/master