Skip to content

Commit 4cee99a

Browse files
docs: 配置文件 1.2 文档 (#163)
* docs: 配置文件 1.2 草案文档 * docs: 更新草案 * fix: 更正 $schema * docs: 在配置文件文档目录添加配置文件 1.2 的链接 * docs: 详细说明过时配置文件的更新方式
1 parent e9511b1 commit 4cee99a

File tree

4 files changed

+113
-4
lines changed

4 files changed

+113
-4
lines changed

docs/config/1.1/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
## 描述
88
这是 Sundry 的配置文件 (`~/DuckStudio/Sundry/config.json`) 的 1.1 版本。**有关配置文件的详细说明,请参见 jsonc 中的注释。**
99

10-
此版本的配置文件适用 Sundry 1.4.2 及后续版本
10+
此版本的配置文件适用 Sundry 1.4.2 - Sundry 1.4.3
1111

1212
### 与 1.0 版本的区别
1313
> [!WARNING]

docs/config/1.2/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Sundry 配置文件 版本 1.2
2+
3+
| jsonc | json schema |
4+
|-----|-----|
5+
| [config.jsonc](config.jsonc) | [1.2.json](https://github.com/DuckDuckStudio/yazicbs.github.io/blob/main/Tools/Sundry/config/schema/1.2.json) |
6+
7+
## 描述
8+
这是 Sundry 的配置文件 (`~/DuckStudio/Sundry/config.json`) 的 1.2 版本。**有关配置文件的详细说明,请参见 jsonc 中的注释。**
9+
10+
此版本的配置文件适用 Sundry 1.5.x 版本。
11+
12+
### 与 1.1 版本的区别
13+
14+
1.2 版本的配置文件添加了几个可选配置并弃用了一个配置。
15+
新增了这几个配置项:
16+
17+
| 配置项 | 作用 | 默认值 |
18+
|-----|-----|-----|
19+
| `debug` | 调试模式开关,打开后会输出一些调试信息,除非需要不建议打开 | `false` (bool) |
20+
| `github.pr.mention_self_when_reviewer` | 自己在 [Auth.csv](https://github.com/microsoft/winget-pkgs/blob/master/Tools/ManualValidation/Auth.csv) 中作为包修改的审查者时,是否在 PR 中请求自己审查 | `false` (bool) |
21+
| `cache.*` | 缓存开关,用于控制是否自动缓存某些内容 | / |
22+
| `cache.validate.schema` | 控制是否缓存验证清单时使用的 yaml schema | `true` (bool) |
23+
24+
弃用了这些配置项:
25+
26+
| 配置项 | 原先作用 | 为何弃用 |
27+
|-----|-----|-----|
28+
| `tools.verify.check_url` | `sundry verify` 时验证清单中的 URL 是否有效 ([#68](https://github.com/DuckDuckStudio/Sundry/issues/68)) | 我试过在 `sundry validate` 中实现这个功能,但我发现这会严重拖慢 `sundry validate` 的速度。无论这个功能之后是否会在 `sundry validate` 中实现,它都不会在 `sundry verify` 中实现。 |

docs/config/1.2/config.jsonc

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
// Sundry config.json 版本 1.2 示例
2+
// 相关配置项的 key 必须使用小写
3+
4+
{
5+
"$schema": "https://duckduckstudio.github.io/yazicbs.github.io/Tools/Sundry/config/schema/1.2.json",
6+
7+
// 配置文件的版本
8+
// develop: DuckDuckStudio/Sundry main 分支最新提交的版本
9+
"version": "1.2", // str
10+
11+
// 调试模式开关
12+
"debug": false, // bool
13+
14+
"paths": {
15+
// 您的 winget-pkgs 本地仓库路径
16+
"winget-pkgs": "", // str
17+
18+
// 您的 winget-tools 本地仓库路径
19+
"winget-tools": "" // str
20+
},
21+
22+
"repos": {
23+
// 您的 winget-pkgs 仓库
24+
"winget-pkgs": "", // str, owner/repo
25+
26+
// 您的 winget-tools 仓库
27+
"winget-tools": "" // str, owner/repo
28+
},
29+
30+
"git": {
31+
// 是否对提交签名
32+
"signature": false // bool
33+
},
34+
35+
"github": {
36+
"pr": {
37+
// 是否允许维护者修改您的 PR 内容
38+
"maintainer_can_modify": false, // bool
39+
40+
// 自己在 Auth.csv 中作为包修改的审查者时,是否在 PR 中请求自己审查
41+
"mention_self_when_reviewer": false // bool
42+
}
43+
},
44+
45+
"tools": {
46+
"prune": {
47+
"remote": {
48+
// 暂未实现
49+
// prune 时清理远程中已合并的 PR 的分支 (#98)
50+
"prune_merged_branches": false, // bool
51+
52+
// 暂未实现
53+
// prune 时清理远程中已关闭的 PR 的分支 (#98)
54+
"prune_closed_branches": false // bool
55+
}
56+
},
57+
"verify": {
58+
// 暂未实现
59+
// 在非干净的 Windows 上验证时显示警告 (#99)
60+
// TODO: 这个配置会不会太长了?
61+
"show_warning_on_non-clean_windows": false // bool
62+
}
63+
},
64+
65+
// 缓存开关
66+
"cache": {
67+
"validate": {
68+
// 是否缓存验证清单时使用的 yaml schema
69+
"schema": true // bool
70+
}
71+
},
72+
73+
// ================= 待定 / 其他分支兼容 =================
74+
75+
"i18n": {
76+
// 仅 Sundry-Locale i18n 分支
77+
// Sundry 运行时使用的语言
78+
"lang": "zh-cn" // zh-cn | en-us - 全小写
79+
}
80+
}

docs/config/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33

44
| 配置文件版本 | 适用 Sundry 版本 | 状态 |
55
|-----|-----|-----|
6-
| [1.1](1.1) | 1.4.2+ ||
6+
| [1.2](1.2) | 1.5.x ||
7+
| [1.1](1.1) | 1.4.2 - 1.4.3 | O |
78
| [1.0](1.0) | 1.2.0 - 1.4.1 ||
89
| [0.3](0.3) | 1.1.11 - 1.1.14 ||
910
| [0.2](0.2) | 1.0.2 - 1.1.10 ||
@@ -13,5 +14,5 @@
1314

1415
状态:
1516
- ✓ 当前使用的配置文件版本。
16-
- O 过时的配置文件版本,但可以在最新的 Sundry 中设置兼容
17-
- ✕ 弃用的配置文件版本,新版本的 Sundry 不再允许设置兼容
17+
- O 过时的配置文件版本,但可以在最新的 Sundry 使用 `sundry config update` 更新
18+
- ✕ 弃用的配置文件版本,新版本的 Sundry 不再支持

0 commit comments

Comments
 (0)