JitPack.io

JitPack is a novel package repository for JVM and Android projects. It builds Git projects on demand and provides you with ready-to-use artifacts (jar, aar). The core idea is that in order to publish your library you don't need to build and upload it yourself. Just push your changes and create a GitHub release. Done!

Need help setting up a repo? Come to

For issues and enhancements please use the JitPack GitHub repository. The repository contains this documentation and contributions are welcome there as well.

How to

To get a GitHub project into your build:

Step 1. Add the JitPack maven repository to the list of repositories:

    url "https://jitpack.io"

Step 2. Add the dependency information:

• Group: com.github.Username
• Artifact: Repository Name
• Version: Release tag, commit hash or -SNAPSHOT

That's it! The first time you request a project JitPack checks out the code, builds it and sends the Jar files back to you.

To see an example head to jitpack.io and 'Look Up' a GitHub repository by url.

Gradle example:

    allprojects {
        repositories { 
            jcenter()
            maven { url "https://jitpack.io" }
        }
   }
   dependencies {
        compile 'com.github.User:Repo:Tag'
   }

Note: when using multiple repositories in build.gradle it is recommended to add JitPack at the end. Gradle will go through all repositories in order until it finds a dependency.

Snapshots

Snapshot versions are useful during development and JitPack provides two ways to get them. You can specify a version for your dependency as:

• commit hash

• branch-SNAPSHOT (replace 'branch' with any branch name, e.g. master)

For example:

    // dependency on the latest commit in the master branch
    compile 'com.github.jitpack:gradle-simple:master-SNAPSHOT' 

-SNAPSHOT will build the latest commit on the master branch. It depends on your build tool how often it checks for new snapshot versions. For example, in Gradle add these lines to check for new versions on every build:

configurations.all {
    resolutionStrategy.cacheChangingModulesFor 0, 'seconds'
}

Or you could also run Gradle from the command line with the --refresh-dependencies flag. See the Gradle documentation for more information on how to configure caching for changing dependencies.

Note If using Android Studio don't forget to press File->Synchronize after updating to a newer snapshot.

Building

See also the Guide to building for more details and for instructions on building multi-module projects.

If the project doesn't have any GitHub Releases you can get the latest snapshot build. In this case use the short commit id as the version. You can also place tags on other branches and then build using those tags.

Tip: You can also automate GitHub releases with Gradle release & version management plugin

Other Git hosts

JitPack also works with other Git hosting providers. The only difference is the groupId of your artifacts:

• BitBucket: org.bitbucket.Username:Repo:Tag

• GitLab: com.gitlab.Username:Repo:Tag

Too see an example head to https://jitpack.io and 'Look Up' a Git repository by url.

Publishing on JitPack

Publishing your library on JitPack is very simple:

• Create a GitHub Release

As long as there's a build file in your repository and it can install your library in the local Maven repository, it is sufficient for JitPack. See the Guide to building on how to publish JVM libraries and Guide to Android on how to publish Android libraries.

Tip: You can try out your code before a release by using the commit hash as the version.

Some extras to consider:

Add dependency information in your README. Tell the world where to get your library:

   repositories { 
        jcenter()
        maven { url "https://jitpack.io" }
   }
   dependencies {
         compile 'com.github.jitpack:gradle-simple:1.0'
   }

• Add sources jar. Creating the sources jar makes it easier for others to use your code and contribute.

• Show up-to-date version in HTML. If your project has a website or GitHub pages then you can display the latest release using this script

Badges

Add this line to your README.md to show a status badge with the latest release:

[![Release](https://jitpack.io/v/User/Repo.svg)](https://jitpack.io/#User/Repo)

If you are using a custom domain or BitBucket then use:

[![Release](https://jitpack.io/v/com.example/Repo.svg)](https://jitpack.io/#com.example/Repo)

[![Release](https://jitpack.io/v/org.bitbucket.User/Repo.svg)](https://jitpack.io/#org.bitbucket.User/Repo)

Or if you prefer the flat-squared style:

https://jitpack.io/v/User/Repo.svg?style=flat-square

Other Features

• Javadoc publishing. If the project produces a javadoc.jar then you can browse the javadoc files directly at:

  • https://jitpack.io/com/github/USER/REPO/VERSION/javadoc/
  • See the example projects on how to configure your build file. Android example

• Private repositories

• Dynamic versions. You can youse Gradle's dynamic version '1.+' and Maven's version ranges for releases. They resolve to releases that have already been built. JitPack periodically checks for new releases and builds them ahead-of-time.

• Build by tag, commit id or anyBranch-SNAPSHOT.

• You can also use your own domain name for groupId

Custom domain name

If you want to use your own domain name as the groupId instead of com.github.yourcompany, you can. We support mapping your domain name to your GitHub organization. Then instead of 'com.github.yourcompany' groupId you can use 'com.yourcompany' while the name of the project and version remains the same.

To enable your own domain name:

1. Add a DNS TXT record that maps git.yourcompany.com to https://github.com/yourcompany. This needs to be configured at your domain name provider such as GoDaddy. For example see How to add a TXT record.

2. Go to https://jitpack.io/#com.example/yourrepo and click Look up. If DNS resolution worked then you should see a list of versions.

3. Select the version you want and click 'Get it' to see Maven/Gradle instructions.

Example: https://jitpack.io/#io.jitpack/gradle-simple

To check that the DNS TXT record was added run the command dig txt git.yourcompany.com. For example:

~$ dig txt git.jitpack.io
...
;; ANSWER SECTION:
git.jitpack.io.		600	IN	TXT	"https://github.com/jitpack"

Other

See the FAQ page