JitPack

https://docs.jitpack.io
Admin
JitPack is a package repository for JVM and Android projects that builds Git projects on demand,...
Tokens:6,790
Snippets:68
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### README Dependency Information Example

Source: https://docs.jitpack.io/intro

Provides an example of how to include dependency information in a project's README file, guiding users on how to add the project to their Gradle builds via JitPack.

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

--------------------------------

### Publishing Example Dependency Information

Source: https://docs.jitpack.io/index

An example of how to provide dependency information in a README file for users to integrate your library via JitPack.

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

--------------------------------

### Complete Gradle Configuration for JitPack

Source: https://docs.jitpack.io/index

This example demonstrates a full Gradle configuration in `settings.gradle` or `build.gradle` that includes setting up the JitPack repository and declaring a dependency.

```gradle
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}
dependencies {
    implementation 'com.github.User:Repo:Version'
}
```

--------------------------------

### JitPack Custom Domain Setup

Source: https://docs.jitpack.io/faq

Guides users through setting up a custom domain for their JitPack artifacts. This involves configuring a DNS TXT record to point to their GitHub organization and then looking up the repository on JitPack.

```dns
TXT git.yourcompany.com "<https://github.com/yourcompany>"
```

```url
https://jitpack.io/#com.yourcompany/yourrepo
```

```url
https://jitpack.io/#io.jitpack/gradle-simple
```

--------------------------------

### Gradle Dependency Configuration Example

Source: https://docs.jitpack.io/intro

An example of a complete Gradle configuration that adds the JitPack repository and declares a dependency on a GitHub project. It shows how to include JitPack alongside other repositories like mavenCentral.

```gradle
allprojects {
    repositories {
        mavenCentral()
        maven { url "https://jitpack.io" }
    }
}
dependencies {
    implementation 'com.github.User:Repo:Version'
}
```

--------------------------------

### Gradle Publishing with Maven Plugin

Source: https://docs.jitpack.io/building

Configures a Gradle project to use the 'maven' plugin for publishing, specifying the group ID. JitPack will then execute './gradlew install' to build and install artifacts.

```gradle
apply plugin: 'maven'

group = 'com.github.YourUsername'
```

```bash
./gradlew install
```

--------------------------------

### JitPack Custom Build Commands Configuration

Source: https://docs.jitpack.io/building

Example of a jitpack.yml file to override default build commands, specify JDK, and set environment variables.

```yaml
jdk:
  - openjdk9
before_install:
   - ./custom_setup.sh
install:
   - echo "Running a custom install command"
   - ./gradlew clean install -xtest
env:
   MYVAR: "custom environment variable"
```

--------------------------------

### Gradle Version Ranges

Source: https://docs.jitpack.io/faq

Example of using version ranges and dynamic versions with Gradle for JitPack dependencies. These are resolved to releases that have already been built.

```Gradle
compile 'com.github.User:Repo:1.+'
```

--------------------------------

### Use SDKMAN for Java Version in jitpack.yml

Source: https://docs.jitpack.io/building

Install and use specific Java versions using SDKMAN within the `before_install` section of your `jitpack.yml` file. This allows for more granular control over the Java environment.

```yaml
before_install:
   - sdk install java 22-open
   - sdk use java 22-open
```

--------------------------------

### Verify DNS TXT Record for Custom Domain

Source: https://docs.jitpack.io/index

Demonstrates how to use the `dig` command to check if a DNS TXT record is correctly configured for mapping a custom domain to a GitHub repository.

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

--------------------------------

### Sbt Build Command

Source: https://docs.jitpack.io/building

The command JitPack uses to build and publish Sbt projects to the local Maven repository.

```shell
sbt publishM2
```

--------------------------------

### JitPack Dependency Versioning & Branch Handling

Source: https://docs.jitpack.io/faq

