Skip to content

Commit d481d55

Browse files
authored
optimize: optimize the Readme and change documents (#7531)
1 parent f226c66 commit d481d55

File tree

4 files changed

+23
-208
lines changed

4 files changed

+23
-208
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
[![build](https://github.com/apache/incubator-seata/actions/workflows/build.yml/badge.svg)](https://github.com/apache/incubator-seata/actions/workflows/build.yml)
2424
[![codecov](https://codecov.io/gh/apache/incubator-seata/graph/badge.svg?token=tbmHt2ZfxO)](https://codecov.io/gh/apache/incubator-seata)
2525
[![license](https://img.shields.io/github/license/apache/incubator-seata.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
26-
[![maven](https://img.shields.io/maven-central/v/org.apache.seata/seata-all?versionSuffix=2.3.0)](https://central.sonatype.com/search?q=org.apache.seata%3Aseata-all)
26+
[![maven](https://img.shields.io/maven-central/v/org.apache.seata/seata-all?versionSuffix=2.4.0)](https://central.sonatype.com/search?q=org.apache.seata%3Aseata-all)
2727

2828
## What is Seata?
2929

@@ -101,7 +101,7 @@ For more details about principle and design, please go to [Seata wiki page](http
101101
Depending on the scenario, choose one of the two dependencies: `org.apache.seata:seata-all` or `org.apache.seata:seata-spring-boot-starter`.
102102
```xml
103103
<properties>
104-
<seata.version>2.3.0</seata.version>
104+
<seata.version>2.4.0</seata.version>
105105
</properties>
106106

107107
<dependencies>
@@ -157,11 +157,11 @@ Contributors are welcomed to join the Seata project. Please check [CONTRIBUTING]
157157
## Seata ecosystem
158158

159159
* [Seata Website](https://github.com/apache/incubator-seata.github.io) - Seata official website
160-
* [Seata GoLang](https://github.com/apache/incubator-seata-go) - Seata GoLang client and server
161-
* [Seata Samples](https://github.com/apache/incubator-seata-samples) - Samples for Seata
160+
* [Seata GoLang](https://github.com/apache/incubator-seata-go) - Seata GoLang client
161+
* [Seata Samples](https://github.com/apache/incubator-seata-samples) - Samples for Seata Java
162162
* [Seata GoLang Samples](https://github.com/apache/incubator-seata-go-samples) - Samples for Seata GoLang
163-
* [Seata K8s](https://github.com/apache/incubator-seata-k8s) - Seata integration with k8s
164-
* [Seata CLI](https://github.com/apache/incubator-seata-ctl) - CLI tool for Seata
163+
* [Seata K8s](https://github.com/apache/incubator-seata-k8s) - Seata integration with Kubernetes
164+
* [Seata CLI](https://github.com/apache/incubator-seata-ctl) - CLI tool for Seata operations
165165

166166
## Contributors
167167

build/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171

7272
<properties>
7373
<!-- seata version -->
74-
<revision>2.5.0-SNAPSHOT</revision>
74+
<revision>2.6.0-SNAPSHOT</revision>
7575

7676
<!-- Compiler settings properties -->
7777
<java.version>1.8</java.version>

changes/en-us/2.x.md

Lines changed: 8 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -20,136 +20,42 @@ Add changes here for all PR submitted to the 2.x branch.
2020

2121
### feature:
2222

23-
- [[#7261](https://github.com/apache/incubator-seata/pull/7261)] enforce account initialization and disable default credentials
24-
- [[#7451](https://github.com/apache/incubator-seata/pull/7451)] seata-server supports the HTTP/2 protocol
25-
- [[#7496](https://github.com/apache/incubator-seata/pull/7496)] add oceanbase oracle support
23+
- [[#PR_NO](https://github.com/seata/seata/pull/PR_NO)] 支持 XXX
2624

2725

2826
### bugfix:
2927

30-
- [[#7349](https://github.com/apache/incubator-seata/pull/7349)] Resolve NullPointerException in EtcdRegistryServiceImplMockTest
31-
- [[#7354](https://github.com/apache/incubator-seata/pull/7354)] fix the drivers in the libs folder cannot be loaded
32-
- [[#7356](https://github.com/apache/incubator-seata/pull/7356)] fix codecov bug
33-
- [[#7370](https://github.com/apache/incubator-seata/pull/7370)] fix ISSUE_TEMPLATE not work
34-
- [[#7397](https://github.com/apache/incubator-seata/pull/7397)] Resolve NullPointer and port binding errors
35-
- [[#7502](https://github.com/apache/incubator-seata/pull/7502)] remove extra dots and keep the naming style consistent with other tables
36-
- [[#7498](https://github.com/apache/incubator-seata/pull/7498)] fix the class name whitelist check issue in fury deserialization
37-
- [[#7504](https://github.com/apache/incubator-seata/pull/7504)] fix load driver class in Hikari
38-
- [[#7512](https://github.com/apache/incubator-seata/pull/7512)] fix the server does not send heartbeats when the namingserver is used with other registries
28+
- [[#PR_NO](https://github.com/seata/seata/pull/PR_NO)] 修复 XXX
3929

4030

4131
### optimize:
4232

43-
- [[#7270](https://github.com/apache/incubator-seata/pull/7270)] enhance ci configuration
44-
- [[#7282](https://github.com/apache/incubator-seata/pull/7282)] optimize unexpected NullPointerException in lookup method in FileRegistryServiceImpl class
45-
- [[#7310](https://github.com/seata/seata/pull/7310)] Optimize minor issues in the naming-server
46-
- [[#7329](https://github.com/apache/incubator-seata/pull/7329)] upgrade tomcat to 9.0.100
47-
- [[#7346](https://github.com/apache/incubator-seata/pull/7346)] replace tomcat with netty-http on the server
48-
- [[#7344](https://github.com/apache/incubator-seata/pull/7344)] raft mode performs transaction size check in advance
49-
- [[#7343](https://github.com/apache/incubator-seata/pull/7343)] upgrade tomcat to 9.0.104
50-
- [[#7337](https://github.com/apache/incubator-seata/pull/7337)] Add ChannelEventListener support to prevent memory leaks
51-
- [[#7344](https://github.com/apache/incubator-seata/pull/7344)] raft mode performs transaction size check in advance
52-
- [[#7345](https://github.com/apache/incubator-seata/pull/7345)] add empty check and duplicate type check to RegistryFactory
53-
- [[#7350](https://github.com/apache/incubator-seata/pull/7350)] optimize codecov.yml
54-
- [[#7360](https://github.com/apache/incubator-seata/pull/7360)] Update resource cleanup logic for channel disconnection
55-
- [[#7363](https://github.com/apache/incubator-seata/pull/7363)] Upgrade npmjs dependencies
56-
- [[#7372](https://github.com/apache/incubator-seata/pull/7372)] optimize license ignore
57-
- [[#7375](https://github.com/apache/incubator-seata/pull/7375)] optimize close() logic of discovery module
58-
- [[#7388](https://github.com/apache/incubator-seata/pull/7388)] optimize binary packaging directory structure
59-
- [[#7412](https://github.com/apache/incubator-seata/pull/7412)] Helm template adapted to the new version of seata
60-
- [[#7414](https://github.com/apache/incubator-seata/pull/7414)] Remove the unused defaultEventExecutorGroup from the NettyClientBootstrap
61-
- [[#7415](https://github.com/apache/incubator-seata/pull/7415)] Use threadPool to asynchronously process server http requests
62-
- [[#7418](https://github.com/apache/incubator-seata/pull/7418)] add jackson notice
63-
- [[#7419](https://github.com/apache/incubator-seata/pull/7419)] Add maven profile to support packaging source code
64-
- [[#7428](https://github.com/apache/incubator-seata/pull/7428)] pmd-check log as ERROR level
65-
- [[#7430](https://github.com/apache/incubator-seata/pull/7430)] Add support for parsing @RequestParam annotation in netty-http-server
66-
- [[#7432](https://github.com/apache/incubator-seata/pull/7432)] conditionally include test modules using Maven profiles
67-
- [[#7445](https://github.com/apache/incubator-seata/pull/7432)] separate the license from the server and namingserver
68-
- [[#7426](https://github.com/apache/incubator-seata/pull/7426)] add some license header
69-
- [[#7450](https://github.com/apache/incubator-seata/pull/7450)] Apply Spotless to the entire codebase
70-
- [[#7456](https://github.com/apache/incubator-seata/pull/7456)] Druid SQL parser throws ParserException for unsupported REPLACE statement
71-
- [[#7466](https://github.com/apache/incubator-seata/pull/7466)] add contribution intention check box to issue template
72-
- [[#7478](https://github.com/apache/incubator-seata/pull/7478)] metrics add retry status
73-
- [[#7483](https://github.com/apache/incubator-seata/pull/7483)] change the value of retryDeadThreshold to 70 seconds
74-
- [[#7488](https://github.com/apache/incubator-seata/pull/7488)] upgrade tomcat to 9.0.106
75-
- [[#7518](https://github.com/apache/incubator-seata/pull/7518)] avoid using unstable API in ChannelEventHandlerIntegrationTest
76-
- [[#7526](https://github.com/apache/incubator-seata/pull/7518)] optimze: optimize 1.2.12 test-druid ci
33+
- [[#PR_NO](https://github.com/seata/seata/pull/PR_NO)] 优化 XXX
7734

7835
### security:
7936

80-
- [[#PR_NO](https://github.com/seata/seata/pull/PR_NO)] upgrade XXX
37+
- [[#PR_NO](https://github.com/seata/seata/pull/PR_NO)] 升级 XXX
8138

8239
### test:
8340

84-
- [[#7092](https://github.com/apache/incubator-seata/pull/7092)] fix the issue of NacosMockTest failing to run
85-
- [[#7098](https://github.com/apache/incubator-seata/pull/7098)] Add unit tests for the `seata-common` module
86-
- [[#7160](https://github.com/apache/incubator-seata/pull/7160)] Refactored tests in `LowerCaseLinkHashMapTest` to use parameterized unit testing
87-
- [[#7167](https://github.com/apache/incubator-seata/pull/7167)] Refactored tests in `DurationUtilTest` to simplify and use parameterized unit testing
88-
- [[#7189](https://github.com/apache/incubator-seata/pull/7189)] fix the runtime exception in the saga test case
89-
- [[#7197](https://github.com/apache/incubator-seata/pull/7197)] add some UT cases for config module
90-
- [[#7199](https://github.com/apache/incubator-seata/pull/7199)] add some UT cases for client processor
91-
- [[#7203](https://github.com/apache/incubator-seata/pull/7203)] Refactored tests in rm.datasource.sql.Druid and seata-sqlparser-druid module
92-
- [[#7221](https://github.com/apache/incubator-seata/pull/7221)] add UT for gRPC Encoder/Decode
93-
- [[#7227](https://github.com/apache/incubator-seata/pull/7227)] add mock test for seata-discovery-consul module
94-
- [[#7233][https://github.com/apache/incubator-seata/pull/7233]] add mock test for seata-discovery-etcd3
95-
- [[#7243](https://github.com/apache/incubator-seata/pull/7243)] add unit test for seata-discovery-eureka
96-
- [[#7255](https://github.com/apache/incubator-seata/pull/7255)] more unit tests for Discovery-Eureka
97-
- [[#7286](https://github.com/apache/incubator-seata/pull/7286)] Simplified complex test testMsgSerialize in RaftSyncMessageTest by separating it into two tests
98-
- [[#7287](https://github.com/apache/incubator-seata/pull/7287)] Refactored testGetErrorMsgWithValidCodeReturnsExpectedMsg to use parameterized unit testing
99-
- [[#7288](https://github.com/apache/incubator-seata/pull/7288)] Refactored testSetCodeAndMsgUpdatesValuesCorrectly to use parameterized unit testing
100-
- [[#7294](https://github.com/apache/incubator-seata/pull/7294)] improved test testGetInsertParamsValue in SqlServerInsertRecognizerTest by splitting and parameterizing
101-
- [[#7295](https://github.com/apache/incubator-seata/pull/7295)] updated 3 tests in StringUtilsTest to use parameterized unit testing
102-
- [[#7205](https://github.com/apache/incubator-seata/issues/7205)] add UT for namingserver module
103-
- [[#7359](https://github.com/apache/incubator-seata/issues/7359)] merge submodule test reports
104-
- [[#7423](https://github.com/apache/incubator-seata/pull/7423)] add UT for org.apache.seata.spring.annotation.scannercheckers
105-
- [[#7420](https://github.com/apache/incubator-seata/pull/7420)] add UT for RemotingFactoryBeanParser class
106-
- [[#7379](https://github.com/apache/incubator-seata/issues/7379)] add UT for TccAnnotationProcessor class
107-
- [[#7422](https://github.com/apache/incubator-seata/pull/7422)] add UT for seata-spring-boot-starter module
108-
- [[#7433](https://github.com/apache/incubator-seata/pull/7433)] add UT for GlobalTransactionScanner class
109-
- [[#7436](https://github.com/apache/incubator-seata/pull/7436)] fix namingserver ut error
110-
- [[#7435](https://github.com/apache/incubator-seata/pull/7435)] Add common test config for dynamic server port assignment in tests
111-
- [[#7442](https://github.com/apache/incubator-seata/pull/7442)] add some UT for saga compatible
112-
- [[#7457](https://github.com/apache/incubator-seata/pull/7457)] improve unit test coverage of seata-rm moudle
113-
- [[#7464](https://github.com/apache/incubator-seata/pull/7464)] improve unit test coverage of seata-gRPC moudle
114-
- [[#7468](https://github.com/apache/incubator-seata/pull/7468)] add UT for SupportSqlWhereMethod class
115-
- [[#7501](https://github.com/apache/incubator-seata/pull/7501)] add unit test case for fury serializer
41+
- [[#PR_NO](https://github.com/seata/seata/pull/PR_NO)] 增加 XXX 测试用例
11642

11743
### refactor:
11844

119-
- [[#7315](https://github.com/apache/incubator-seata/pull/7315)] Refactor log testing to use ListAppender for more accurate and efficient log capture
120-
- [[#7461](https://github.com/apache/incubator-seata/pull/7461)] Refactor server netty config changed to use CONFIG format
45+
- [[#PR_NO](https://github.com/seata/seata/pull/PR_NO)] 重构 XXX
12146

12247

12348
### doc:
12449

125-
- [[#PR_NO](https://github.com/seata/seata/pull/PR_NO)] doc XXX
50+
- [[#7531](https://github.com/seata/seata/pull/7531)] 优化 Readme 和 change 文档
12651

12752

12853
Thanks to these contributors for their code commits. Please report an unintended omission.
12954

13055
<!-- Please make sure your Github ID is in the list below -->
13156

13257
- [slievrly](https://github.com/slievrly)
133-
- [Monilnarang](https://github.com/Monilnarang)
134-
- [xingfudeshi](https://github.com/xingfudeshi)
135-
- [wjwang00](https://github.com/wjwang00)
136-
- [YongGoose](https://github.com/YongGoose)
137-
- [JisoLya](https://github.com/JisoLya)
138-
- [YoWuwuuuw](https://github.com/YoWuwuuuw)
139-
- [PleaseGiveMeTheCoke](https://github.com/PleaseGiveMeTheCoke)
140-
- [funky-eyes](https://github.com/funky-eyes)
141-
- [xucq07](https://github.com/xucq07)
142-
- [PengningYang](https://github.com/PengningYang)
143-
- [WangzJi](https://github.com/WangzJi)
144-
- [maple525866](https://github.com/maple525866)
145-
- [YvCeung](https://github.com/YvCeung)
146-
- [jsbxyyx](https://github.com/jsbxyyx)
147-
- [simzyoo](https://github.com/simzyoo)
148-
- [Dltmd202](https://github.com/Dltmd202)
149-
- [diguage](https://github.com/diguage)
150-
- [GoodBoyCoder](https://github.com/GoodBoyCoder)
151-
- [xxsc0529](https://github.com/xxsc0529)
152-
- [xjlgod](https://github.com/xjlgod)
58+
- [GitHubID](https://github.com/GitHubID)
15359

15460

15561
Also, we receive many valuable issues, questions and advices from our community. Thanks for you all.

0 commit comments

Comments
 (0)