GitHub Package Registry integration examples for Java projects
Notice: GitHub Package Registry is not yet released and to be able to publish package into GitHub Package Registry you must have access to the public beta. To request to join the limited public beta, see the GitHub Package Registry page. You will be notified by email when you've gained access to public beta.
P.S. I don't know if there are requirements for public beta access to be able to download packages. Let me know it there are no requirements 🙂
- GitHub Package Registry Public Beta
- Repository Structure
- Useful Links
- Prerequisites
- Project Configuration to Publish Packages
- Few Words about Dependency Configuration
There are a few examples illustrating how to integrate GitHub Package Registry into your project:
- Configuring Maven project
maven ├── pom.xml ├── lib │ ├── pom.xml │ └── src │ ├── main │ │ └── java │ │ └── com.github.igabaydulin.ping │ │ └── Ping.java │ └── test │ └── java │ └── com.github.igabaydulin.ping │ └── PingTest.java └── sample ├── pom.xml └── src ├── main │ └── java │ └── com.github.igabaydulin.sample │ └── App.java └── test └── java └── com.github.igabaydulin.sample └── AppTest.java
- Configuring Gradle project
gradle-groovy ├── build.gradle ├── settings.gradle ├── gradle │ └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── lib │ ├── build.gradle │ └── src │ ├── main │ │ └── java │ │ └── com.github.igabaydulin.ping │ │ └── Ping.java │ └── test │ └── java │ └── com.github.igabaydulin.ping │ └── PingTest.java └── sample ├── build.gradle └── src ├── main │ └── java │ └── com.github.igabaydulin.sample │ └── App.java └── test └── java └── com.github.igabaydulin.sample └── AppTest.java
- Configuring Gradle project using Kotlin DSL
gradle-kotlin ├── build.gradle.kts ├── settings.gradle.kts ├── gradle │ └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── lib │ ├── build.gradle.kts │ └── src │ ├── main │ │ └── kotlin │ │ └── com.github.igabaydulin.ping │ │ └── Ping.kt │ └── test │ └── kotlin │ └── com.github.igabaydulin.ping │ └── PingTest.kt └── sample ├── build.gradle.kts └── src ├── main │ └── kotlin │ └── com.github.igabaydulin.sample │ └── App.kt └── test └── kotlin └── com.github.igabaydulin.sample └── AppTest.kt
- [1] About GitHub Package Registry
- [2] Managing packages with GitHub Package Registry
- [3] Configuring Apache Maven for use with GitHub Package Registry
As was mentioned before make sure you have an access to public beta 🙂 (you can use this link to sign up).
You need to create a personal access token with the read:packages and write:packages scopes to publish and download packages. This article explains how to create a personal access token.
As described in Configuring Apache Maven for use with GitHub Package Registry article
you need to provide Maven generated token (configuring Maven to use GitHub Registry as Maven repository along the way) by editing ~/.m2/settings.xml (if it does not exists create a new one).
Notice: It doesn't matter if you're using Gradle instead, create or modify ~/.m2/settings.xml as well.
~/.m2/settings.xml should look like this (example is taken from the article):
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd">
<activeProfiles>
<activeProfile>github</activeProfile>
</activeProfiles>
<profiles>
<profile>
<id>github</id>
<repositories>
<repository>
<id>central</id>
<url>https://repo1.maven.org/maven2</url>
<releases><enabled>true</enabled></releases>
<snapshots><enabled>true</enabled></snapshots>
</repository>
<repository>
<id>github</id>
<name>GitHub OWNER Apache Maven Packages</name>
<url>https://maven.pkg.github.com/OWNER</url>
</repository>
</repositories>
</profile>
</profiles>
<servers>
<server>
<id>github</id>
<username>USERNAME</username>
<password>TOKEN</password>
</server>
</servers>
</settings>where
OWNER: the repository/packages owner (if you wanna try to download packages from this repository, useigabaydulin)USERNAME: your GitHub usernameTOKEN: personal access token generated on the previous step
Besides providing the necessary Maven plugins (maven-deploy-plugin as an example) or using the built-in plugins versions
you need to configure where you will publish the package.
Add these lines in your pom.xml file:
<distributionManagement>
<repository>
<id>github</id> <!-- this id must be equal to id in ~/.m2/settings.xml file! -->
<name>GitHub igabaydulin Apache Maven Packages</name>
<url>https://maven.pkg.github.com/igabaydulin/github-package-registry-example</url>
</repository>
</distributionManagement>mvn deployYou can take a look at maven project for more details
By default Gradle does not use ~/.m2/settings.xml. To fix this we can use one of the Gradle plugins. I recommend to use
net.linguica.maven-settings plugin:
plugins {
id "net.linguica.maven-settings" version "0.5"
}To be able to publish packages you also must use maven-publish plugin:
id "maven-publish"
You can read about current publishing mechanism in this Gradle article. Your publishing configuration may look like this:
publishing {
publishing {
publications {
lib(MavenPublication) {
artifactId = "groovy-example-ping" // not required if you project name is equal to artifactId (in my example project has "lib" name)
from components.java // otherwise you will get an empty package and publishing step will be skipped
}
}
repositories {
maven {
name = "github" // must be equal to id in ~/.m2/settings.xml file!
url = uri("https://maven.pkg.github.com/igabaydulin/github-package-registry-example")
}
}
}
}./gradlew publishYou can take a look at gradle-groovy project for more details
The configuration is pretty the same as a previous one.
First, specify the necessery plugins:
plugins {
id("java-library")
id("org.jetbrains.kotlin.jvm") version "1.3.41"
id("maven-publish")
id("net.linguica.maven-settings") version "0.5"
}Second, configure publishing:
publishing {
publications {
create<MavenPublication>("lib") {
artifactId = "kotlin-example-ping"
from(components["java"])
}
}
repositories {
maven {
name = "github"
url = uri("https://maven.pkg.github.com/igabaydulin/github-package-registry-example")
}
}
}You can use the same command described in the previous section (obviously! 🤠):
./gradlew publishAnd as always you can take a look at gradle-kotlin project for more details
Add the next dependency:
<dependency>
<groupId>com.github.igabaydulin</groupId>
<artifactId>maven-example-ping</artifactId>
<version>1.1.0</version>
</dependency>And... that's it! 😃
Add the next dependency:
dependencies {
implementation 'com.github.igabaydulin:groovy-example-ping:1.1.0'
}And... and do not forget to provide maven-settings plugin:
plugins {
id("net.linguica.maven-settings") version "0.5"
}And... and specify repository to download the package:
repositories {
maven {
name = "github"
url = uri("https://maven.pkg.github.com/igabaydulin/github-package-registry-example")
}
}Note: I don't even know why this is required (maybe some lack of code in maven-settings plugin). If you know the reason, please, DM me :)
And... that's it! 😫
Pretty the same.
Add plugins:
plugins {
id("application")
id("org.jetbrains.kotlin.jvm") version "1.3.41"
id("net.linguica.maven-settings") version "0.5"
}Specify repository:
repositories {
jcenter()
maven {
name = "github"
url = uri("https://maven.pkg.github.com/igabaydulin/github-package-registry-example")
}
}Add dependency:
dependencies {
implementation("com.github.igabaydulin:kotlin-example-ping:1.1.0")
}