Skip to content

Commit

Permalink
docs: Update uber-JAR build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
SMadani committed Oct 27, 2024
1 parent 8efdd21 commit 265be6d
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,25 +59,25 @@ 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

Alternatively you can clone the repo and build the JAR file yourself:

```bash
git clone [email protected]: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

Expand Down
3 changes: 0 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,6 @@
<value>true</value>
</property>
</activation>

<build>
<plugins>
<plugin>
Expand All @@ -308,7 +307,6 @@
</gpgArguments>
</configuration>
</plugin>

<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
Expand Down Expand Up @@ -348,6 +346,5 @@
</plugins>
</build>
</profile>

</profiles>
</project>
2 changes: 0 additions & 2 deletions src/main/java/com/vonage/client/verify2/Verify2Client.java
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,6 @@ ListTemplatesResponse listTemplates(Integer page, Integer pageSize) {
* <ul>
* <li><b>401</b>: Invalid credentials.</li>
* <li><b>402</b>: Low balance.</li>
* <li><b>403</b>: Template management is not enabled for your account.</li>
* <li><b>404</b>: Template ID was not found.</li>
* <li><b>429</b>: Rate limit hit. Please wait and try again.</li>
* <li><b>500</b>: An error occurred on the Vonage platform.</li>
Expand Down Expand Up @@ -390,7 +389,6 @@ ListTemplateFragmentsResponse listTemplateFragments(UUID templateId, Integer pag
* <ul>
* <li><b>401</b>: Invalid credentials.</li>
* <li><b>402</b>: Low balance.</li>
* <li><b>403</b>: Template management is not enabled for your account.</li>
* <li><b>404</b>: Fragment not found for the provided IDs.</li>
* <li><b>429</b>: Rate limit hit. Please wait and try again.</li>
* <li><b>500</b>: An error occurred on the Vonage platform.</li>
Expand Down

0 comments on commit 265be6d

Please sign in to comment.