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
2 changes: 1 addition & 1 deletion docs/config/1.1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
## 描述
这是 Sundry 的配置文件 (`~/DuckStudio/Sundry/config.json`) 的 1.1 版本。**有关配置文件的详细说明,请参见 jsonc 中的注释。**

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

### 与 1.0 版本的区别
> [!WARNING]
Expand Down
28 changes: 28 additions & 0 deletions docs/config/1.2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Sundry 配置文件 版本 1.2

| jsonc | json schema |
|-----|-----|
| [config.jsonc](config.jsonc) | [1.2.json](https://github.com/DuckDuckStudio/yazicbs.github.io/blob/main/Tools/Sundry/config/schema/1.2.json) |

## 描述
这是 Sundry 的配置文件 (`~/DuckStudio/Sundry/config.json`) 的 1.2 版本。**有关配置文件的详细说明,请参见 jsonc 中的注释。**

此版本的配置文件适用 Sundry 1.5.x 版本。

### 与 1.1 版本的区别

1.2 版本的配置文件添加了几个可选配置并弃用了一个配置。
新增了这几个配置项:

| 配置项 | 作用 | 默认值 |
|-----|-----|-----|
| `debug` | 调试模式开关,打开后会输出一些调试信息,除非需要不建议打开 | `false` (bool) |
| `github.pr.mention_self_when_reviewer` | 自己在 [Auth.csv](https://github.com/microsoft/winget-pkgs/blob/master/Tools/ManualValidation/Auth.csv) 中作为包修改的审查者时,是否在 PR 中请求自己审查 | `false` (bool) |
| `cache.*` | 缓存开关,用于控制是否自动缓存某些内容 | / |
| `cache.validate.schema` | 控制是否缓存验证清单时使用的 yaml schema | `true` (bool) |

弃用了这些配置项:

| 配置项 | 原先作用 | 为何弃用 |
|-----|-----|-----|
| `tools.verify.check_url` | `sundry verify` 时验证清单中的 URL 是否有效 ([#68](https://github.com/DuckDuckStudio/Sundry/issues/68)) | 我试过在 `sundry validate` 中实现这个功能,但我发现这会严重拖慢 `sundry validate` 的速度。无论这个功能之后是否会在 `sundry validate` 中实现,它都不会在 `sundry verify` 中实现。 |
80 changes: 80 additions & 0 deletions docs/config/1.2/config.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
// Sundry config.json 版本 1.2 示例
// 相关配置项的 key 必须使用小写

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

// 配置文件的版本
// develop: DuckDuckStudio/Sundry main 分支最新提交的版本
"version": "1.2", // str

// 调试模式开关
"debug": false, // bool

"paths": {
// 您的 winget-pkgs 本地仓库路径
"winget-pkgs": "", // str

// 您的 winget-tools 本地仓库路径
"winget-tools": "" // str
},

"repos": {
// 您的 winget-pkgs 仓库
"winget-pkgs": "", // str, owner/repo

// 您的 winget-tools 仓库
"winget-tools": "" // str, owner/repo
},

"git": {
// 是否对提交签名
"signature": false // bool
},

"github": {
"pr": {
// 是否允许维护者修改您的 PR 内容
"maintainer_can_modify": false, // bool

// 自己在 Auth.csv 中作为包修改的审查者时,是否在 PR 中请求自己审查
"mention_self_when_reviewer": false // bool
}
},

"tools": {
"prune": {
"remote": {
// 暂未实现
// prune 时清理远程中已合并的 PR 的分支 (#98)
"prune_merged_branches": false, // bool

// 暂未实现
// prune 时清理远程中已关闭的 PR 的分支 (#98)
"prune_closed_branches": false // bool
}
},
"verify": {
// 暂未实现
// 在非干净的 Windows 上验证时显示警告 (#99)
// TODO: 这个配置会不会太长了?
"show_warning_on_non-clean_windows": false // bool
}
},

// 缓存开关
"cache": {
"validate": {
// 是否缓存验证清单时使用的 yaml schema
"schema": true // bool
}
},

// ================= 待定 / 其他分支兼容 =================

"i18n": {
// 仅 Sundry-Locale i18n 分支
// Sundry 运行时使用的语言
"lang": "zh-cn" // zh-cn | en-us - 全小写
}
}
7 changes: 4 additions & 3 deletions docs/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@

| 配置文件版本 | 适用 Sundry 版本 | 状态 |
|-----|-----|-----|
| [1.1](1.1) | 1.4.2+ | ✓ |
| [1.2](1.2) | 1.5.x | ✓ |
| [1.1](1.1) | 1.4.2 - 1.4.3 | O |
| [1.0](1.0) | 1.2.0 - 1.4.1 | ✕ |
| [0.3](0.3) | 1.1.11 - 1.1.14 | ✕ |
| [0.2](0.2) | 1.0.2 - 1.1.10 | ✕ |
Expand All @@ -13,5 +14,5 @@

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