Skip to content

Commit 9171586

Browse files
committed
Update readme to use the Elastic snapshots repository
1 parent 80a3d06 commit 9171586

File tree

1 file changed

+9
-31
lines changed

1 file changed

+9
-31
lines changed

README.md

Lines changed: 9 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -22,58 +22,38 @@ The `docs/design` folder contains records of the major decisions in the design o
2222

2323
### Installing the library
2424

25-
While it's a work in progress, snapshots of this library are published to a Maven repository hosted on [GitHub Packages](https://github.com/elastic/elasticsearch-java/packages/). To access it [you need a personal access token](https://github.com/settings/tokens) on your GitHub account that has the `read:packages` permission. This token should then be added to `~/.gradle/gradle.properties`:
26-
27-
```properties
28-
ESJavaGithubPackagesUsername=YOUR_GITHUB_USERNAME
29-
ESJavaGithubPackagesPassword=YOUR_GITHUB_TOKEN
30-
```
25+
This library requires at least Java 8.
3126

3227
Along with this library, you also need a JSON/object mapping library. `elasticsearch-java` has built-in support for [Jackson](https://github.com/FasterXML/jackson) and [JSON-B](http://json-b.net/) implementations such as [Eclipse Yasson](https://github.com/eclipse-ee4j/yasson).
3328

34-
This library requires at least Java 8.
29+
While it's a work in progress, snapshots of this library are published to Elastic's snapshot repository. Snapshots are currently available for the upcoming version 7.15.0, built from the `7.x` branch.
3530

3631
Gradle project (Groovy flavor) setup using Jackson:
3732

3833
```groovy
3934
repositories {
4035
mavenCentral()
4136
maven {
42-
name = "ESJavaGithubPackages"
43-
url = uri("https://maven.pkg.github.com/elastic/elasticsearch-java")
44-
credentials(PasswordCredentials)
37+
name = "Elastic-Snapshots"
38+
url = uri("https://snapshots.elastic.co/maven")
4539
}
4640
}
4741
4842
dependencies {
49-
implementation 'co.elastic.clients:elasticsearch-java:8.0.0-SNAPSHOT'
43+
implementation 'co.elastic.clients:elasticsearch-java:7.15.0-SNAPSHOT'
5044
implementation 'com.fasterxml.jackson.core:jackson-databind:2.12.3'
5145
}
5246
```
5347

54-
If you are using Maven, you need to add the credentials in your `~/.m2/settings.xml`:
55-
56-
```xml
57-
<settings>
58-
<servers>
59-
<server>
60-
<id>ESJavaGithubPackages</id>
61-
<username>YOUR_GITHUB_USERNAME</username>
62-
<password>YOUR_GITHUB_TOKEN</password>
63-
</server>
64-
</servers>
65-
</settings>
66-
```
67-
6848
In the `pom.xml` for your project add the following repository definition and dependencies:
6949

7050
```xml
7151
<project>
7252

7353
<repositories>
7454
<repository>
75-
<id>ESJavaGithubPackages</id>
76-
<url>https://maven.pkg.github.com/elastic/elasticsearch-java</url>
55+
<id>Elastic-Snapshots</id>
56+
<url>https://snapshots.elastic.co/maven</url>
7757
<snapshots>
7858
<enabled>true</enabled>
7959
</snapshots>
@@ -84,7 +64,7 @@ In the `pom.xml` for your project add the following repository definition and de
8464
<dependency>
8565
<groupId>co.elastic.clients</groupId>
8666
<artifactId>elasticsearch-java</artifactId>
87-
<version>8.0.0-SNAPSHOT</version>
67+
<version>7.15.0-SNAPSHOT</version>
8868
</dependency>
8969
<dependency>
9070
<groupId>com.fasterxml.jackson.core</groupId>
@@ -125,9 +105,7 @@ if (search.hits().hits().isEmpty()) {
125105

126106
## Compatibility
127107

128-
The `main` branch targets the upcoming Elasticsearch 8.0. Support is still incomplete as the API code is generated from the [Elasticsearch Specification](https://github.com/elastic/elasticsearch-specification) that is also still a work in progress.
129-
130-
As the work on the specification comes to completion, an additional `7.x` branch will provide support for the corresponding versions of Elasticsearch.
108+
The `main` branch targets the next major release (8.0) and the `7.x` branch targets the next minor release. Support is still incomplete as the API code is generated from the [Elasticsearch Specification](https://github.com/elastic/elasticsearch-specification) that is also still a work in progress.
131109

132110
## Current status
133111

0 commit comments

Comments
 (0)