How to add GitHub Package Registry package as a Gradle dependency

Question

So, I have a GitHub project with a Package Registry configured. It has two packages:

Package pages have instructions only for Maven, besides that, the instructions are broken (maven install so57323260 is not a valid way to add a dependency in Maven):

Question is: how do I add that package in a Gradle build?

Answer 1

New answer:

GitHub has published the official guide: Configuring Gradle for use with GitHub Packages.

---

Old answer:

First, configure Github Package Registry as a Maven repository in your Gradle build config:

build.gradle.kts:

repositories {
    jcenter()
    maven("https://maven.pkg.github.com/madhead") {
        credentials {
            username = "madhead"
            password = "<token>"
        }
    }
}

You can generate a token in your account settings page.

Now, add a dependency like:

build.gradle.kts:

dependencies {
    implementation("so57323260:so57323260:1.0.0")
    implementation("so57323260:test:1.0.2")
}

Here groupId is the repo's name and artifactId is the name of the published package.

Answer 2

For those who are worried about the security of personal access token, the official guide suggests to access the username and password through Gradle property or system property.

Step1: Set USERNAME and TOKEN as system property (with export or set), or create a gradle.properties file under the project root folder like this:

gpr.user=<USERNAME>
gpr.token=<TOKEN>

Step2: Add the Github package registry with authentication in build.gradle:

    repositories {
        maven {
            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/OWNER/REPOSITORY")
            credentials {
                username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
                password = project.findProperty("gpr.token") ?: System.getenv("TOKEN")
            }
        }
    }

Step 3: Add the package you want to consume in build.gradle:

dependencies {
    implementation 'com.example:package:version'
}

For more details (including how to config Maven), see the instructions in the Wiki I contributed here: https://github.com/GumTreeDiff/gumtree/wiki/Getting-Started