Specifies how to reference specific versions, snapshots, tag folders, and branches with slashes in your build files. Tag folders like 'feature/abc' are mapped to 'feature~abc', and branches like 'branch/abc' are mapped to 'branch~abc'. Using 'anyBranch-SNAPSHOT' fetches the latest snapshot.

```gradle
implementation 'com.github.user:repo:anyBranch-SNAPSHOT'
```

```gradle
implementation 'com.github.user:repo:feature~abc'
```

```gradle
implementation 'com.github.user:repo:branch~abc'
```

--------------------------------

### JitPack Download Statistics Badge (Markdown)

Source: https://docs.jitpack.io/index

Add badges to your README.md to show weekly or monthly download statistics for your project hosted on JitPack. Customize the style for different appearances.

```markdown
![Weekly download statistics](https://jitpack.io/v/USER/REPO/week.svg)
```

```markdown
![Monthly download statistics](https://jitpack.io/v/USER/REPO/month.svg)
```

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

```markdown
[![Release](https://jitpack.io/v/jitpack/maven-simple.svg?style=flat-square)](https://jitpack.io/#jitpack/maven-simple)
```

--------------------------------

### Verify DNS TXT Record for Custom Domain

Source: https://docs.jitpack.io/intro

Demonstrates how to use the `dig` command to check if a DNS TXT record is correctly configured for mapping a custom domain to a GitHub repository.

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

--------------------------------

### Sbt Repository and Dependency Configuration

Source: https://docs.jitpack.io/building

Configuration for Sbt projects to use the JitPack repository and declare dependencies.

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

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

// For cross-building with Scala version:
// libraryDependencies += "com.github.User" %% "Repo" % "Tag"
```

--------------------------------

### Leiningen Repository and Dependency Configuration

Source: https://docs.jitpack.io/building

Configuration for Leiningen projects to use the JitPack repository and declare dependencies.

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

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

--------------------------------

### Gradle Publishing with Maven-Publish Plugin

Source: https://docs.jitpack.io/building

Configures a Gradle project to use the 'maven-publish' plugin for publishing. JitPack will execute './gradlew build publishToMavenLocal' to build and publish artifacts locally.

```gradle
apply plugin: 'maven-publish'

group = 'com.github.YourUsername'
```

```bash
./gradlew build publishToMavenLocal
```

--------------------------------

### JitPack Private Repository Registration

Source: https://docs.jitpack.io/faq

Instructions for users who wish to use JitPack with self-hosted GitLab servers. This requires registering the GitLab server via the user's JitPack page.

```url
https://jitpack.io/w/user
```

--------------------------------

### Sbt Credentials and Build Configuration for JitPack

Source: https://docs.jitpack.io/private

Sets up Sbt to use JitPack's private repository by providing credentials in a .credentials file and referencing it in build.sbt. The 'realm' property in the credentials file must be exactly 'JitPack' (case-sensitive).

```text
realm=JitPack
host=jitpack.io
user=AUTHENTICATION_TOKEN
password=.
```

```scala
credentials += Credentials(Path.userHome / ".sbt" / ".credentials")
```

--------------------------------

### Configure GitHub Webhook for JitPack Builds

Source: https://docs.jitpack.io/building

Set up a webhook on GitHub to trigger builds on JitPack.io for new commits. This requires specifying the webhook URL and content type in your repository's webhook settings.

```APIDOC
Webhook URL:
https://jitpack.io/api/webhooks

Content type:
application/json
```

--------------------------------

### JitPack API Documentation

Source: https://docs.jitpack.io/private

JitPack provides an API to programmatically access build information, download statistics, and manage projects. Key endpoints include retrieving build status, latest builds, and download counts.

```APIDOC
JitPack API Reference:

Base URL: https://jitpack.io/api

Endpoints:

1. Builds:
   - GET /builds/{owner}/{repo}/{ref}
     - Retrieves build information for a specific repository reference (e.g., commit hash, tag).
     - Parameters:
       - owner: The GitHub/Bitbucket owner of the repository.
       - repo: The repository name.
       - ref: The commit hash, tag, or branch name.
     - Returns: JSON object with build status, logs, and artifact information.

