| Dave Borowitz | eb794ea | 2012-11-12 14:48:15 -0800 | [diff] [blame] | 1 | Gitiles - A simple JGit repository browser |
| 2 | ========================================== |
| 3 | |
| 4 | Gitiles is a simple repository browser for Git repositories, built on JGit. Its |
| 5 | guiding principle is simplicity: it has no formal access controls, no write |
| 6 | access, no fancy Javascript, etc. |
| Eric Seidel | 48816fb | 2013-06-11 17:17:50 -0700 | [diff] [blame] | 7 | |
| 8 | |
| 9 | BUILDING |
| 10 | |
| 11 | Gitiles requires Maven (http://maven.apache.org/) to build. |
| 12 | |
| 13 | sudo apt-get install maven |
| 14 | cd gitiles |
| 15 | mvn compile |
| 16 | |
| 17 | |
| 18 | TESTING |
| 19 | |
| 20 | cd gitiles |
| 21 | mvn package |
| 22 | ./tools/run_dev.sh |
| 23 | open http://localhost:8080/ to view your local copy of gitiles. |
| 24 | |
| 25 | |
| 26 | ECLIPSE |
| 27 | |
| 28 | If you'd like to use Eclipse to edit Gitiles, you will need the m2e |
| 29 | Eclipse plugin: http://eclipse.org/m2e/ |
| 30 | |
| 31 | File -> Import -> Maven -> Existing Maven Project |
| 32 | |
| 33 | Make sure that all 4 projects are imported: |
| 34 | gitiles-parent, gitiles-dev, gitiles-servlet, gitiles-war |
| 35 | |
| 36 | |
| 37 | CODE REVIEW |
| 38 | |
| 39 | Gitiles uses Gerrit for code review: |
| 40 | https://gerrit-review.googlesource.com/ |
| 41 | |
| 42 | Gitiles uses the "git push" workflow described here: |
| 43 | http://gerrit.googlecode.com/svn/documentation/2.0/user-upload.html |
| 44 | With the server https://gerrit.googlesource.com/gitiles |
| 45 | You'll need a password from: https://gerrit.googlesource.com/new-password |
| 46 | |
| 47 | Gerrit depends on "Change-Id" annotations in your commit message. |
| 48 | If you try to push a commit without one, it will explain how to |
| 49 | install the proper git-hook: |
| 50 | |
| 51 | curl -Lo `git rev-parse --git-dir`/hooks/commit-msg \ |
| 52 | https://gerrit-review.googlesource.com/tools/hooks/commit-msg |
| 53 | chmod +x `git rev-parse --git-dir`/hooks/commit-msg |
| 54 | |
| 55 | Before you create your local commit (which you'll push to Gerrit) |
| 56 | you will need to set your email to match your Gerrit account: |
| 57 | git config --local --add user.email [email protected] |
| 58 | |
| 59 | Normally you'll create code reviews for pushes to master: |
| 60 | git push origin HEAD:refs/for/master |