From 265be6d12d28dda28c520eecb0dc001317233f3f Mon Sep 17 00:00:00 2001 From: Sina Madani Date: Sun, 27 Oct 2024 23:36:32 +0000 Subject: [PATCH] docs: Update uber-JAR build instructions --- .github/workflows/publish.yml | 2 +- CHANGELOG.md | 4 ++-- README.md | 20 +++++++++---------- pom.xml | 3 --- .../vonage/client/verify2/Verify2Client.java | 2 -- 5 files changed, 13 insertions(+), 18 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 4d3f09aa3..5e876e2ee 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -40,4 +40,4 @@ jobs: MAVEN_USERNAME: ${{ secrets.OSS_USERNAME }} MAVEN_PASSWORD: ${{ secrets.OSS_PASSWORD }} MAVEN_GPG_PASSPHRASE: ${{ secrets.SIGNING_PASSWORD }} - run: mvn -e --no-transfer-progress --batch-mode deploy -P release-sign-artifacts,uberjar + run: mvn -e --no-transfer-progress --batch-mode deploy -P release-sign-artifacts diff --git a/CHANGELOG.md b/CHANGELOG.md index f22b3586a..b2671e620 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,8 +2,8 @@ All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). -# [8.13.0] - 2024-1?-?? -- Added support for Verify Templates +# [8.13.0] - 2024-10-28 +- Added support for Verify custom templates # [8.12.0] - 2024-10-21 - Added `network_apis` capability to Application API diff --git a/README.md b/README.md index 3c27cd7eb..3a9fdfc08 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,10 @@ See all of our SDKs and integrations on the [Vonage Developer portal](https://de Releases are published to [Maven Central](https://central.sonatype.com/artifact/com.vonage/server-sdk). Instructions for your build system can be found in the snippets section. -Release notes can be found in the [changelog](CHANGELOG.md). +We *strongly recommend* that you use a tool that supports dependency management, +such as [Maven](https://maven.apache.org/), [Gradle](https://gradle.org/) or [Ivy](http://ant.apache.org/ivy/). + +Release notes for each version can be found in the [changelog](CHANGELOG.md). ### Build It Yourself @@ -67,17 +70,14 @@ Alternatively you can clone the repo and build the JAR file yourself: ```bash git clone git@github.com:vonage/vonage-java-sdk.git -mvn install +mvn install -P uberjar ``` -### Download everything in a ZIP file - -**Note**: We *strongly recommend* that you use a tool that supports dependency management, -such as [Maven](https://maven.apache.org/), [Gradle](https://gradle.org/) or [Ivy](http://ant.apache.org/ivy/). - -We provide a [ZIP file for each release](https://github.com/Vonage/vonage-java-sdk/releases/), -containing the Java Server SDK JAR, along with all the dependencies. Download the file, unzip it, and add the JAR files -to your project's classpath. +The `uberjar` profile will create a JAR file with all dependencies required to run the SDK included, +which can be found in the `target` directory. The `install` goal will make the SDK and its dependencies +available in your local Maven repository (usually located under your `~/.m2` directory), which can then +be used from other projects locally on your machine. To use this in a Gradle project, you need to include +the dependency co-ordinates and add `mavenLocal()` to the `repositories` block in your `build.gradle` file. ## Usage diff --git a/pom.xml b/pom.xml index a7d2552e2..77bfe5835 100644 --- a/pom.xml +++ b/pom.xml @@ -286,7 +286,6 @@ true - @@ -308,7 +307,6 @@ - org.sonatype.plugins nexus-staging-maven-plugin @@ -348,6 +346,5 @@ - diff --git a/src/main/java/com/vonage/client/verify2/Verify2Client.java b/src/main/java/com/vonage/client/verify2/Verify2Client.java index cc5fc14a2..9acde2f4f 100644 --- a/src/main/java/com/vonage/client/verify2/Verify2Client.java +++ b/src/main/java/com/vonage/client/verify2/Verify2Client.java @@ -264,7 +264,6 @@ ListTemplatesResponse listTemplates(Integer page, Integer pageSize) { *