Skip to content

Easy and lightweight GitHub release parser written in Java using Gson and HTTP Requests.

License

Notifications You must be signed in to change notification settings

neziw/ReleaseChecker

Folders and files

NameName
Last commit message
Last commit date
Jan 30, 2025
Jun 28, 2024
Jun 28, 2024
Jan 26, 2025
Oct 19, 2024
Jun 28, 2024
Jun 28, 2024
Jun 28, 2024
Jun 29, 2024
Jun 28, 2024
Oct 21, 2024
Jan 31, 2025
Jun 28, 2024
Jun 28, 2024
Jan 26, 2025
Jul 11, 2024
Jun 29, 2024
Jun 28, 2024

Repository files navigation

ReleaseChecker

Easy and lightweight GitHub release parser written in Java using Gson and HTTPS Requests.

Example Usage:

// https://github.com/nats-io/nats.java
final ReleaseCheck releaseCheck = ReleaseCheckBuilder.builder()
    .setRepositoryOwner("nats-io")
    .setRepositoryName("nats.java")
    .build();

System.out.println("Latest version: " + releaseCheck.getLatestRelease().tagName());
System.out.println("Is a newer version available: " + releaseCheck.isNewerVersionAvailable("2.20.1"));

//You can also get all available releases using 'ReleaseCheck#getReleaseDataList()'

final int behindCount = releaseCheck.getBehindCount("2.20.1");

if (behindCount == -1) {
    System.out.println("There is no such tag.");
} else if (behindCount == 0) {
    System.out.println("You are using the latest version.");
} else {
    System.out.println("Your version is " + behindCount + " versions behind the latest.");
}

Output (since 19/10/2024):

Latest version: 2.20.2
Is a newer version available: true
Your version is 1 versions behind the latest.

Adding dependency

Maven:

<repositories>
    <repository>
        <id>neziw-repo</id>
        <url>https://repo.neziw.ovh/releases</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>ovh.neziw</groupId>
        <artifactId>ReleaseChecker</artifactId>
        <version>1.0.2</version>
    </dependency>
</dependencies>

Gradle:

repositories {
    maven {
        name "neziw-repo"
        url "https://repo.neziw.ovh/releases"
    }
}

implementation "ovh.neziw:ReleaseChecker:1.0.2"

Special thanks to JetBrains company for providing development tools used to develop this project.

JetBrains