2. Single Build:
   - GET /builds/{owner}/{repo}/{ref}/{build_id}
     - Retrieves details for a specific build ID.
     - Parameters:
       - build_id: The unique identifier for a build.
     - Returns: JSON object with detailed build status.

3. Latest Build:
   - GET /builds/{owner}/{repo}/latest
     - Retrieves information about the latest successful build for a repository.
     - Parameters:
       - owner: The GitHub/Bitbucket owner of the repository.
       - repo: The repository name.
     - Returns: JSON object with latest build details.

4. Authentication:
   - POST /private/auth
     - Used to authorize JitPack access to private repositories. Requires user interaction via the JitPack UI.
     - Returns: Authentication token or status.

5. Search:
   - GET /search?q={query}
     - Searches for repositories or artifacts on JitPack.
     - Parameters:
       - query: The search term.
     - Returns: JSON array of search results.

6. Download Statistics:
   - GET /stats/{owner}/{repo}
     - Retrieves download statistics for a repository.
     - Parameters:
       - owner: The GitHub/Bitbucket owner of the repository.
       - repo: The repository name.
     - Returns: JSON object with download counts.
```

--------------------------------

### JitPack Download Statistics Badge (Markdown)

Source: https://docs.jitpack.io/intro

Add badges to your README.md to show weekly or monthly download statistics for your project hosted on JitPack. Customize the style for different appearances.

```markdown
![Weekly download statistics](https://jitpack.io/v/USER/REPO/week.svg)
```

```markdown
![Monthly download statistics](https://jitpack.io/v/USER/REPO/month.svg)
```

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

```markdown
[![Release](https://jitpack.io/v/jitpack/maven-simple.svg?style=flat-square)](https://jitpack.io/#jitpack/maven-simple)
```

--------------------------------

### Leiningen Build Command

Source: https://docs.jitpack.io/building

The command JitPack uses to build Leiningen projects.

```shell
lein do clean, install
```

--------------------------------

### Publish to Maven Local (Gradle)

Source: https://docs.jitpack.io/android

Command to publish the library to the local Maven repository (`~/.m2/repository`) for testing purposes before releasing to JitPack.

```bash
./gradlew publishToMavenLocal

# or if you named your publication "release"
./gradlew publishReleasePublicationToMavenLocal
```

--------------------------------

### Maven Settings for JitPack

Source: https://docs.jitpack.io/private

Configures Maven to use JitPack's private repository with authentication. This involves adding a server entry with the ID 'jitpack.io' to the $HOME/.m2/settings.xml file, specifying the authentication token.

```xml
<settings>
  <servers>
        <server>
          <id>jitpack.io</id>
          <username>AUTHENTICATION_TOKEN</username>
          <password>.</password>
        </server>
  </servers>
</settings>
```

--------------------------------

### Verify DNS TXT Record with dig

Source: https://docs.jitpack.io/private

Demonstrates how to verify a DNS TXT record for custom domain mapping using the `dig` command. This helps confirm that your domain points correctly to your Git server for JitPack integration.

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

--------------------------------

### Gradle Debugging Flags

Source: https://docs.jitpack.io/faq

Provides essential command-line flags for Gradle to increase logging verbosity and force dependency refreshing, which is crucial for diagnosing 'failed to resolve' errors.

```bash
gradle --info --refresh-dependencies
```

--------------------------------

### Maven Build Command

Source: https://docs.jitpack.io/building

The standard command JitPack uses to build Maven projects. It skips tests during the build process.

```shell
mvn install -DskipTests
```

--------------------------------

### Gradle Repository and Credentials for JitPack

Source: https://docs.jitpack.io/private

Configures Gradle to use JitPack's Maven repository and provides authentication credentials. The repository URL is specified, and credentials are provided using a closure with a username property, which should be set to your authentication token.

```groovy
repositories {
	maven {
		url "https://jitpack.io"
		credentials { username authToken }
	}
}
```

```groovy
dependencies {
	compile 'com.github.User:PrivateRepo:Tag'
}
```

--------------------------------

### Gradle Cache Configuration for Snapshots

Source: https://docs.jitpack.io/index

This configuration ensures that Gradle always fetches the latest version of changing modules (like snapshots) by setting the cache duration to 0 seconds.

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

--------------------------------

### Gradle Snapshot Dependency (master-SNAPSHOT)

Source: https://docs.jitpack.io/index

Demonstrates how to configure a Gradle dependency to use a snapshot version, such as the latest commit from the master branch. This is useful for development and testing.

```gradle
implementation 'com.github.jitpack:gradle-simple:master-SNAPSHOT'
```

--------------------------------

### Gradle Pull Request Dependency

Source: https://docs.jitpack.io/index

Shows how to specify a dependency on a specific GitHub Pull Request using JitPack. The version format `PR<NR>-SNAPSHOT` is used, where `<NR>` is the pull request number.

```gradle
implementation 'com.github.jitpack:gradle-simple:PR4-SNAPSHOT'
```

--------------------------------

### JitPack Build Log and Files URLs

Source: https://docs.jitpack.io/building

Access detailed build information by navigating to specific URLs. The build log URL provides access to compilation output, while the files URL allows browsing of build artifacts.

```APIDOC
Build Log URL:
https://jitpack.io/com/github/User/Repo/Tag/build.log

Browse Files URL:
https://jitpack.io/com/github/User/Repo/Tag/
```

--------------------------------

### Gradle Pull Request Dependency

Source: https://docs.jitpack.io/intro

Illustrates how to specify a dependency on a specific GitHub Pull Request using JitPack. The version format 'PR<NR>-SNAPSHOT' allows building and testing changes directly from a PR.

```gradle
implementation 'com.github.jitpack:gradle-simple:PR4-SNAPSHOT'
```

--------------------------------

### Add JitPack Maven Repository

Source: https://docs.jitpack.io/intro

Configures the Gradle build to include the JitPack Maven repository, allowing it to fetch dependencies from JitPack. This is typically added within the repositories block of your build.gradle file.

```gradle
maven { url "https://jitpack.io"  }
```

--------------------------------

### Add JitPack Repository to settings.gradle

Source: https://docs.jitpack.io/android

Instructs users on how to add the JitPack repository to their project's `settings.gradle` file to resolve dependencies hosted on JitPack.

```gradle
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}
```

--------------------------------

### Configure Gradle HTTP Timeouts

Source: https://docs.jitpack.io/faq

Settings to increase HTTP connection and socket timeouts in `gradle.properties` to resolve 'Read timed out' errors when JitPack waits for builds.

```properties
systemProp.org.gradle.internal.http.connectionTimeout=180000
systemProp.org.gradle.internal.http.socketTimeout=180000
```

--------------------------------

### Gradle Repository Filtering for JitPack

Source: https://docs.jitpack.io/index

This snippet illustrates how to use Gradle's content filtering to include or exclude specific groups from repositories, enhancing dependency resolution security and performance.

```gradle
maven {
  url "https://jitpack.io"
  content { includeGroup "com.github.username" }
}
maven {
  url "https://other repository"
  content { excludeGroupByRegex "com\.github.username.*" }
}
```

--------------------------------

### Publish Javadoc for Single Module Project

Source: https://docs.jitpack.io/index

Access Javadoc for a single-module project directly via a URL. This URL structure applies to the main artifact published by the module.

```javadoc
https://jitpack.io/com/github/USER/REPO/VERSION/javadoc/
https://jitpack.io/com/github/USER/REPO/latest/javadoc/
```

--------------------------------

### Publish Javadoc for Multi-Module Project

Source: https://docs.jitpack.io/index

Access Javadoc for multi-module projects by specifying the module's artifact ID in the URL. Aggregated Javadocs are available if the top-level module publishes them.

```javadoc
https://jitpack.io/com/github/USER/REPO/MODULE/VERSION/javadoc/
```

--------------------------------

### JitPack Release Status Badge (Markdown)

Source: https://docs.jitpack.io/index

Embed a status badge in your README.md to display the latest release status of your project hosted on JitPack. Supports standard GitHub, custom domains, and BitBucket.

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

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

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

--------------------------------

### Gradle Dependency Declaration for All Modules

Source: https://docs.jitpack.io/building

How to declare a dependency on all modules of a project from a multi-module Gradle project hosted on JitPack.

```gradle
implementation 'com.github.User:Repo:Tag'
```

--------------------------------

### Gradle Dependency Declaration

Source: https://docs.jitpack.io/building

How to declare a dependency on a specific module from a multi-module Gradle project hosted on JitPack.

```gradle
implementation 'com.github.User.Repo:Module:Tag'
```

--------------------------------

### Gradle Repository Filtering

Source: https://docs.jitpack.io/intro

Demonstrates how to use Gradle's content-based filtering to include or exclude specific groups from repositories. This enhances security and performance by controlling which dependencies are resolved from which repository.

```gradle
maven {
  url "https://jitpack.io"
  content { includeGroup "com.github.username" }
}
maven {
  url "https://other repository"
  content { excludeGroupByRegex "com\.github.username.*" }
}
```

--------------------------------

### Gradle Cache Resolution Strategy for Snapshots

Source: https://docs.jitpack.io/intro

Configures Gradle's resolution strategy to ensure that changing modules (like snapshots) are always picked up with minimal caching delay. This is crucial for development workflows involving frequent updates.

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

--------------------------------

### Leiningen Configuration for JitPack

Source: https://docs.jitpack.io/private

Adds JitPack's private Maven repository to Leiningen projects. This is done by updating the :repositories vector in project.clj, including the URL, username (authentication token), and password.

```clojure
:repositories [["jitpack" {:url"https://jitpack.io" :username "AUTHENTICATION_TOKEN" :password "."}]]
```

--------------------------------

### Rebuild Dependencies with Maven/Gradle Flags

Source: https://docs.jitpack.io/building

Force a rebuild of dependencies for your project. Use the `-U` flag with Maven or `--refresh-dependencies` with Gradle to ensure the latest dependency versions are fetched.

```bash
# Maven
mvn install -U

# Gradle
gradlew build --refresh-dependencies
```

--------------------------------

### Maven Wrapper Build Command

Source: https://docs.jitpack.io/building

The command JitPack uses if a project includes the Maven Wrapper. This allows for specific Maven version control.

```shell
./mvnw install -DskipTests
```

--------------------------------

### JitPack API Endpoints

Source: https://docs.jitpack.io/api

Provides access to build information for projects hosted on JitPack. Includes endpoints for listing all builds, retrieving specific builds, and finding the latest successful build. Supports deletion of specific builds under certain conditions.

```APIDOC
Base URL: https://jitpack.io/api

## Builds

Get all builds for a project and build outcomes.

**GET** `/builds/:groupId/:artifactId`

Example Path:
`/builds/com.github.jitpack/maven-simple`

Example Output:
```json
{
  "com.github.jitpack" : {
    "maven-simple" : {
      "1.1" : "ok",
      "1.0" : "ok",
      "0.5" : "Error",
      "0.1" : "ok"
    }
  }
}
```
Builds are ordered by time when they were executed.

## Single Build

Get a single build for a project and its outcome.

**GET** `/builds/:groupId/:artifactId/:tag`

To delete a build and its artifacts use:

**DELETE** `/builds/:groupId/:artifactId/:tag`

Authentication is required for deletion, and the user must have push permissions to the git repository. Only failed builds, snapshot builds, or tag builds newer than 7 days can be deleted. Older versions cannot be deleted due to potential dependencies.

Example Path:
`/builds/com.github.jitpack/maven-simple/1.0`

## Latest Build

Get the latest build by tag. Tags are compared according to semantic versioning.

**GET** `/builds/:groupId/:artifactId/latest`

Get the latest build that was successful.

**GET** `/builds/:groupId/:artifactId/latestOk`
```

```bash
curl https://jitpack.io/api/builds/com.github.jitpack/maven-simple
```

--------------------------------

### Add JitPack Maven Repository

Source: https://docs.jitpack.io/index

This snippet shows how to add the JitPack Maven repository to your Gradle build configuration. It's recommended to add JitPack at the end of the repository list.

```gradle
maven { url "https://jitpack.io"  }
```

--------------------------------

### Configure Gradle for Private JitPack Repositories

Source: https://docs.jitpack.io/private

This snippet shows how to configure your Gradle build file to use JitPack for private repositories. It includes adding the JitPack Maven repository and specifying credentials using an authentication token.

```Gradle
repositories {
        maven {
            url "https://jitpack.io"
            credentials { username authToken }
        }
 }
```

--------------------------------

### Gradle Snapshot Dependency (master-SNAPSHOT)

Source: https://docs.jitpack.io/intro

Shows how to configure a Gradle dependency to use a snapshot version, specifically targeting the latest commit on the 'master' branch. This is useful for development and testing unreleased changes.

```gradle
implementation 'com.github.jitpack:gradle-simple:master-SNAPSHOT'
```

--------------------------------

### Publish Javadoc for Single Module Project

Source: https://docs.jitpack.io/intro

Access Javadoc for a single-module project directly via a URL. This URL structure applies to the main artifact published by the module.

```javadoc
https://jitpack.io/com/github/USER/REPO/VERSION/javadoc/
https://jitpack.io/com/github/USER/REPO/latest/javadoc/
```

--------------------------------

### JitPack Release Status Badge (Markdown)

Source: https://docs.jitpack.io/intro

Embed a status badge in your README.md to display the latest release status of your project hosted on JitPack. Supports standard GitHub, custom domains, and BitBucket.

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

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

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

--------------------------------

### Add Dependency in build.gradle

Source: https://docs.jitpack.io/android

Shows how to include a library published on JitPack as a dependency in the application's `build.gradle` file.

```gradle
dependencies {
    implementation 'com.github.jitpack:android-example:1.0.1'
}
```

--------------------------------

### Publish Javadoc for Multi-Module Project

Source: https://docs.jitpack.io/intro

Access Javadoc for multi-module projects by specifying the module's artifact ID in the URL. Aggregated Javadocs are available if the top-level module publishes them.

```javadoc
https://jitpack.io/com/github/USER/REPO/MODULE/VERSION/javadoc/
```

--------------------------------

### Configure Maven Publication (Gradle)

Source: https://docs.jitpack.io/android

Configures the `publishing` block in Gradle to define the publication details such as groupId, artifactId, and version for your library.

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

            afterEvaluate {
                from components.release
            }
        }
    }
}
```

--------------------------------

### Add Maven Publish Plugin (Gradle)

Source: https://docs.jitpack.io/android

Declares the `maven-publish` plugin in a Gradle build file, which is essential for publishing artifacts to repositories.

```gradle
plugins {
    id 'maven-publish'
}
```

--------------------------------

### Maven Javadoc Aggregation Configuration

Source: https://docs.jitpack.io/building

Configuration for the maven-javadoc-plugin to aggregate Javadoc from multi-module Maven projects.

```xml
<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <artifactId>maven-javadoc-plugin</artifactId>
                <inherited>false</inherited>
                <configuration>
                    <aggregate>true</aggregate>
                </configuration>
                <executions>
                    <execution>
                        <id>aggregate</id>
                        <goals>
                            <goal>aggregate-jar</goal>
                        </goals>
                        <phase>package</phase>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </pluginManagement>
</build>
```

--------------------------------

### Maven Dependency Declaration for Multi-module

Source: https://docs.jitpack.io/building

How to declare a dependency on a specific module from a multi-module Maven project hosted on JitPack.

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

--------------------------------

### JitPack API Authentication

Source: https://docs.jitpack.io/api

Details on how to authenticate API requests, particularly for accessing private repositories. It specifies using basic authentication with an authentication token.

```APIDOC
API for private repositories uses basic authentication using your authentication token as the **username**. You can find your token on https://jitpack.io/private.
```

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

--------------------------------

### JitPack Authentication and Authorization

Source: https://docs.jitpack.io/faq

Details the process for re-authorizing JitPack with private repositories on GitHub. This involves signing out, revoking access on GitHub, and then re-authorizing through the JitPack authentication page.

```url
https://jitpack.io/auth
```

```url
https://github.com/settings/applications
```

--------------------------------

### JitPack Download Statistics API

Source: https://docs.jitpack.io/api

API endpoints for retrieving weekly and monthly download statistics for projects, optionally filtered by specific versions. Requires groupId and artifactId for project identification.

```APIDOC
GET /downloads/:groupId/:artifactId
  - Retrieves weekly and monthly download statistics for a given project.
  - Parameters:
    - groupId: The group identifier of the project.
    - artifactId: The artifact identifier of the project.
  - Example Usage:
    curl https://jitpack.io/api/downloads/com.github.jitpack/gradle-modular

GET /downloads/:groupId/:artifactId/:tag
  - Retrieves download statistics for a specific version (tag) of a project.
  - Parameters:
    - groupId: The group identifier of the project.
    - artifactId: The artifact identifier of the project.
    - tag: The specific version or tag of the project to get statistics for.
```

--------------------------------

### GitLab Subgroup Dependency Format

Source: https://docs.jitpack.io/private

Specifies the dependency format for repositories located within GitLab subgroups. The group and subgroup names are included in the Maven artifact coordinates.

```text
com.gitlab.GROUP.SUBGROUP:REPO:VERSION
```

--------------------------------

### Specify JDK Version in jitpack.yml

Source: https://docs.jitpack.io/building

Configure the Java Development Kit version for your JitPack build by defining the `jdk` property in your `jitpack.yml` file. This ensures your project is compiled with the specified Java version.

```yaml
jdk:
  - openjdk9
```

--------------------------------

### Add Library Dependency in build.gradle

Source: https://docs.jitpack.io/android

Demonstrates how to declare a dependency on a local library module within your application's build.gradle file. This is crucial for sample apps that need to consume the functionality of the main library module.

```gradle
dependencies {
    implementation project(':library')
}
```

--------------------------------

### JitPack Search API

Source: https://docs.jitpack.io/api

API endpoint for searching releases based on project name, groupId, or artifactId. Supports filtering by text and limiting results. The search query can target specific parts of the identifier.

```APIDOC
GET /search?q=text
  - Searches for projects containing the specified text in their name or groupId.
  - Parameters:
    - q: The search query string. Can be used to search by project name (default), artifactId (e.g., `q=:gradle-simple`), or groupId (e.g., `q=com.github.jitpack:`).
    - limit: (Optional) The maximum number of results to return. Defaults to 50.
  - Returns:
    - A JSON object mapping project identifiers to a list of their releases.
    - Example Response:
      {
        "com.github.jitpack:gradle-simple" : [ "1.0.4", "1.0.3" ],
        "com.github.jitpack:maven-simple" : [ "1.0", "0.1" ],
        "com.github.jitpack:android-example" : [ "1.0.5.rc1", "v1.0.4" ]
      }
```

--------------------------------

### Store JitPack Authentication Token in Gradle Properties

Source: https://docs.jitpack.io/private

This snippet demonstrates how to securely store your JitPack authentication token in the $HOME/.gradle/gradle.properties file. This token is used for authenticating with private JitPack repositories.

```Gradle
authToken=AUTHENTICATION_TOKEN
```
Tokens:
Raw