v0.1-9
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAABAgAGBQJXF0BrAAoJEPI2qVPgglpt6JYIAIVx8m394rxxQEnpUFLC+QZU
uyas5bhTJYO0pVT/d7ggmAuwA0/Df8dnd5nGBs9wR8DaVk1I0BgbOsNcd5R4dg+B
kLe4Kd0BhRMvUJ9W0VV3YJPd/J+ID3MXI9CuNXNdB5Oiq9rGTocqcFElKWxdlUin
Y/r1GA2g5p9P4059LkxFd65v5sxeiK5zQVQnIlOc9GV9TD2/0zBiTEiS0bQ7CZra
/70FPeuCSsAaEecnGFQIUS5m3cx4a1/phB9TW4eHlBRjMoAlFj2D9aznQNd/VWvC
NZuX2yhsdxJThy6qHjubhK2cDRyuOvBNyFvJJDefZnHryeeB5LXCE1g+pmoQX8Y=
=uoVI
-----END PGP SIGNATURE-----
Bump version to 0.1-9

Change-Id: I8acaca9ca5862ed26107011052d7f3c73d4a749c
1 file changed
tree: 9c0f55e29b201f3eb12b0419c02121a95bbfb39e
  1. .buckconfig
  2. .gitignore
  3. .gitmodules
  4. .settings/
  5. BUCK
  6. COPYING
  7. Documentation/
  8. README.md
  9. VERSION
  10. blame-cache/
  11. bucklets.defs
  12. fake_pom_deploy.xml
  13. gitiles-dev/
  14. gitiles-servlet/
  15. lib/
  16. tools/
README.md

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 Buck to build.

sudo apt-get install ant
cd ${HOME}
git clone https://github.com/facebook/buck.git
cd buck
ant
sudo ln -s ${PWD}/bin/buck /usr/bin/buck
cd /path/to/gitiles
git submodule update --init
buck build all
buck 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 buck test.

Eclipse IDE

If you'd like to use Eclipse to edit Gitiles, first generate a project file:

./bucklets/tools/eclipse.py --src

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.

Code Style

Java code in Gitiles follows the [Google Java Style Guide] (https://google.github.io/styleguide/javaguide.html) with a 100-column limit.

CSS in Gitiles follows the [SUIT CSS naming conventions] (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 with server https://gerrit.googlesource.com/gitiles. You will need a generated cookie.

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