In this technical post, we will go over the process of publishing a Spring Boot library to JFrog. NOTE: If you want to know more about creating a Spring application, please go to my previous post getting started with Spring Boot here. Let’s begin creating a new Spring Boot project with Web and Lombok.
spring init --dependencies=web,lombok --build=gradle --language=java juice-restclient
Now, let’s activate Maven publish plugin:
apply plugin: 'maven-publish'
And add our Gradle publishing task definition.
publishing {
publications {
mavenJava(MavenPublication) {
from components.java
versionMapping {
usage('java-api') {
fromResolutionOf('runtimeClasspath')
}
usage('java-runtime') {
fromResolutionResult()
}
}
}
}
repositories {
maven {
url = "https://jfrog.josdem.io/artifactory/libs-snapshot-local"
allowInsecureProtocol = true
credentials {
username = "${artifactory_user}"
password = "${artifactory_password}"
}
}
}
}
In this publishing section, we are defining, artifact id and group id taken from our build.gradle definition; versioning is handled by versionMapping DSL, which allows configuring version strategies; if you want to know more about it, please go here. JFrog Platform hosts local, virtual and remote repository types; in this case, we are using libs-snapshot-local to publish our library. This is our complete build.gradle file.
plugins {
id 'org.springframework.boot' version '3.2.2'
id 'io.spring.dependency-management' version '1.1.4'
id 'java'
}
ext {
artifactory_user = "$System.env.ARTIFACTORY_USER"
artifactory_password = "$System.env.ARTIFACTORY_PASSWORD"
}
apply plugin: 'maven-publish'
group = 'com.josdem.jugoterapia.webclient'
version = '1.0.0-SNAPSHOT'
java {
sourceCompatibility = '17'
}
configurations {
compileOnly {
extendsFrom annotationProcessor
}
}
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
testImplementation 'io.projectreactor:reactor-test'
testCompileOnly 'org.projectlombok:lombok'
testAnnotationProcessor 'org.projectlombok:lombok'
}
publishing {
publications {
mavenJava(MavenPublication) {
from components.java
versionMapping {
usage('java-api') {
fromResolutionOf('runtimeClasspath')
}
usage('java-runtime') {
fromResolutionResult()
}
}
}
}
repositories {
url = "https://jfrog.josdem.io/artifactory/libs-snapshot-local"
maven {
credentials {
username = "${artifactory_user}"
password = "${artifactory_password}"
}
}
}
}
tasks.named('test') {
useJUnitPlatform()
}
If you want to see a complete example how to publish with extra information, please go here. We are passing artifactory credentials using system properties, so publishing from the command line will be
export ARTIFACTORY_USER=${username}
export ARTIFACTORY_PASSWORD=${password}
gradle publish
where:
${username}Is artifactory username${password}Is artifactory password
Publishing using Maven
With Maven you need to specify in the distributionManagement section repository id, which in this case should be snapshots and URL. Plus repositories, specifying your artifactory server:
<distributionManagement>
<repository>
<id>snapshots</id>
<url>https://jfrog.josdem.io/artifactory/libs-snapshot-local</url>
</repository>
</distributionManagement>
<repositories>
<repository>
<snapshots/>
<id>snapshots</id>
<name>libs-snapshot</name>
<url>https://jfrog.josdem.io/artifactory/libs-snapshot</url>
</repository>
</repositories>
Do not forget to set up your Jfrog credentials in the ${USER_HOME}/.m2/settings.xml file
<settings>
<servers>
<server>
<username>username</username>
<password>password</password>
<id>snapshots</id>
</server>
</servers>
</settings>
Here is the complete pom.xml file:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.2.2</version>
<relativePath/>
</parent>
<groupId>com.josdem.fruitypedia</groupId>
<artifactId>restclient</artifactId>
<version>1.0.0-SNAPSHOT</version>
<name>rest-client</name>
<description>This is a library that shows how to test a third-party service using rest-client</description>
<properties>
<java.version>17</java.version>
</properties>
<distributionManagement>
<repository>
<id>snapshots</id>
<url>https://jfrog.josdem.io/artifactory/libs-snapshot-local</url>
</repository>
</distributionManagement>
<repositories>
<repository>
<snapshots/>
<id>snapshots</id>
<name>libs-snapshot</name>
<url>https://jfrog.josdem.io/artifactory/libs-snapshot</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
</project>
To publish library to artifactory
mvn deploy
If you want to learn more and publish your own library, feel free to drop me a message on my home page website and ask for a Jfrog credentials. To browse the project go here, to download the project:
git clone git@github.com:josdem/juice-restclient.git