Provides examples and code snippets for the JGit Java Git implementation
Java
Switch branches/tags

README.md

jgit-cookbook

Build Status Gradle Status

Provides examples and code snippets for the JGit Java Git implementation.

The JGit framework is rich and diverse, it has two layers, a low-level api and a higher-level set of porcelain commands. This can be a bit intimidating at first as there are lots of classes, some of which are not relevant for most tasks.

This project tries to provide a collection of ready-to-run snippets which provide a quick start for building functionality using JGit.

Please make sure to take a look at the nicely written introduction and also use the existing JavaDoc and the User Guide as well, as they are well done and provide detailed information and a general overview of JGit respectively.

Note: Please use sites such as http://stackoverflow.com for general questions about JGit usage, not issues in this project. Issues should be used for problems with snippets and suggestions of missing snippets. Snippets from good answers on stackoverflow can then be included here, naturally.

Getting started

Grab it
git clone git://github.com/centic9/jgit-cookbook
Build it and create Eclipse project files
When using Maven
mvn dependency:sources eclipse:eclipse package
When using Gradle
./gradlew eclipse check

Run it

Import the project into your favourite IDE and execute the snippets there.

Currently the following snippets are available

General Repository handling
Porcelain commands
Commands working with remote repositories
Low-level API
GitServlet
  • There is a standalone sub-project in directory httpserver which starts up a simple HTTP Git server based on the JGit GitServlet.

Just import the project in your IDE and start up the Main application, see the Comments in the code for more details.

Missing snippets

Sources

The following sources were used to build the snippets:

Other applications using JGit

Contribute

Please note that the list of snippets is not yet complete, probably never will. If you are missing things or have suggestions how to improve or add snippets, please either send pull requests or create issues.

Licensing

Copyright 2013-2017 Dominik Stadler

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.