Skip to content

Commit

Permalink
docs: updates package version + snapshot docs
Browse files Browse the repository at this point in the history
  • Loading branch information
granitdula committed Oct 23, 2023
1 parent 701c217 commit c6d81fb
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 3 deletions.
43 changes: 41 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Add the below dependency to the project's POM:
<dependency>
<groupId>com.factset.sdk</groupId>
<artifactId>utils</artifactId>
<version>1.0.1</version>
<version>1.1.0-SNAPSHOT</version>
</dependency>
```

Expand All @@ -32,10 +32,49 @@ repositories {
}
dependencies {
implementation "com.factset.sdk:utils:1.0.1"
implementation "com.factset.sdk:utils:1.1.0-SNAPSHOT"
}
```

### Snapshot Releases

To be able to install snapshot releases of the sdk an additional repository must be added to the maven or gradle config.

#### Maven Snapshot Repository

```xml
<repositories>
<repository>
<id>sonatype</id>
<name>sonatype-snapshot</name>
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
<releases>
<enabled>false</enabled>
</releases>
</repository>
</repositories>
```

#### Gradle Snapshot Repository

```groovy
repositories {
mavenCentral()
maven {
url = uri("https://oss.sonatype.org/content/repositories/snapshots/")
mavenContent {
snapshotsOnly()
}
}
}
```

Snapshot releases are cached by gradle for some time, for details see: [Gradle Dynamic Versions](https://docs.gradle.org/current/userguide/dynamic_versions.html#sub:declaring_dependency_with_changing_version)


## Usage

This library contains multiple modules, sample usage of each module is below.
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ apply plugin: 'jacoco'
apply plugin: 'maven-publish'

group 'com.factset.sdk'
version '1.0.1'
version '1.1.0-SNAPSHOT'

dependencies {
implementation 'org.slf4j:slf4j-api:1.7.36'
Expand Down

0 comments on commit c6d81fb

Please sign in to comment.