diff --git a/docs/docs/extra/libraries.md b/docs/docs/extra/libraries.md index d99eb32..89025f7 100644 --- a/docs/docs/extra/libraries.md +++ b/docs/docs/extra/libraries.md @@ -3,23 +3,6 @@ Drove is written in Java. We provide a few libraries that can be used to integrate with a Drove cluster. ## Setup -Drove libraries are hosted in Github Package Repository. To use this in Maven use the following repository entry: - -```xml - - - - github - https://maven.pkg.github.com/phonepe/drove - - false - - - true - - - -``` Setup the drove version ```xml @@ -30,68 +13,7 @@ Setup the drove version ``` !!!note "Checking the latest version" - Latest version can be checked at the github packages page [here](https://github.com/PhonePe/drove/packages/2229703){:target="_blank"} - -!!!danger "Accessing maven repo on github" - Public repos on github need authentication. In order to use these please follow the steps as mentioned below: - - - Create a Personal Access Token on github. - - Go to your account -> Settings -> Developer settings -> Personal access token -> Tokens (classic) -> Generate new token (classic) - (Basically create a PAT and add your username and password in maven-settings.xml or .m2/settings.xml for the repo `https://maven.pkg.github.com/phonepe/drove`). - - The only permission needed is `read:packages`. - - - Create a settings file or add required configurations to your `~/.m2/settings.xml`. - - Sample settings file: - ```xml - - - - github - - - - github - - - central - https://repo1.maven.org/maven2 - - - github - https://maven.pkg.github.com/phonepe/drove - - false - - - true - - - - - - - - - github - YOUR GITHUB USERNAME - YOUR PERSONAL ACCESS TOKEN - - - - - - ``` - > Your PAT works fine as the repo itself is public. - - To build: - ```shell - mvn -s /path/to/settings.xml clean package - ``` - - If setting up your github actions, please follow the steps in this excellent [stack-overflow answer](https://stackoverflow.com/questions/64706720/how-to-access-maven-dependency-from-github-packages-on-a-github-actions-workflow){:target="_blank"} to setup your actions correctly. + Latest version can be checked at the github packages page [here](https://central.sonatype.com/search?q=com.phonepe.drove){:target="_blank"} All libraries are located in sub packages of the top level package `com.phonepe.drove`.