Skip to content

Commit 057295b

Browse files
authored
Update README and move to 5.6.1-SNAPSHOT (#617)
* Begin work on 5.6.1 * Update README * remove javadoc section
1 parent 879b173 commit 057295b

File tree

2 files changed

+28
-35
lines changed

2 files changed

+28
-35
lines changed

README.md

+27-34
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
ds3_java_sdk
22
============
33

4-
[![Build Status](https://travis-ci.com/SpectraLogic/ds3_java_sdk.svg)](https://travis-ci.com/SpectraLogic/ds3_java_sdk)
5-
<a href="https://scan.coverity.com/projects/4624">
6-
<img alt="Coverity Scan Build Status"
7-
src="https://scan.coverity.com/projects/4624/badge.svg"/>
8-
</a>
9-
[ ![Download](https://api.bintray.com/packages/spectralogic/ds3/ds3-sdk/images/download.svg) ](https://bintray.com/spectralogic/ds3/ds3-sdk/_latestVersion)
10-
[![Apache V2 License](http://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/SpectraLogic/ds3_java_sdk/blob/master/LICENSE.md) [![Open Hub project report for ds3_java_sdk](https://www.openhub.net/p/ds3_java_sdk/widgets/project_thin_badge.gif)](https://www.openhub.net/p/ds3_java_sdk?ref=sample)
4+
[![Latest release](https://img.shields.io/github/release/SpectraLogic/ds3_java_sdk.svg)](https://github.com/SpectraLogic/ds3_java_sdk/releases/latest)
5+
[![Maven Central](https://img.shields.io/maven-central/v/com.spectralogic.ds3/ds3-bom.svg)](https://search.maven.org/artifact/com.spectralogic.ds3/ds3-bom)
6+
[![Apache V2 License](http://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/SpectraLogic/ds3_java_sdk/blob/master/LICENSE.md)
7+
[![Open Hub project report for ds3_java_sdk](https://www.openhub.net/p/ds3_java_sdk/widgets/project_thin_badge.gif)](https://www.openhub.net/p/ds3_java_sdk?ref=sample)
118

129
## Contact Us
1310

@@ -21,57 +18,53 @@ If using Intellij, simply import the project as a Gradle project.
2118

2219
## Install
2320

24-
To install the latest `ds3_java_sdk` either download the latest release jar file from the [Releases](../../releases) page or clone the repository with `git clone https://github.com/SpectraLogic/ds3_java_sdk.git`, cd to `ds3_java_sdk` and run `./gradlew clean ds3-sdk:install` to install the sdk into your local maven repository. It is compatible with Java 8.
21+
To install the latest `ds3_java_sdk` either download the latest release jar file from the [Releases](../../releases) page or clone the repository with `git clone https://github.com/SpectraLogic/ds3_java_sdk.git`, cd to `ds3_java_sdk` and run `./gradlew clean ds3-sdk:install` to install the sdk into your local maven repository. It is compatible with Java 8 and is additionally tested against Java 11 and 17.
2522

26-
The SDK can also be included directly into a Maven or Gradle build. There is also a fatjar version that you can optionally use with the `all` classifier, take a look at the commented out code in the examples below. To include the SDK into maven add the following to the `pom.xml` file:
23+
Starting with the 5.6.0 release, the SDK is available on [Maven Central](https://central.sonatype.com/namespace/com.spectralogic.ds3) and can be included directly into a Maven or Gradle build. There is also a fatjar version that you can optionally use with the `all` classifier, take a look at the commented out code in the examples below. To include the SDK into maven add the following to the `pom.xml` file:
2724

2825
```xml
29-
3026
<project>
31-
...
32-
<repositories>
33-
<repository>
34-
<id>jitpack.io</id>
35-
<url>https://jitpack.io</url>
36-
</repository>
37-
</repositories>
3827
...
3928
<dependencies>
4029
...
4130
<dependency>
42-
<groupId>com.github.spectralogic</groupId>
43-
<artifactId>ds3_java_sdk</artifactId>
31+
<groupId>com.spectralogic.ds3</groupId>
32+
<artifactId>ds3-sdk</artifactId>
4433
<version>Tag</version>
4534
<!-- <classifier>all</classifier> -->
4635
</dependency>
4736
...
4837
</dependencies>
4938
</project>
39+
```
5040

41+
To include the sdk into Gradle include the following in the `build.gradle.kts` file:
42+
43+
```kotlin
44+
dependencies {
45+
implementation(platform("com.spectralogic.ds3:ds3-bom:Tag"))
46+
implementation("com.spectralogic.ds3:ds3-sdk")
47+
//implementation("com.spectralogic.ds3:ds3-sdk::all")
48+
}
5149
```
5250

53-
To include the sdk into Gradle include the following in the `build.gradle` file:
51+
or in the `build.gradle` file:
5452

5553
```groovy
5654
57-
allprojects {
58-
repositories {
59-
...
60-
maven { url 'https://jitpack.io' }
61-
}
62-
}
63-
6455
dependencies {
65-
implementation 'com.github.spectralogic:ds3_java_sdk:Tag'
66-
implementation 'com.github.spectralogic:ds3_java_sdk:Tag:all'
56+
implementation platform('com.spectralogic.ds3:ds3-bom:Tag')
57+
implementation 'com.spectralogic.ds3:ds3-sdk'
58+
//implementation 'com.spectralogic.ds3:ds3-sdk::all'
6759
}
68-
6960
```
70-
## Javadoc
7161

72-
The latest javadoc is located at [http://spectralogic.github.io/ds3_java_sdk/javadoc/](http://spectralogic.github.io/ds3_java_sdk/javadoc/)
62+
### Previous versions
63+
64+
Versions prior to 5.6.0 are available on [jitpack.io](https://jitpack.io/#SpectraLogic/ds3_java_sdk) under different maven coordinates. Unfortunately, the 5.6.0 version on jitpack.io is a pre-release version and is missing important fixes, and it is recommended that the artifacts on Maven Central are used going forward. To access versions earlier than 5.6.0, please see the instructions at https://jitpack.io/#SpectraLogic/ds3_java_sdk.
7365

7466
## Contributing
67+
7568
If you would like to contribute to the source code, sign the [Contributors Agreement](https://developer.spectralogic.com/contributors-agreement/) and make sure that your source conforms to our [Java Style Guide](https://github.com/SpectraLogic/spectralogic.github.com/wiki/Java-Style-Guide). For an overview of how we use Github, please review our [Github Workflow](https://github.com/SpectraLogic/spectralogic.github.com/wiki/Github-Workflow).
7669

7770
## Examples
@@ -105,7 +98,7 @@ The version is specified in `libs.versions.toml`:
10598
#
10699
# project version
107100
#
108-
ds3SdkVersion = "5.6.0"
101+
ds3SdkVersion = "5.6.1"
109102
```
110103

111-
When a release is created in github, it is automatically published on [jitpack.io](https://jitpack.io/#SpectraLogic/ds3_java_sdk).
104+
Once released, increment the minor version and add the suffix "-SNAPSHOT" to prepare for the next development cycle.

libs.versions.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
#
1717
# project version
1818
#
19-
ds3SdkVersion = "5.6.0"
19+
ds3SdkVersion = "5.6.1-SNAPSHOT"
2020
#
2121
# dependency versions
2222
#

0 commit comments

Comments
 (0)