WARNING: This is Work in Progress
Technically this Library is functional, but not completely finished and breaking changes could come any time!
The automatic generated Documentation is also not 100% correct or working!
Building the API client library requires Maven to be installed.
To install the API client library to your local Maven repository, simply execute:
mvn installTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn deployRefer to the official documentation for more information.
After the client library is installed/deployed, you can use it in your Maven project by adding the following to your pom.xml:
<dependency>
<groupId>de.codemakers</groupId>
<artifactId>radarr4j</artifactId>
<version>3.1.0</version>
<scope>compile</scope>
</dependency>Or to your build.gradle:
implementation group: "de.codemakers", name: "radarr4j", version: "3.1.0"Make sure you have set up your local Git Hooks:
git config core.hooksPath .githooksThis will make sure your commit messages follow the Conventional Commits Specification.
Here's some handy commands:
| Command | Usage |
|---|---|
gradle test |
Run the tests. |
gradle build |
Run the builds. |
gradle shadowJar |
Create the Uber Jar with all Dependencies. |
This project uses standard-release to update the version in the build.gradle file from the changes in the history and to create the CHANGELOG.md file.
Any time you want to cut a new release, run:
npx dwmkerr/standard-version --signThis will:
- Update the
CHANGELOG.md - Update the version number based on the commit history
- Create a git tag with the new version number
Finally, just push the tag to trigger a deployment of the new version:
git push --follow-tags