Skip to content

Commit 00cf3e0

Browse files
authored
Merge pull request #1177 from domaframework/docs/version-and-release
Update README.md and RELEASE_OPERATIONS.md
2 parents 3a83634 + cfd71b9 commit 00cf3e0

File tree

2 files changed

+15
-39
lines changed

2 files changed

+15
-39
lines changed

README.md

Lines changed: 11 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Doma has various strengths:
1010
- Uses SQL templates, called "two-way SQL".
1111
- Has no dependence on other libraries.
1212

13+
The latest major version of Doma supports Java 17 and above.
14+
1315
[![Build Status](https://github.com/domaframework/doma/workflows/Java%20CI%20with%20Gradle/badge.svg)](https://github.com/domaframework/doma/actions?query=workflow%3A%22Java+CI+with+Gradle%22)
1416
[![javadoc](https://javadoc.io/badge2/org.seasar.doma/doma-core/javadoc.svg)](https://javadoc.io/doc/org.seasar.doma/doma-core)
1517
[![project chat](https://img.shields.io/badge/zulip-join_chat-green.svg)](https://domaframework.zulipchat.com)
@@ -20,14 +22,12 @@ Examples
2022

2123
### Type-safe Criteria API
2224

23-
Written in Java:
24-
2525
```java
26-
Entityql entityql = new Entityql(config);
27-
Employee_ e = new Employee_();
28-
Department_ d = new Department_();
26+
var entityql = new Entityql(config);
27+
var e = new Employee_();
28+
var d = new Department_();
2929

30-
List<Employee> list = entityql
30+
var employees = entityql
3131
.from(e)
3232
.innerJoin(d, on -> on.eq(e.departmentId, d.departmentId))
3333
.where(c -> c.eq(d.departmentName, "SALES"))
@@ -38,31 +38,11 @@ List<Employee> list = entityql
3838
.fetch();
3939
```
4040

41-
Written in Kotlin:
42-
43-
```kotlin
44-
val entityql = KEntityql(config)
45-
val e = Employee_()
46-
val d = Department_()
47-
48-
val list = entityql
49-
.from(e)
50-
.innerJoin(d) { eq(e.departmentId, d.departmentId) }
51-
.where { eq(d.departmentName, "SALES") }
52-
.associate(e, d) { employee, department ->
53-
employee.department = department
54-
department.employeeList += employee
55-
}
56-
.fetch()
57-
```
58-
5941
See [Criteria API](https://doma.readthedocs.io/en/latest/criteria-api/)
6042
for more information.
6143

6244
### SQL templates
6345

64-
Written in Java:
65-
6646
```java
6747
@Dao
6848
public interface EmployeeDao {
@@ -180,11 +160,11 @@ Major versions
180160

181161
### Status and Repository
182162

183-
| Version | Status | Repository | Branch |
184-
|----------------------------------------|--------|----------------------------------------|--------|
185-
| [Doma 1](http://doma.seasar.org/) | stable | https://github.com/seasarorg/doma/ | master |
186-
| [Doma 2](http://doma.readthedocs.org/) | stable | https://github.com/domaframework/doma/ | 2.x |
187-
| [Doma 3](http://doma.readthedocs.org/) | stable | https://github.com/domaframework/doma/ | master |
163+
| Version | Status | Repository | Branch |
164+
|----------------------------------------|-----------------|----------------------------------------|--------|
165+
| [Doma 1](http://doma.seasar.org/) | limited-support | https://github.com/seasarorg/doma/ | master |
166+
| [Doma 2](http://doma.readthedocs.org/) | limited-support | https://github.com/domaframework/doma/ | 2.x |
167+
| [Doma 3](http://doma.readthedocs.org/) | stable | https://github.com/domaframework/doma/ | master |
188168

189169
### Compatibility matrix
190170

RELEASE_OPERATIONS.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,11 @@ If the above command is successful, the following directories will contain the n
3232
- https://repo1.maven.org/maven2/org/seasar/doma/doma-kotlin/
3333
- https://repo1.maven.org/maven2/org/seasar/doma/doma-processor/
3434
- https://repo1.maven.org/maven2/org/seasar/doma/doma-slf4j/
35+
- https://repo1.maven.org/maven2/org/seasar/doma/doma-template/
3536

3637
## Publish documentation
3738

38-
(No operation required)
39-
40-
The webhook publishes documentation to the [ReadTheDocs](https://doma.readthedocs.io/en/latest/).
41-
42-
See also [Incoming Webhooks and Automation](https://docs.readthedocs.io/en/stable/webhooks.html).
39+
Creating a new tag at [domaframework/doma-docs](https://github.com/domaframework/doma-docs) will trigger synchronization with [ReadTheDocs](https://doma.readthedocs.io/en/latest/).
4340

4441
## Publish release notes
4542

@@ -49,6 +46,5 @@ and publish release notes.
4946
## Announce the release
5047

5148
Announce the release of new version using
52-
[Twitter](https://twitter.com/domaframework),
53-
[Zulip](https://domaframework.zulipchat.com), and
54-
[Google Group](https://groups.google.com/g/doma-user).
49+
[Twitter](https://twitter.com/domaframework) and
50+
[Zulip](https://domaframework.zulipchat.com).

0 commit comments

Comments
 (0)