blob: 2bc9a81c0e7a50ec85078992d3ecb6c271a3c4ae [file] [log] [blame] [view]
# Developer Guide
[TOC]
## Building
Gitiles requires [Bazel](https://bazel.build/) to build.
You need to use Java for building Gitiles. You can install Bazel from
bazel.build: https://bazel.build/versions/master/docs/install.html
```
bazel build //...
bazel test //...
```
## Testing
```
cd /path/to/repositories # Don't run from the gitiles repo.
/path/to/gitiles/tools/run_dev.sh
```
This will recompile and start a development server. Open
http://localhost:8080/ to view your local copy of gitiles, which
will serve any repositories under `/path/to/repositories`.
To run unit tests, run `bazel test ...`.
## Eclipse IDE
If you'd like to use Eclipse to edit Gitiles, first generate a project file:
```
tools/eclipse/project.sh
```
Import the project in Eclipse:
```
File -> Import -> Existing Projects into Workpace
```
The project only needs to be rebuilt if the source roots or third-party
libraries have changed. For best results, ensure the project is closed in
Eclipse before rebuilding.
## Running/Debugging from Eclipse IDE
Running Gitiles from Eclipse requires setting the
`com.google.gitiles.sourcePath` system property. The property value has to be
the root folder of the Gitiles source code, for example:
````
-Dcom.google.gitiles.sourcePath=/home/johndoe/git/gitiles
````
## Code Style
Java code in Gitiles follows the [Google Java Style Guide][java-style]
with a 100-column limit.
Code should be automatically formatted using [google-java-format][fmt]
prior to sending a code review. There is currently no Eclipse
formatter, but the tool can be run from the command line:
```
java -jar /path/to/google-java-format-1.0-all-deps.jar -i path/to/java/File.java
```
CSS in Gitiles follows the [SUIT CSS naming conventions][suit].
[java-style]: https://google.github.io/styleguide/javaguide.html
[fmt]: https://github.com/google/google-java-format
[suit]: https://github.com/suitcss/suit/blob/master/doc/naming-conventions.md
## Code Review
Gitiles uses Gerrit for code review:
https://gerrit-review.googlesource.com/
Gitiles uses the ["git push" workflow][1] with server
https://gerrit.googlesource.com/gitiles. You will need a
[generated cookie][2].
[1]: https://gerrit-review.googlesource.com/Documentation/user-upload.html#_git_push
[2]: 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 will create code reviews by pushing for master:
```
git push origin HEAD:refs/for/master
```