| commit | author | age | ||
| f13c4c | 1 | Gitblit |
| JM | 2 | ================= |
| 3 | ||
| 74029c | 4 | Gitblit is an open source, pure Java Git solution for managing, viewing, and serving [Git](http://git-scm.com) repositories. It can serve repositories over the GIT, HTTP, and SSH transports; it can authenticate against multiple providers; and it allows you to get up-and-running with an attractive, capable Git server in less than 5 minutes. |
| JM | 5 | |
| 1f9dae | 6 | More information about Gitblit can be found [here](http://gitblit.com). |
| f13c4c | 7 | |
| b79824 | 8 | <a href='https://bintray.com/gitblit/releases/gitblit/_latestVersion'><img src='https://api.bintray.com/packages/gitblit/releases/gitblit/images/download.png'></a> |
| 69eeaa | 9 | |
| f13c4c | 10 | License |
| JM | 11 | ------- |
| 12 | ||
| 6c4be1 | 13 | Gitblit is distributed under the terms of the [Apache Software Foundation license, version 2.0](http://www.apache.org/licenses/LICENSE-2.0). |
| 233eb0 | 14 | The text of the license is included in the file LICENSE in the root of the project. |
| b79824 | 15 | |
| 1f15c8 | 16 | Java Runtime Requirement |
| JM | 17 | ------------------------------------ |
| 18 | ||
| 19 | Gitblit requires at Java 7 Runtime Environment (JRE) or a Java 7 Development Kit (JDK). | |
| 20 | ||
| 21 | Getting help | |
| 22 | ------------ | |
| 23 | ||
| 24 | | Source | Location | | |
| 25 | | ------------- |--------------------------------------------------------| | |
| 26 | | Documentation | [Gitblit website](http://gitblit.com) | | |
| 27 | | Forums | [Google Groups](https://groups.google.com/forum/#!forum/gitblit) | | |
| 28 | | Twitter | @gitblit or @jamesmoger | | |
| 29 | | Google+ | +gitblit or +jamesmoger | | |
| 30 | ||
| b79824 | 31 | Contributing |
| JM | 32 | ------------ |
| 33 | ||
| 74029c | 34 | GitHub pull requests or Gitblit Tickets are preferred. Any contributions must be distributed under the terms of the [Apache Software Foundation license, version 2.0](http://www.apache.org/licenses/LICENSE-2.0). |
| JM | 35 | |
| 36 | **Workflow** | |
| 37 | ||
| 38 | Gitblit practices the [git-flow][1] branching model. | |
| 39 | ||
| 40 | - **master** is the current stable release + fixes accumulated since release. | |
| 41 | - **develop** is the integration branch for the next major release. | |
| 42 | - **ticket/N** are feature or hotfix branches to be merged to **master** or **develop**, as appropriate. | |
| 43 | ||
| 44 | **Feature Development** | |
| 45 | ||
| 46 | Development of new features is mostly done using [Gitblit Tickets][2] hosted at [dev.gitblit.com][3]. This allows continuous dogfooding and improvement of Gitbit's own issue-tracker and pull-request mechanism. | |
| 47 | ||
| 48 | **Release Planning** | |
| 49 | ||
| 50 | Release planning is mostly done using Gitblit Milestones and Gitblit Tickets hosted at [dev.gitblit.com][3]. | |
| 51 | ||
| 52 | **Releasing** | |
| 53 | ||
| 54 | When Gitblit is preparing for a release, a **release-{milestone}** branch will be created, tested, & fixed until it is ready to be merged to **master** and tagged as the next major release. After the release is tagged, the **release-{milestone}** branch will also be merged back into **develop** and then the release branch will be removed. | |
| f13c4c | 55 | |
| JM | 56 | Building Gitblit |
| 57 | ---------------- | |
| b79824 | 58 | |
| JM | 59 | Gitblit uses submodules. |
| 60 | Make sure to clone using `--recursive` OR to execute `git submodule update --init --recursive`. | |
| 61 | ||
| f13c4c | 62 | [Eclipse](http://eclipse.org) is recommended for development as the project settings are preconfigured. |
| JM | 63 | |
| 6c4be1 | 64 | 1. Import the gitblit project into your Eclipse workspace. |
| f13c4c | 65 | *There will be lots of build errors.* |
| 6c4be1 | 66 | 2. Using Ant, execute the `build.xml` script in the project root. |
| f13c4c | 67 | *This will download all necessary build dependencies and will also generate the Keys class for accessing settings.* |
| JM | 68 | 3. Select your gitblit project root and **Refresh** the project, this should correct all build problems. |
| 6c4be1 | 69 | 4. Using JUnit, execute the `com.gitblit.tests.GitBlitSuite` test suite. |
| 1f9dae | 70 | *This will clone some repositories from the web and run through the unit tests.* |
| ea2c2a | 71 | 5. Execute the *com.gitblit.GitBlitServer* class to start Gitblit GO. |
| JM | 72 | |
| 73 | Building Tips & Tricks | |
| 74 | ---------------------- | |
| 6c4be1 | 75 | 1. If you are running Ant from an ANSI-capable console, consider setting the `MX_COLOR` environment variable before executing Ant.<pre>set MX_COLOR=true</pre> |
| b79824 | 76 | 2. The build script will honor your Maven proxy settings. If you need to fine-tune this, please review the [settings.moxie](http://gitblit.github.io/moxie/settings.html) documentation. |
| 74029c | 77 | |
| JM | 78 | [1]: http://nvie.com/posts/a-successful-git-branching-model |
| 79 | [2]: http://gitblit.com/tickets_overview.html | |
| 80 | [3]: https://dev.gitblit.com | |
