https://github.com/oczi/release-watcher
A small API to request github releases (<10 kb size).
https://github.com/oczi/release-watcher
Last synced: 6 days ago
JSON representation
A small API to request github releases (<10 kb size).
- Host: GitHub
- URL: https://github.com/oczi/release-watcher
- Owner: OcZi
- License: mit
- Created: 2022-12-25T11:25:26.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-25T11:38:44.000Z (over 2 years ago)
- Last Synced: 2025-04-13T22:11:31.577Z (2 months ago)
- Language: Java
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Release Watcher
A small API to request github releases (<10 kb size).
Methods of release are inspired by python's version info.
Supports Gson as deserializer of http requests (Jackson and other libs can be adapted).
## Usage
```java
import me.oczi.release.GithubReleases;
import me.oczi.release.Release;
class MyClass {
public static void main(String[] args) {
// Create the service to request releases
GsonReleaseService service = new GsonReleaseService(
GithubReleases.of("OcZi", "Margaret") // Build the release URL of the repository
);
// Wait CompletableFuture to finish
Release[] releases = service.requestLastRelease().join();
// Github will return it in date order
Release lastRelease = releases[0];
// New version found?
if (lastRelease.isGreaterThan(0, 8)) {
System.out.println("New version available: " + lastRelease.getVersion());
}
}
}
```
## Dependency
### Maven:
```xml
unnamed-snapshots
https://repo.unnamed.team/repository/unnamed-snapshots/
me.oczi
release-watcher-api
1.0-SNAPSHOT
compile
me.oczi
release-watcher-gson
1.0-SNAPSHOT
compile
```
### Gradle:
```groovy
repositories {
maven { url 'https://repo.unnamed.team/repository/unnamed-snapshots/' }
}
// Without deserializer
compileOnly('me.oczi:release-watcher-api:1.0-SNAPSHOT')
// Gson deserializer
// It compiles API too
compileOnly('me.oczi:release-watcher-gson:1.0-SNAPSHOT')
```
## Build
JDK: Minimum 8
Gson: Minimum 2.2.4