Skip to content

Latest commit

 

History

History
129 lines (85 loc) · 5.5 KB

README.md

File metadata and controls

129 lines (85 loc) · 5.5 KB
Raw

JitPack.io

This is a repository for documentation and issues of https://jitpack.io service

Need help setting up a repo? Come to Gitter

About

JitPack is a novel package repository for JVM 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!

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.

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

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.

Gradle example:

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

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
  • -SNAPSHOT

-SNAPSHOT will build the latest commit in the git repository. It depends on your build tool how often it checks for new snapshot versions. For example, see the Gradle documentation on how to configure caching for changing dependencies.

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.

BitBucket

Using BitBucket is similar to using GitHub repositories. The only difference is:

  • Group: org.bitbucket.Username

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

Releasing on JitPack

Releasing your library on JitPack is very simple.

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.

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

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

Some extra things 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'
}

It's easy to look up the dependency information on https://jitpack.io. Just paste your GitHub url and press Look Up

  • Add sources jar. Creating the sources jar makes it easier for others to use your code and contribute.
  • Add a badge. You can add a version badge to your readme.md, for example:

Release

[![Release](https://img.shields.io/github/release/jitpack/gradle-simple.svg?label=maven)](https://jitpack.io/#jitpack/gradle-simple)

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/
  • Private repositories https://jitpack.io/private
  • 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.
  • Build by tag and by commit id.
  • Finds build files in sub-folders if there is no build file at the root of the repository

Motivation

There are a lot of great libraries on GitHub but unfortunately many of them are not published on any public repositories. You could always check out the code, build and deploy locally:

but wouldn't it be great if the library was already built and available to use? Well now it is.

With JitPack all the author needs to do is create a GitHub Release and the project becomes available for everyone to use. So sharing releases is simpler for authors as well.

Other

See the FAQ page