Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion website/.markdownlint-cli2.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
"MD045": true,
"MD046": true,
"MD047": true,
"MD052": true
"MD052": true,
"MD060": false
},
"ignores": [
"**/node_modules/**",
Expand Down
8 changes: 4 additions & 4 deletions website/community/contribution/commit-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ title: 'Commit Format Specification'

All improvements can be implemented through Pull Request (PR). Before submitting a Pull Request, please familiarise yourself with the following guidelines:

### Commit Rules
## Commit Rules

#### Commit Message
### Commit Message

Please ensure that commit messages are clear and descriptive, use **English**, and do not exceed 100 characters.

Expand All @@ -46,7 +46,7 @@ Avoid using vague commit messages like:

For assistance, refer to [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/).

#### Commit Content
### Commit Content

Each commit should contain complete and reviewable changes, ensuring:

Expand All @@ -60,6 +60,6 @@ git config --get user.name
git config --get user.email
```

### PR Description
## PR Description

To help reviewers quickly understand the content and purpose of the PR, use the [pull_request_template](https://github.com/apache/fesod/blob/main/.github/pull_request_template.md). A detailed description greatly improves code review efficiency.
22 changes: 11 additions & 11 deletions website/community/release/verify-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ title: 'How to Verify Release'

For a detailed checklist, please refer to the official [Incubator Release Checklist](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist).

### 1. Download the Release Candidate
## 1. Download the Release Candidate

> **Prerequisite:** Ensure you have `gpg` or `gpg2` installed.

Expand Down Expand Up @@ -51,17 +51,17 @@ wget https://dist.apache.org/repos/dist/dev/incubator/fesod/${RELEASE_VERSION}-$

```

### 2. Verify Compliance and Integrity
## 2. Verify Compliance and Integrity

#### 2.1 Check Package Completeness
### 2.1 Check Package Completeness

The uploaded artifacts must contain:

1. **Source Package** (Required)
2. **Signature file** (.asc, Required)
3. **Hash file** (.sha512, Required)

#### 2.2 Verify GPG Signature
### 2.2 Verify GPG Signature

**2.2.1 Import KEYS**

Expand Down Expand Up @@ -94,7 +94,7 @@ gpg --verify apache-fesod-${RELEASE_VERSION}-src.tar.gz.asc apache-fesod-${RELEA

> **Success Indicator:** The output must include **`Good signature`**.

#### 2.3 Verify SHA512 Checksum
### 2.3 Verify SHA512 Checksum

**Mac OS / Linux:**

Expand All @@ -115,7 +115,7 @@ certUtil -hashfile apache-fesod-${RELEASE_VERSION}-src.tar.gz SHA512

```

### 3. Check Source Package Content (Crucial)
## 3. Check Source Package Content (Crucial)

Extract the source package:

Expand All @@ -125,11 +125,11 @@ cd apache-fesod-${RELEASE_VERSION}-src

```

#### 3.1 Incubator Specific Checks
### 3.1 Incubator Specific Checks

* [ ] **DISCLAIMER:** Ensure a `DISCLAIMER` (or `DISCLAIMER-WIP`) file exists in the root directory. This is mandatory for incubating projects.

#### 3.2 ASF License Header Check (RAT)
### 3.2 ASF License Header Check (RAT)

Run the Apache RAT (Release Audit Tool) check:

Expand All @@ -146,7 +146,7 @@ mvn apache-rat:check
* **Unapproved Licenses:** Must be **0**.
* **Binaries:** Should be **0** (Source packages should not contain compiled jars/classes).

#### 3.3 Compilation Verification
### 3.3 Compilation Verification

Ensure the source code compiles successfully.

Expand All @@ -161,7 +161,7 @@ Ensure the source code compiles successfully.
* [ ] Build Success.
* [ ] No unexpected binary files in the source tree.

#### 3.4 License and Notice
### 3.4 License and Notice

Manually check the following files in the root directory:

Expand All @@ -172,7 +172,7 @@ Manually check the following files in the root directory:
* * Contains required attributions for bundled dependencies (if any).
* [ ] **DISCLAIMER:** Exists.

### 4. Email Reply Templates
## 4. Email Reply Templates

After verification, reply to the vote thread on `dev@fesod.apache.org`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ title: 'Commit 格式规范'

所有改进措施均可通过“拉取请求”(PR)来实现。在提交拉取请求之前,请先熟悉以下指南:

### Commit 规范
## Commit 规范

#### Commit 消息格式
### Commit 消息格式

请确保提交消息清晰且具有描述性,务必使用**英文**,且不超过 100 个字符。

Expand All @@ -29,7 +29,7 @@ title: 'Commit 格式规范'

如果需要帮助,请参考 [如何编写 Git 提交消息](http://chris.beams.io/posts/git-commit/)。

#### Commit 内容
### Commit 内容

一次提交应包含完整且可审查的更改,确保:

Expand All @@ -43,6 +43,6 @@ git config --get user.name
git config --get user.email
```

### PR 描述信息
## PR 描述信息

为了帮助审阅者快速了解 PR 的内容和目的,请使用 [PR 模板](https://github.com/apache/fesod/blob/main/.github/pull_request_template.md)。详细的描述将极大提高代码审阅效率。
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: '如何验证版本'

详细检查列表请参考官方的 [Incubator Release Checklist](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist)。

### 1. 下载要发布的候选版本
## 1. 下载要发布的候选版本

> 验证环节需依赖 GPG 工具,建议预先安装 `gpg` 或 `gpg2`。

Expand Down Expand Up @@ -34,17 +34,17 @@ wget https://dist.apache.org/repos/dist/dev/incubator/fesod/${RELEASE_VERSION}-$

```

### 2. 验证上传的版本是否合规
## 2. 验证上传的版本是否合规

#### 2.1 检查发布包完整性
### 2.1 检查发布包完整性

上传到 dist 的包必须包含:

1. **源码包** (Source Package, 必须)
2. **签名文件** (.asc, 必须)
3. **哈希文件** (.sha512, 必须)

#### 2.2 检查 GPG 签名
### 2.2 检查 GPG 签名

首先导入发布人的公钥。

Expand Down Expand Up @@ -78,7 +78,7 @@ gpg --verify apache-fesod-${RELEASE_VERSION}-src.tar.gz.asc apache-fesod-${RELEA

> **检查结果:** 必须出现 **`Good signature`** 字样。

#### 2.3 检查 SHA512 哈希
### 2.3 检查 SHA512 哈希

**Mac OS / Linux:**

Expand All @@ -100,7 +100,7 @@ certUtil -hashfile apache-fesod-${RELEASE_VERSION}-src.tar.gz SHA512

```

### 3. 检查源码包内容 (核心合规项)
## 3. 检查源码包内容 (核心合规项)

解压源码包:

Expand All @@ -110,13 +110,13 @@ cd apache-fesod-${RELEASE_VERSION}-src

```

#### 3.1 孵化器特有检查 (Incubator Check)
### 3.1 孵化器特有检查 (Incubator Check)

作为孵化项目,必须检查根目录下是否存在 `DISCLAIMER` (或 `DISCLAIMER-WIP`) 文件。

* **检查项:** 确认存在 `DISCLAIMER` 文件,且内容声明了这是一个处于孵化阶段的项目。

#### 3.2 ASF License Header (RAT 检查)
### 3.2 ASF License Header (RAT 检查)

使用 Maven 插件进行 License 头检查。

Expand All @@ -140,7 +140,7 @@ find . -name rat.txt -print0 | xargs -0 -I file cat file | grep "Unapproved Lice

```

#### 3.3 源码编译验证
### 3.3 源码编译验证

确保源码可以被正确编译打包。

Expand All @@ -155,7 +155,7 @@ find . -name rat.txt -print0 | xargs -0 -I file cat file | grep "Unapproved Lice
* [ ] Build Success (编译成功)
* [ ] 源码包中**不包含**任何非必要的二进制文件 (如 `.jar`, `.zip`, `.class`)。

#### 3.4 许可证合规性检查
### 3.4 许可证合规性检查

进入解压后的目录,人工检查:

Expand All @@ -167,7 +167,7 @@ find . -name rat.txt -print0 | xargs -0 -I file cat file | grep "Unapproved Lice

* [ ] **DISCLAIMER 文件:** 存在(孵化项目必须存在)。

### 4. 邮件回复示例
## 4. 邮件回复示例

验证完成后,请在开发者邮件列表 (`dev@fesod.apache.org`) 回复投票邮件。

Expand Down
2 changes: 1 addition & 1 deletion website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
"docusaurus-plugin-matomo": "^0.0.8",
"markdownlint-cli2": "^0.18.1",
"markdownlint-cli2": "^0.20.0",
"prism-react-renderer": "^2.3.0",
"react": "^19.0.0",
"react-dom": "^19.0.0"
Expand Down
Loading