BUILDING.md

Guide to building projects

JitPack currently can build Gradle, Maven, Sbt and Leiningen projects. Support for other build frameworks is coming later on.

If the project has a build.gradle file then it will be built using Gradle otherwise JitPack will look for a pom.xml, build.sbt or project.clj file. The build.gradle file can also be located in a subfolder.

Gradle projects

Projects using Gradle need to have either the maven or maven-publishing plugin enabled. For example, if you add this to your build file:

    apply plugin: 'maven'
    
    group = 'com.github.YourUsername'

then JitPack will run:

    ./gradlew install

to install the jar and pom file in it's local maven repository. With maven-publishing plugin it will run ./gradlew build publishToMavenLocal.

Note that if your project isn't using a Gradle wrapper JitPack will build it with Gradle 2.4.

Example projects

• Simple - https://github.com/jitpack/gradle-simple
• Multiple modules - https://github.com/jitpack/gradle-modular
• Project with multiple artifacts - https://github.com/jitpack/gradle-multiple-jars

Android projects

See the Guide to building Android projects with Gradle

Maven projects

JitPack will run:

mvn install -DskipTests

to build and publish Maven projects.

Example projects

• Simple - https://github.com/jitpack/maven-simple
• Multiple modules - https://github.com/jitpack/maven-modular

Multi-module projects

If the project builds multiple modules JitPack will append the repository name to the artifact's groupId and the module's name will stay in the artifactId. It will also generate a module that includes all of repository's modules as dependencies. That way if you don't know which module you want you can get all of them by adding just a single dependency to your build file.

To get individual artifacts of multi-module builds use com.github.User.Repo as group Id and ModuleName as the artifact Id.

Individual module in Gradle:

compile 'com.github.User.Repo:Module:Tag'

or in Maven:

<dependency> 
	<groupId>com.github.User.Repo</groupId> 
	<artifactId>Module</artifactId> 
	<version>Tag</version> 
</dependency>

To get all modules of a project use the standard syntax:

compile 'com.github.User:Repo:Tag'

Examples:

• Multiple Gradle modules - https://github.com/jitpack/gradle-modular
• Multiple Maven modules - https://github.com/jitpack/maven-modular

Sbt projects

JitPack can build sbt projects and also provide dependencies to sbt. When building an Sbt project JitPack will run:

sbt publishM2

To use JitPack repository from sbt add this to build.sbt:

resolvers += "jitpack" at "https://jitpack.io"

and then use:

libraryDependencies += "com.github.User" % "Repo" % "Tag"

Leiningen projects

When building a Leiningen project JitPack will run:

lein do clean, install

To use JitPack from Leiningen add the repository to your project.clj:

:repositories [["jitpack" "https://jitpack.io"]]

and then the dependency:

:dependencies [[com.github.User/Repo "Tag"]]

Java version

JitPack will compile projects using Oracle Java 8. See the example projects on how to set a different target version in your build file.

Android projects are build with Oracle Java 7 by default. Maven projects that specify a target version in their pom will be built with that target version.

If your project uses Travis or Circle CI then JitPack will read the lowest jdk version from yml file and use that to build.

Alternatively create a .jitpack.yml file in the root of your repository and specify a jdk version:

jdk:
  - oraclejdk8

Troubleshooting

If there is an issue with a build you will see a link to the log in the Status column. You can also inspect the build log for any other build using the URL:

https://jitpack.io/com/github/User/Repo/Tag/build.log

and it sometimes helps to look at the pom file itself:

curl -v https://jitpack.io/com/github/User/Repo/Tag/Repo-Tag.pom

Although we monitor all the builds feel free to get in touch any time you face an issue. The easiest way is to open a GitHub issues or come chat on https://gitter.im/jitpack-io

Rebuilding

You can remove builds that didn't succeed if you Sign In on JitPack.io and look up your repository. Requesting them again will result in the project being rebuilt.

You may need to run gradle with --refresh-dependencies flag in order to re-fetch the dependency.

Clean gradle cache

To clean the Gradle cache delete the HOME_DIR/.gradle/caches directory.