This is an automated email from the ASF dual-hosted git repository.
xingfudeshi pushed a commit to branch docusaurus
in repository https://gitbox.apache.org/repos/asf/incubator-seata-website.git
The following commit(s) were added to refs/heads/docusaurus by this push:
new c511a4cc095 optimize doc format (#1065)
c511a4cc095 is described below
commit c511a4cc095f5c81d3b1950705a805859e197eea
Author: Jiangke Wu <[email protected]>
AuthorDate: Mon Jan 26 17:40:32 2026 +0800
optimize doc format (#1065)
---
.../developers/release-guide/release-guide_dev.md | 52 +++++++++++-----------
.../developers/release-guide/release-guide_dev.md | 52 +++++++++++-----------
2 files changed, 52 insertions(+), 52 deletions(-)
diff --git
a/i18n/en/docusaurus-plugin-content-docs/current/developers/release-guide/release-guide_dev.md
b/i18n/en/docusaurus-plugin-content-docs/current/developers/release-guide/release-guide_dev.md
index 34aeaab5f84..4a5a1ca9f38 100644
---
a/i18n/en/docusaurus-plugin-content-docs/current/developers/release-guide/release-guide_dev.md
+++
b/i18n/en/docusaurus-plugin-content-docs/current/developers/release-guide/release-guide_dev.md
@@ -8,7 +8,7 @@ description: Release Guide.
## 1. Introduction
-#### 1.1 Apache Seata™ (incubating) Release Documentation
+### 1.1 Apache Seata™ (incubating) Release Documentation
Refer to the following links to understand the ASF release process:
@@ -16,7 +16,7 @@ Refer to the following links to understand the ASF release
process:
- [Apache Release Policy](http://www.apache.org/dev/release.html)
- [Maven Release
Info](http://www.apache.org/dev/publishing-maven-artifacts.html)
-#### 1.2 PGP Signatures
+### 1.2 PGP Signatures
Following the Apache Release Guidelines, release versions must be signed,
allowing users to verify if downloaded versions have been tampered with.
@@ -125,7 +125,7 @@ gpg: sending key XXXXXXXX to hkp server keys.openpgp.org
```
-#### 1.3 POM Configuration
+### 1.3 POM Configuration
Configure the POM file to deploy versions to the ASF Nexus repository.
@@ -179,21 +179,21 @@ Configure the POM file to deploy versions to the ASF
Nexus repository.
**Tips:** It's recommended to use [Maven's password encryption
capabilities](http://maven.apache.org/guides/mini/guide-encryption.html) to
encrypt `gpg.passphrase`
-#### 1.5 Publishing Release Notes
+#### 1.4 Publishing Release Notes
Build Release Notes for the respective version through the
[changelog](https://github.com/apache/incubator-seata/blob/2.x/changes/zh-cn/2.x.md).
## 2. Release Process
-### 1. Preparing the Branch
+### 2.1 Preparing the Branch
Create a new branch from the main branch as the release branch. For instance,
if you're releasing version `${release_version}`, create a new branch
`${release_version}` from the development branch. All changes, tags, and fixes
related to the `${release_version}` Release Candidates should be made on this
branch. Ensure all GitHub Actions CI tests pass on this branch. After the
release is completed, merge it back into the main branch.
Example: To release Java SDK version `2.2.0`, create a new branch `2.2.0` from
the `2.x` branch, and commit changes to replace the Snapshot version number
with the `2.2.0` version number on this branch.
-### 2. Pre-Release Binary Packages
+### 2.2 Pre-Release Binary Packages
-#### 2.1 Prepare the SDK release according to [publishing maven
artifacts](https://infra.apache.org/publishing-maven-artifacts.html) [4]
guidelines.
+#### 1) Prepare the SDK release according to [publishing maven
artifacts](https://infra.apache.org/publishing-maven-artifacts.html) [4]
guidelines.
```
mvn clean deploy -Prelease -DskipTests -e -B
-Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn
@@ -203,19 +203,19 @@ At this point, the Seata SDK is published to the [staging
repository](https://re
Note: If closing fails, it's likely because the public key corresponding to
your signing key is not available on keys.openpgp.org. Please verify through
[OpenPGP Keyserver (ubuntu.com)](https://keyserver.ubuntu.com/)
-#### 2.2 Submit Source & Binary to SVN Repository
+#### 2) Submit Source & Binary to SVN Repository
-##### 2.2.1 Install SVN
+##### a. Install SVN
Download and install [Apache Subversion
Sources](https://subversion.apache.org/download.cgi#recommended-release)
Or install via `brew install subversion`
-##### 2.2.2 Compile seata-server and seata-namingserver
+##### b. Compile seata-server and seata-namingserver
`mvn -Prelease-seata -Dmaven.test.skip=true -T4C -Dpmd.skip=true clean
install -U`
-##### 2.2.3 Sign Source and Binary packages
+##### c. Sign Source and Binary packages
For the Source package, it's recommended to download the zip directly from the
corresponding version branch on GitHub (e.g., 2.2.0) to avoid local environment
contamination, then rename it to apache-seata-x.x.x-incubating-src.zip
@@ -237,7 +237,7 @@ Verify ASC:
`gpg --verify apache-seata-x.x.x-incubating-src.zip.asc
apache-seata-x.x.x-incubating-src.zip`
-##### 2.2.4 Pull SVN locally, create release version path, and move the signed
files and Source/Binary packages into it
+##### d. Pull SVN locally, create release version path, and move the signed
files and Source/Binary packages into it
Pull SVN directory:
@@ -288,9 +288,9 @@ Reading transaction
Committed revision 71769.
```
-#### 2.3 Create tag and release note
+#### 3) Create tag and release note
-##### 2.3.1 Create tag
+##### a. Create tag
In the x.x.x branch, execute:
@@ -298,7 +298,7 @@ In the x.x.x branch, execute:
`git push upstream(seata repository repo) vx.x.x`
-##### 2.3.2 Create release note
+##### b. Create release note
Create a release note through [New release · apache/incubator-seata
(github.com)](https://github.com/apache/incubator-seata/releases/new) and set
"Choose a tag" to the corresponding tag.
@@ -306,7 +306,7 @@ Mark it as "Set as a pre-release". After the overall vote
passes, set it as "Set
-### 3. Verify Release Candidates
+### 2.3 Verify Release Candidates
A full check list can be found
[here](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist)
@@ -373,9 +373,9 @@ Extract the
archive`apache-seata-${release_version}-incubating-bin.tar.gz`, and
Note: If the binary package includes third-party dependencies, it is necessary
to update the LICENSE file by adding the licenses of those third-party
dependencies. If a third-party dependency is licensed under Apache 2.0 and its
project includes a NOTICE file, the NOTICE file must also be updated
accordingly.
Additionally, if a dependency is dual/multiple licensed, you only need to
include the most permissive one. You may refer to this article: [ASF
Third-Party License Policy](https://apache.org/legal/resolved.html)
-### 4. Voting Stage
+### 2.4 Voting Stage
-#### 4.1 Community Internal Voting
+#### 1) Community Internal Voting
**The vote must last at least 72 hours and receive at least 3 +1 binding
votes**
@@ -449,7 +449,7 @@ To learn more about Apache Seata , please see
https://seata.apache.org/
```
-#### 4.1.2 Complete the vote
+#### 2) Complete the vote
Send a vote passed email:
@@ -480,7 +480,7 @@ Thank you for reviewing and voting for our release
candidate.
We will soon launch the second stage of voting.
```
-#### 4.2.1 Voting in the Incubator
+#### 3) Voting in the Incubator
Similar to community voting, but you need to add links to the community vote
thread to prove consensus was reached within the community.
@@ -560,7 +560,7 @@ Checklist for reference:
To learn more about Apache Seata , please see https://seata.apache.org/
```
-#### 4.2.2 Announce the Incubator vote result
+#### 4) Announce the Incubator vote result
After 72 hours, if there are at least 3 passing votes and no opposing votes,
send an email as follows:
@@ -593,7 +593,7 @@ announcement soon.
```
-### 4.2.3 Vote Interruption
+#### 5) Vote Interruption
If issues are found during the voting process, such as license problems or
bugs that need to be fixed before release, the vote must be interrupted.
@@ -610,9 +610,9 @@ Describe the reason for cancellation: such as missing
licenses, or bugs in the v
Note: After cancelling a vote in the Incubator, a new vote must start again
from within the community.
-# 5. Complete the Release
+### 2.5 Complete the Release
-### 5.1 Release the Version
+#### 1) Release the Version
1. From Apache Nexus repository, select the previously closed
**orgapacheseata-XXX** and click the `Release` icon to publish.
@@ -624,7 +624,7 @@ Note: After cancelling a vote in the Incubator, a new vote
must start again from
4. Update the documentation for version x.x.x on the Seata official website,
and add download links for the binary and source packages.
-### 5.2 Announce the Release
+#### 2) Announce the Release
Send an email to `[email protected]`
@@ -649,7 +649,7 @@ Resources:
- Mailing list: [email protected]
```
-### 5.3 Archiving Old Versions
+#### 3) Archiving Old Versions
After releasing a new version, the previous version must be archived to ensure
that only the latest version of the same maintenance branch is retained in the
[download](https://downloads.apache.org/incubator/seata/) directory. Archived
versions are automatically synchronized to the
[archive](https://archive.apache.org/dist/incubator/seata/) when a new release
is published. Therefore, it is sufficient to delete older versions from the
[download](https://downloads.apache.org/incubator/seat [...]
```yaml
diff --git
a/i18n/zh-cn/docusaurus-plugin-content-docs/current/developers/release-guide/release-guide_dev.md
b/i18n/zh-cn/docusaurus-plugin-content-docs/current/developers/release-guide/release-guide_dev.md
index 1d8e4d86e9f..6c10788d802 100644
---
a/i18n/zh-cn/docusaurus-plugin-content-docs/current/developers/release-guide/release-guide_dev.md
+++
b/i18n/zh-cn/docusaurus-plugin-content-docs/current/developers/release-guide/release-guide_dev.md
@@ -8,7 +8,7 @@ description: Release Guide.
## 1. 前言
-#### 1.1 Apache 版本发布文档
+### 1.1 Apache 版本发布文档
参考以下链接，了解 ASF 版本发布流程：
@@ -16,7 +16,7 @@ description: Release Guide.
- [Apache Release Policy](http://www.apache.org/dev/release.html)
- [Maven Release
Info](http://www.apache.org/dev/publishing-maven-artifacts.html)
-#### 1.2 PGP 签名
+### 1.2 PGP 签名
遵循 Apache 版本发布指南，对发布版本签名，用户也可据此判断下载的版本是否被篡改。
@@ -125,7 +125,7 @@ gpg: sending key XXXXXXXX to hkp server keys.openpgp.org
```
-#### 1.3 POM 配置
+### 1.3 POM 配置
配置 POM 文件，以便将版本部署到 ASF Nexus 仓库。
@@ -179,21 +179,21 @@ gpg: sending key XXXXXXXX to hkp server keys.openpgp.org
**Tips:** 推荐使用 [Maven's password encryption
capabilities](http://maven.apache.org/guides/mini/guide-encryption.html) 加密
`gpg.passphrase`
-#### 1.5 发布 Release Notes
+### 1.4 发布 Release Notes
通过[changelog](https://github.com/apache/incubator-seata/blob/2.x/changes/zh-cn/2.x.md)构建出对应版本的Release
Notes
## 2.发布流程
-### 1. 准备分支
+### 2.1 准备分支
从主干分支拉取新分支作为发布分支，如现在要发布 `${release_version}` 版本，则从开发分支拉出新分支
`${release_version}`，此后`${release_version}` Release Candidates
涉及的修改及打标签等都在`${release_version}`分支进行，并保证该分支的github actions ci全部通过，最终发布完成后合入主干分支。
例：如 Java SDK 需要发布 `2.2.0` 版本，从 `2.x` 分支拉出新分支 `2.2.0`，并在此分支提交从 Snapshot版本号 替换为
`2.2.0` 版本号的 commit。
-### 2.预发布二进制包
+### 2.2 预发布二进制包
-#### 2.1 SDK根据 [publishing maven
artifacts](https://infra.apache.org/publishing-maven-artifacts.html) [4]
的说明准备发布。
+#### 1) SDK根据 [publishing maven
artifacts](https://infra.apache.org/publishing-maven-artifacts.html) [4]
的说明准备发布。
```
mvn clean deploy -Prelease -DskipTests -e -B
-Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn
@@ -203,19 +203,19 @@ mvn clean deploy -Prelease -DskipTests -e -B
-Dorg.slf4j.simpleLogger.log.org.ap
注：如果close失败很可能是因为签名的秘钥对应的公钥在keys.openpgp.org中无法获取到，请自行通过[OpenPGP Keyserver
(ubuntu.com)](https://keyserver.ubuntu.com/) 检查
-#### 2.2 Source&Binary提交至svn仓库
+#### 2) Source&Binary提交至svn仓库
-##### 2.2.1 安装svn
+##### a. 安装svn
下载并安装[Download Apache Subversion
Sources](https://subversion.apache.org/download.cgi#recommended-release)
或通过 `brew install subversion` 一键安装
-##### 2.2.2 编译seata-server及seata-namingserver
+##### b. 编译seata-server及seata-namingserver
`mvn -Prelease-seata -Dmaven.test.skip=true -T4C -Dpmd.skip=true clean
install -U`
-##### 2.2.3 将Source及Binary进行签名
+##### c. 将Source及Binary进行签名
Source 建议直接通过github 对应版本分支如2.2.0
进行下载zip包，避免本地环境污染Source包内容，然后重命名为apache-seata-x.x.x-incubating-src.zip
@@ -237,7 +237,7 @@ asc验证
`gpg --verify apache-seata-x.x.x-incubating-src.zip.asc
apache-seata-x.x.x-incubating-src.zip`
-##### 2.2.4 拉取svn至本地，并构建发布版本路径，并将签名文件及Source和Binary移入其中
+##### d. 拉取svn至本地，并构建发布版本路径，并将签名文件及Source和Binary移入其中
拉取svn目录
@@ -288,9 +288,9 @@ asc验证
提交后的版本为 71769。
```
-#### 2.3 创建tag及releasenote
+#### 3) 创建tag及releasenote
-##### 2.3.1 创建tag
+##### a. 创建tag
在x.x.x分支下执行
@@ -298,13 +298,13 @@ asc验证
git push upstream(seata仓库repo) vx.x.x
-##### 2.3.2 创建release note
+##### b. 创建release note
通过该链接创建release note [New release · apache/incubator-seata
(github.com)](https://github.com/apache/incubator-seata/releases/new) 并将Choose
a tag设置为对应的tag
并设置为Set as a pre-release 整体投票通过后再设置为Set as the latest release
-### 3.验证Release Candidates
+### 2.3 验证Release Candidates
详细的检查列表请参考官方的[check
list](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist)
@@ -372,9 +372,9 @@ gpg --verify
apache-seata-${release_version}-incubating-bin.tar.gz.asc apache-se
注意，如果二进制包里面引入了第三方依赖，则需要更新LICENSE，加入第三方依赖的LICENSE，如果第三方依赖的LICENSE是Apache
2.0，并且对应的项目中包含了NOTICE，还需要更新NOTICE文件。
同时，如果一个依赖项是双重/多重许可的，只需选择最宽松的一个。
可以参考这篇文章：[ASF第三方许可政策](https://apache.org/legal/resolved.html)
-### 4.投票阶段
+### 2.4 投票阶段
-#### 4.1 社区内部投票
+#### 1) 社区内部投票
**投票持续至少 72 小时并获得 3 个+1 binding票**
@@ -449,7 +449,7 @@ To learn more about Apache Seata , please see
https://seata.apache.org/
```
-#### 4.1.2 完成投票
+#### 2) 完成投票
发布投票通过邮件
@@ -482,7 +482,7 @@ We will soon launch the second stage of voting.
-#### 4.2.1 孵化器中投票
+#### 3) 孵化器中投票
与社区投票类似，但是需要增加社区投票相关的thread链接，以证明已在社区内达成一致
@@ -562,7 +562,7 @@ Checklist for reference:
To learn more about Apache Seata , please see https://seata.apache.org/
```
-#### 4.2.2 公示孵化器投票结果
+#### 4) 公示孵化器投票结果
72 小时后，若至少有 3 票通过而没有反对票，则参考如下邮件进行发送结果
@@ -595,7 +595,7 @@ announcement soon.
```
-### 4.2.3 投票中断
+#### 5) 投票中断
如出现在投票过程中验证不通过,如license,或者版本存在bug等,经评估需要修复后才能发版,那么需要中断本次投票
标题：`[CANCEL][VOTE] Release Apache Seata (incubating) x.x.x(RoundN)`
@@ -611,9 +611,9 @@ I'm cancelling this vote:
注: 孵化器中投票终止后,新的投票需要从社区内部重新开始
-# 5.完成发布
+### 2.5.完成发布
-### 5.1 release 版本
+#### 1) release 版本
1. 从Apache Nexus 仓库, 选择之前进行close过的的 **orgapacheseata-XXX** 点击 `Release` 图标发布
@@ -625,7 +625,7 @@ I'm cancelling this vote:
4. 将x.x.x的文档更新至seata官网中，并补充对应binary和source的下载链接
-### 5.2 版本公示
+#### 2) 版本公示
发送邮件至 `[email protected]`
@@ -650,7 +650,7 @@ Resources:
- Mailing list: [email protected]
```
-### 5.3 归档老版本
+#### 3) 归档老版本
发布新版本后，需要将上一个版本归档，确保在[download](https://downloads.apache.org/incubator/seata/)
只保留同一维护分支的最新版本。Archive
版本在发布新版本时会自动同步到[归档](https://archive.apache.org/dist/incubator/seata/)。因此，只需要删除[download](https://downloads.apache.org/incubator/seata/)
中老的版本即可，参考命令如下：
```yaml
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
