Skip to content

Commit 246d646

Browse files
committed
Edit README posting a notice about the discontinuation of SDG 3.0.
1 parent 09b82dd commit 246d646

File tree

1 file changed

+94
-27
lines changed

1 file changed

+94
-27
lines changed

README.adoc

+94-27
Original file line numberDiff line numberDiff line change
@@ -4,65 +4,122 @@ image:https://spring.io/badges/spring-data-geode/ga.svg[Spring Data Geode,link=h
44

55
Spring Data for Apache Geode brings the full power of the Spring Framework to your Apache Geode applications.
66

7+
[[notice]]
8+
== NOTICE
9+
10+
As of Spring Data `2022.0.0-RC1` / _Turing_ / `3.0.0-RC1`, the _Spring Data for Apache Geode_ (SDG) module has been removed
11+
from the Spring Data BOM and Spring Data release train. SDG will no longer continue in the `3.0` generation
12+
from this point forward.
13+
14+
In short, a http://markmail.org/message/oafksl5iufmqhuyg[decision] was made by VMware to discontinue its contributions
15+
to the Apache Geode project at the Apache Software Foundation (ASF). VMware has committed to the Apache Geode project
16+
at ASF up until 2023-October-1. This puts the SDG project at odds with the Apache Geode project, particularly with
17+
respect to https://spring.io/projects/spring-data-geode#support[support timelines].
18+
19+
While SDG `2.7.x` is already GA and based on Apache Geode `1.14.x`, SDG `3.0` was targeting support for Apache Geode `1.15`
20+
(see https://geode.apache.org/releases/[releases]). Support of Apache Geode `1.15` will now move into
21+
_Spring Data for Apache Geode_ (SDG) `2.8`. SDG `2.8` will proceed with a series of milestone releases leading up to
22+
a final `2.8.0` GA in a relatively compressed timeframe. Release schedule and dates to be determined.
23+
24+
In addition, service releases of SDG `2.8`, for example, a SDG `2.8.1`, will only occur on an as needed basis to address
25+
any CVEs, bug reports, and to make minor enhancements as necessary in support of our users. No new or significant features,
26+
or additions will be made to SDG beyond `2.7`. SDG `2.8` will close out more than decade long tenure (since its inception
27+
in 2010) of the _Spring Data for Apache Geode_ project.
28+
29+
Finally, _Spring Data for VMware Tanzu GemFire_ (SDG) project will be the successor for the _Spring Data for Apache Geode_ project
30+
and restored as an externally managed and community-led project. SD GemFire will not be part of the Spring Data BOM,
31+
will not be released as part of the Spring Data release train and will not be maintained by the Spring (Data) team
32+
any longer. It will be solely managed and maintained by the VMware GemFire team in the VMware data org as
33+
an externally managed, community-led module.
34+
35+
Specifics of the _Spring Data for VMware Tanzu GemFire_ project and effort are beyond the scope this notice, but more
36+
details will be provided in a blog post (pending review and approval) and on the [Spring Data for VMware Tanzu GemFire]
37+
project page at https://spring.io[spring.io].
38+
39+
40+
[[features]]
741
== Features
842

9-
* XML namespace to https://docs.spring.io/spring-data-geode/docs/current/reference/html/#bootstrap[configure and create Apache Geode resources declaratively with Spring]
43+
* XML namespace to https://docs.spring.io/spring-data-geode/docs/current/reference/html/#bootstrap[configure and initialize Apache Geode resources declaratively with Spring]
1044
* Annotation model to https://docs.spring.io/spring-data/geode/docs/current/reference/html/#bootstrap-annotation-config[quickly and easily get started with Apache Geode out-of-the-box]
11-
* Simplifies https://docs.spring.io/spring-data/geode/docs/current/reference/html/#apis[working with Apache Geode APIs]
45+
* Simplifies https://docs.spring.io/spring-data/geode/docs/current/reference/html/#apis[development with Apache Geode APIs]
1246
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#apis:spring-cache-abstraction[Spring Cache Abstraction backed by Apache Geode]
1347
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#mapping[Spring Data Mapping infrastructure applied to POJOs stored in Apache Geode]
1448
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#gemfire-repositories[Spring Data Repositories backed by Apache Geode]
15-
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#apis:transaction-management[Apache Geode Cache Transactions through Spring's Declarative Transaction Management]
16-
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#apis:global-transaction-management[Additional support for using Apache Geode in Global, JTA Transactions through Spring's Declarative Transaction Management]
49+
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#apis:transaction-management[Apache Geode Cache Transactions using Spring's Declarative Transaction Management]
50+
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#apis:global-transaction-management[Additional support for using Apache Geode in Global, JTA Transactions using Spring's Declarative Transaction Management]
1751
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#serialization[Enhanced support for Apache Geode Serialization]
18-
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#function-annotations[Annotations for Function Executions]
52+
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#function-annotations[Annotations for Function Executions & Implementations]
1953
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#apis:continuous-query[Support for Continuous Query]
2054
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#bootstrap:lucene[Enhanced support for Apache Lucene Integration]
21-
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#gemfire-bootstrap[Bootstrapping a Spring Context with Apache Geode]
55+
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#gemfire-bootstrap[Bootstrapping a Spring Context within Apache Geode]
56+
* https://docs.spring.io/spring-data/geode/docs/current/reference/html/#bootstrap-annotation-config-security[Support for configuring Apache Geode Security with Apache Shiro]
2257
* Spring Tool Suite https://docs.spring.io/sts/nan/v310/NewAndNoteworthy.html[Spring Project Templates for Apache Geode]
2358

59+
60+
[[code-of-conduct]]
2461
== Code of Conduct
2562

26-
This project is governed by the https://github.com/spring-projects/.github/blob/e3cc2ff230d8f1dca06535aa6b5a4a23815861d4/CODE_OF_CONDUCT.md[Spring Code of Conduct]. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to [email protected].
63+
This project is governed by the https://github.com/spring-projects/.github/blob/e3cc2ff230d8f1dca06535aa6b5a4a23815861d4/CODE_OF_CONDUCT.md[Spring Code of Conduct].
64+
By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to
65+
2766

67+
68+
[[getting-started]]
2869
== Getting Started
2970

30-
Here is a quick teaser of an application using Spring Data Repositories in Java:
71+
Here is a quick teaser of a Spring application using Spring Data Repositories in Java:
3172

3273
[source,java]
3374
----
34-
public interface PersonRepository extends CrudRepository<Person, Long> {
75+
package com.example.app.model;
76+
77+
@Region("People")
78+
public class Customer {
3579
36-
List<Person> findByLastname(String lastname);
80+
private String firstName;
81+
private Strign lastName;
3782
38-
List<Person> findByFirstnameLike(String firstname);
83+
// Getters and Setter omitted
3984
}
4085
86+
package com.example.app.repo;
87+
88+
public interface CustomerRepository extends CrudRepository<Customer, Long> {
89+
90+
List<Person> findByLastnameLike(String lastname);
91+
92+
List<Person> findByFirstname(String firstname);
93+
}
94+
95+
package com.example.app.service;
96+
4197
@Service
42-
public class MyService {
98+
public class CustomereService {
4399
44-
private final PersonRepository repository;
100+
private final CustomerRepository repository;
45101
46-
public MyService(PersonRepository repository) {
102+
public MyService(CustomereService repository) {
47103
this.repository = repository;
48104
}
49105
50106
public void doWork() {
51107
52108
repository.deleteAll();
53109
54-
Person person = new Person();
55-
person.setFirstname("John");
56-
person.setLastname("Blum");
57-
repository.save(person);
110+
Customer customer = new Customer();
111+
customer.setFirstname("John");
112+
customer.setLastname("Blum");
58113
59-
List<Person> lastNameResults = repository.findByLastname("Blum");
60-
List<Person> firstNameResults = repository.findByFirstnameLike("J*");
114+
repository.save(customer);
115+
116+
List<Customer> lastNameResults = repository.findByLastnameLike("B%");
117+
List<Customer> firstNameResults = repository.findByFirstname("John");
61118
}
62119
}
63120
----
64121

65-
Configure a Pivotal Geode cache and Region (REPLICATE, PARTITION and so on):
122+
Configure an Apache Geode cache and Region (REPLICATE, PARTITION and so on):
66123

67124
[source,xml]
68125
----
@@ -75,12 +132,12 @@ Configure a Pivotal Geode cache and Region (REPLICATE, PARTITION and so on):
75132
http://www.springframework.org/schema/geode https://www.springframework.org/schema/geode/spring-geode.xsd
76133
http://www.springframework.org/schema/data/gemfire https://www.springframework.org/schema/data/geode/spring-data-gemfire.xsd">
77134
78-
<gfe:cache/>
135+
<gfe:client-cache/>
79136
80-
<gfe:partitioned-region id="ExampleRegion" copies="2">
137+
<gfe:client-region id="People" shortcut="LOCAL">
81138
82139
<bean id="gemfireTemplate" class="org.springframework.data.gemfire.GemfireTemplate" p:region-ref="ExampleRegion"/>
83-
<gfe-data:repositories base-package="com.acme"/>
140+
<gfe-data:repositories base-package="example.app"/>
84141
</beans>
85142
----
86143

@@ -97,7 +154,8 @@ Add the Maven dependency:
97154
</dependency>
98155
----
99156

100-
If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version.
157+
If you'd rather use the latest snapshots of the upcoming major/minor version, use our Maven snapshot repository
158+
and declare the appropriate dependency version:
101159

102160
[source,xml]
103161
----
@@ -108,12 +166,14 @@ If you'd rather like the latest snapshots of the upcoming major version, use our
108166
</dependency>
109167
110168
<repository>
111-
<id>spring-libs-snapshot</id>
169+
<id>spring-snapshot</id>
112170
<name>Spring Snapshot Repository</name>
113-
<url>https://repo.spring.io/libs-snapshot</url>
171+
<url>https://repo.spring.io/snapshot</url>
114172
</repository>
115173
----
116174

175+
176+
[[help]]
117177
== Getting Help
118178

119179
Having trouble with Spring Data? We’d love to help!
@@ -127,6 +187,8 @@ If you are just starting out with Spring, try one of the https://spring.io/guide
127187
You can also chat with the community on https://gitter.im/spring-projects/spring-data[Gitter].
128188
* Report bugs with Spring Data for Apache Geode at https://github.com/spring-projects/spring-data-geode/issues[github.com/spring-projects/spring-data-geode/issues].
129189

190+
191+
[[issues]]
130192
== Reporting Issues
131193

132194
Spring Data uses GitHub Issues as the issue tracking system to record bugs and feature requests. If you want to raise an issue, please follow the recommendations below:
@@ -138,6 +200,8 @@ https://github.com/spring-projects/spring-data-geode/issues[GitHub Issues] to se
138200
* If you need to paste code, or include a stack trace use markdown {backtick}{backtick}{backtick} escapes before and after your text.
139201
* If possible try to create a test case or project that reproduces the issue. Attach a link to your code or a compressed file containing your code.
140202

203+
204+
[[building-from-source]]
141205
== Building from Source
142206

143207
You don’t need to build from source to use Spring Data (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Data can be easily built with the https://github.com/takari/maven-wrapper[maven wrapper].
@@ -152,6 +216,8 @@ If you want to build with the regular `mvn` command, you will need https://maven
152216

153217
_Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] if you wish to submit pull requests, and in particular please sign the https://cla.pivotal.io/sign/spring[Contributor’s Agreement] before your first non-trivial change._
154218

219+
220+
[[building-ref-doc]]
155221
=== Building reference documentation
156222

157223
Building the documentation builds also the project without running tests.
@@ -164,6 +230,7 @@ Building the documentation builds also the project without running tests.
164230
The generated documentation is available from `target/site/reference/html/index.html`.
165231

166232

233+
[[license]]
167234
== License
168235

169236
Spring Data for Apache Geode is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].

0 commit comments

Comments
 (0)