Skip to content

Commit c6d81fb

Browse files
committed
docs: updates package version + snapshot docs
1 parent 701c217 commit c6d81fb

2 files changed

Lines changed: 42 additions & 3 deletions

File tree

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Add the below dependency to the project's POM:
1818
<dependency>
1919
<groupId>com.factset.sdk</groupId>
2020
<artifactId>utils</artifactId>
21-
<version>1.0.1</version>
21+
<version>1.1.0-SNAPSHOT</version>
2222
</dependency>
2323
```
2424

@@ -32,10 +32,49 @@ repositories {
3232
}
3333
3434
dependencies {
35-
implementation "com.factset.sdk:utils:1.0.1"
35+
implementation "com.factset.sdk:utils:1.1.0-SNAPSHOT"
3636
}
3737
```
3838

39+
### Snapshot Releases
40+
41+
To be able to install snapshot releases of the sdk an additional repository must be added to the maven or gradle config.
42+
43+
#### Maven Snapshot Repository
44+
45+
```xml
46+
<repositories>
47+
<repository>
48+
<id>sonatype</id>
49+
<name>sonatype-snapshot</name>
50+
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
51+
<snapshots>
52+
<enabled>true</enabled>
53+
</snapshots>
54+
<releases>
55+
<enabled>false</enabled>
56+
</releases>
57+
</repository>
58+
</repositories>
59+
```
60+
61+
#### Gradle Snapshot Repository
62+
63+
```groovy
64+
repositories {
65+
mavenCentral()
66+
maven {
67+
url = uri("https://oss.sonatype.org/content/repositories/snapshots/")
68+
mavenContent {
69+
snapshotsOnly()
70+
}
71+
}
72+
}
73+
```
74+
75+
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)
76+
77+
3978
## Usage
4079

4180
This library contains multiple modules, sample usage of each module is below.

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ apply plugin: 'jacoco'
99
apply plugin: 'maven-publish'
1010

1111
group 'com.factset.sdk'
12-
version '1.0.1'
12+
version '1.1.0-SNAPSHOT'
1313

1414
dependencies {
1515
implementation 'org.slf4j:slf4j-api:1.7.36'

0 commit comments

Comments
 (0)