Skip to content

Commit 4857f96

Browse files
docs: 添加配置文件版本 1.3 的文档 (#220)
* docs(config): 移除配置示例中不必要的一行注释 * docs(config): 配置文件版本 1.3 的文档
1 parent 303f8d3 commit 4857f96

5 files changed

Lines changed: 107 additions & 3 deletions

File tree

docs/config/1.1/config.jsonc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
// Sundry config.json 版本 1.1 示例
2-
// 相关配置项的 key 必须使用小写
32

43
{
54
"$schema": "https://duckduckstudio.github.io/yazicbs.github.io/Tools/Sundry/config/schema/1.1.json",

docs/config/1.2/config.jsonc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
// Sundry config.json 版本 1.2 示例
2-
// 相关配置项的 key 必须使用小写
32

43
{
54
"$schema": "https://duckduckstudio.github.io/yazicbs.github.io/Tools/Sundry/config/schema/1.2.json",

docs/config/1.3/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Sundry 配置文件 版本 1.3
2+
3+
| jsonc | json schema |
4+
|-----|-----|
5+
| [config.jsonc](config.jsonc) | [1.3.json](https://github.com/DuckDuckStudio/yazicbs.github.io/blob/main/Tools/Sundry/config/schema/1.3.json) |
6+
7+
## 描述
8+
这是 Sundry 的配置文件 (`~/DuckStudio/Sundry/config.json`) 的 1.3 版本。**有关配置文件的详细说明,请参见 jsonc 中的注释。**
9+
10+
此版本的配置文件适用 Sundry 1.6.x 版本。
11+
12+
### 与 1.2 版本的区别
13+
14+
1.3 版本的配置文件添加了几个配置项。
15+
新增了这几个配置项:
16+
17+
| 配置项 | 作用 | 默认值 | 接受值 |
18+
|-----|-----|-----|-----|
19+
| `github.token` | 设置 Token 读取源 | `glm` (读取 [GitHub Labels Manager](https://github.com/DuckDuckStudio/GitHub-Labels-Manager) 设置的 Token) | `glm``env` (从环境变量 `GITHUB_TOKEN` 读取)、`komac` |
20+
| `tools.autoremove.open_in_browser` | 设置是否在浏览器中打开安装程序链接以供检查 | `false` | _bool_ |

docs/config/1.3/config.jsonc

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

docs/config/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33

44
| 配置文件版本 | 适用 Sundry 版本 | 状态 |
55
|-----|-----|-----|
6-
| [1.2](1.2) | 1.5.x ||
6+
| [1.3](1.3) | 1.6.x ||
7+
| [1.2](1.2) | 1.5.x | O |
78
| [1.1](1.1) | 1.4.2 - 1.4.3 | O |
89
| [1.0](1.0) | 1.2.0 - 1.4.1 ||
910
| [0.3](0.3) | 1.1.11 - 1.1.14 ||

0 commit comments

Comments
 (0)