Skip to content

Commit a3be74f

Browse files
deleipsxjoy
andauthored
chore: bump markdownlint-cli2 from 0.18.1 to 0.20.0 (#867)
* chore: bump markdownlint-cli2 from 0.18.1 to 0.20.0 * docs: fix the issues detected by markdownlint scanning --------- Co-authored-by: Shuxin Pan <psxjoy@apache.org>
1 parent 5c77cdd commit a3be74f

6 files changed

Lines changed: 33 additions & 32 deletions

File tree

website/.markdownlint-cli2.jsonc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@
2424
"MD045": true,
2525
"MD046": true,
2626
"MD047": true,
27-
"MD052": true
27+
"MD052": true,
28+
"MD060": false
2829
},
2930
"ignores": [
3031
"**/node_modules/**",

website/community/contribution/commit-format.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ title: 'Commit Format Specification'
2222

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

25-
### Commit Rules
25+
## Commit Rules
2626

27-
#### Commit Message
27+
### Commit Message
2828

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

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

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

49-
#### Commit Content
49+
### Commit Content
5050

5151
Each commit should contain complete and reviewable changes, ensuring:
5252

@@ -60,6 +60,6 @@ git config --get user.name
6060
git config --get user.email
6161
```
6262

63-
### PR Description
63+
## PR Description
6464

6565
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.

website/community/release/verify-release.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ title: 'How to Verify Release'
2222

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

25-
### 1. Download the Release Candidate
25+
## 1. Download the Release Candidate
2626

2727
> **Prerequisite:** Ensure you have `gpg` or `gpg2` installed.
2828
@@ -51,17 +51,17 @@ wget https://dist.apache.org/repos/dist/dev/incubator/fesod/${RELEASE_VERSION}-$
5151

5252
```
5353

54-
### 2. Verify Compliance and Integrity
54+
## 2. Verify Compliance and Integrity
5555

56-
#### 2.1 Check Package Completeness
56+
### 2.1 Check Package Completeness
5757

5858
The uploaded artifacts must contain:
5959

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

64-
#### 2.2 Verify GPG Signature
64+
### 2.2 Verify GPG Signature
6565

6666
**2.2.1 Import KEYS**
6767

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

9595
> **Success Indicator:** The output must include **`Good signature`**.
9696
97-
#### 2.3 Verify SHA512 Checksum
97+
### 2.3 Verify SHA512 Checksum
9898

9999
**Mac OS / Linux:**
100100

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

116116
```
117117

118-
### 3. Check Source Package Content (Crucial)
118+
## 3. Check Source Package Content (Crucial)
119119

120120
Extract the source package:
121121

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

126126
```
127127

128-
#### 3.1 Incubator Specific Checks
128+
### 3.1 Incubator Specific Checks
129129

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

132-
#### 3.2 ASF License Header Check (RAT)
132+
### 3.2 ASF License Header Check (RAT)
133133

134134
Run the Apache RAT (Release Audit Tool) check:
135135

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

149-
#### 3.3 Compilation Verification
149+
### 3.3 Compilation Verification
150150

151151
Ensure the source code compiles successfully.
152152

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

164-
#### 3.4 License and Notice
164+
### 3.4 License and Notice
165165

166166
Manually check the following files in the root directory:
167167

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

175-
### 4. Email Reply Templates
175+
## 4. Email Reply Templates
176176

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

website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/contribution/commit-format.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ title: 'Commit 格式规范'
55

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

8-
### Commit 规范
8+
## Commit 规范
99

10-
#### Commit 消息格式
10+
### Commit 消息格式
1111

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

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

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

32-
#### Commit 内容
32+
### Commit 内容
3333

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

@@ -43,6 +43,6 @@ git config --get user.name
4343
git config --get user.email
4444
```
4545

46-
### PR 描述信息
46+
## PR 描述信息
4747

4848
为了帮助审阅者快速了解 PR 的内容和目的,请使用 [PR 模板](https://github.com/apache/fesod/blob/main/.github/pull_request_template.md)。详细的描述将极大提高代码审阅效率。

website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/release/verify-release.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: '如何验证版本'
55

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

8-
### 1. 下载要发布的候选版本
8+
## 1. 下载要发布的候选版本
99

1010
> 验证环节需依赖 GPG 工具,建议预先安装 `gpg``gpg2`
1111
@@ -34,17 +34,17 @@ wget https://dist.apache.org/repos/dist/dev/incubator/fesod/${RELEASE_VERSION}-$
3434

3535
```
3636

37-
### 2. 验证上传的版本是否合规
37+
## 2. 验证上传的版本是否合规
3838

39-
#### 2.1 检查发布包完整性
39+
### 2.1 检查发布包完整性
4040

4141
上传到 dist 的包必须包含:
4242

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

47-
#### 2.2 检查 GPG 签名
47+
### 2.2 检查 GPG 签名
4848

4949
首先导入发布人的公钥。
5050

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

7979
> **检查结果:** 必须出现 **`Good signature`** 字样。
8080
81-
#### 2.3 检查 SHA512 哈希
81+
### 2.3 检查 SHA512 哈希
8282

8383
**Mac OS / Linux:**
8484

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

101101
```
102102

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

105105
解压源码包:
106106

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

111111
```
112112

113-
#### 3.1 孵化器特有检查 (Incubator Check)
113+
### 3.1 孵化器特有检查 (Incubator Check)
114114

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

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

119-
#### 3.2 ASF License Header (RAT 检查)
119+
### 3.2 ASF License Header (RAT 检查)
120120

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

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

141141
```
142142

143-
#### 3.3 源码编译验证
143+
### 3.3 源码编译验证
144144

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

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

158-
#### 3.4 许可证合规性检查
158+
### 3.4 许可证合规性检查
159159

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

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

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

170-
### 4. 邮件回复示例
170+
## 4. 邮件回复示例
171171

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

website/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"@mdx-js/react": "^3.0.0",
2727
"clsx": "^2.0.0",
2828
"docusaurus-plugin-matomo": "^0.0.8",
29-
"markdownlint-cli2": "^0.18.1",
29+
"markdownlint-cli2": "^0.20.0",
3030
"prism-react-renderer": "^2.3.0",
3131
"react": "^19.0.0",
3232
"react-dom": "^19.0.0"

0 commit comments

Comments
 (0)