JitPack.io Documentation

JitCI is an all-in-one solution to automate the publishing of high-quality libraries. It integrates with JitPack to provide:

• Test execution
• Code coverage reporting
• Dependency auditing
• License checks
• Vulnerability reports
• Automated publishing to JitPack

You can enable it via project settings or by signing in at jitci.com.

To use private repositories, you must first obtain an authentication token from https://jitpack.io/private by clicking Authorize. Each team member should obtain their own token.

To use this token in Gradle, add it to your $HOME/.gradle/gradle.properties file:

authToken=AUTHENTICATION_TOKEN

To publish a Gradle project, ensure your repository contains a build.gradle file. JitPack requires either the maven or maven-publish plugin to be enabled.

• If using the maven plugin, JitPack runs ./gradlew install.
• If using the maven-publish plugin, JitPack runs ./gradlew build publishToMavenLocal.

It is highly recommended to use the Gradle wrapper (gradlew) to ensure compatibility.

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

JitPack builds Leiningen projects by running lein do clean, install.

To consume JitPack dependencies in Leiningen, add the JitPack repository and the dependency to your project.clj file.

:repositories [["jitpack" "https://jitpack.io"]]
:dependencies [[com.github.User/Repo "Tag"]]

Instead of using com.github.yourcompany, you can use com.yourcompany by mapping your domain to your GitHub organization.

1. Add a DNS TXT record that maps git.yourcompany.com to https://github.com/yourcompany.
2. Verify the record using dig txt git.yourcompany.com.
3. Look up https://jitpack.io/#com.yourcompany/yourrepo on JitPack. If DNS resolution works, you can select a version and get instructions.

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

To build snapshots automatically on every commit, add a GitHub Webhook to your repository.

• Webhook URL: https://jitpack.io/api/webhooks
• Content type: application/json

Note: The webhook triggers builds for branches you have previously requested from JitPack (e.g., master-SNAPSHOT).

To publish your library, you only need to create a GitHub Release. JitPack will automatically build the project if it contains a build file that can install the library into a local Maven repository.

Tips for Publishers:

• You can test builds before a formal release by using a specific commit hash as the version.
• To make your library easier to use, include a sources jar in your build process.
• Add the JitPack repository and dependency information to your project's README so users know how to consume it.

You must use the maven-publish plugin to publish your library.

1. Add the plugin to your plugins block.
2. Configure the publishing block to define your groupId, artifactId, and version.

plugins {
    id 'maven-publish'
}

publishing {
    publications {
        release(MavenPublication) {
            groupId = 'io.jitpack'
            artifactId = 'library'
            version = '1.0'

            afterEvaluate {
                from components.release
            }
        }
    }
}

For private repositories, use Basic Authentication. Use your JitPack authentication token as the username and leave the password empty.

You can find your token at https://jitpack.io/private.

curl -uTOKEN: https://jitpack.io/api/builds/:groupId/:artifactId/:tag

You can use your own domain name as the groupId (e.g., com.yourcompany instead of com.github.yourcompany).

Setup Steps:

1. DNS Configuration: Add a DNS TXT record that maps git.yourcompany.com to your GitHub organization URL (e.g., https://github.com/yourcompany).
2. Verification: Verify the record using dig txt git.yourcompany.com. It should return the GitHub URL.
3. Lookup: Go to https://jitpack.io/#com.yourcompany/yourrepo and click Look up. If successful, you can select versions and get Maven/Gradle instructions.

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

JitPack supports SSH key-based authentication or Deploy Keys.

1. Generate keys on your JitPack user page.
2. Add the public key to your Git repository.

Note: To have admin permissions for the repository on JitPack, the deploy key must have push permissions.