Skip to content
Open
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.3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
## 描述
这是 Sundry 的配置文件 (`~/DuckStudio/Sundry/config.json`) 的 1.3 版本。**有关配置文件的详细说明,请参见 jsonc 中的注释。**

此版本的配置文件适用 Sundry 1.6.x 版本。
此版本的配置文件适用 Sundry 1.6.x 到 <2.0.0 版本。

### 与 1.2 版本的区别

Expand Down
55 changes: 55 additions & 0 deletions docs/config/1.4/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Sundry 配置文件 版本 1.4

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

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

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

### 与 1.3 版本的区别

将 `github.token` 配置项的默认值从 `glm` 改为 `keyring`。

> [!TIP]
> 这不影响 `sundry config update`,更新配置文件后会保留你原来设置的 Token 读取源。

这是因为 [GitHub Labels Manager](https://github.com/DuckDuckStudio/GitHub-Labels-Manager) 已弃用。

如果你喜欢搭配 [Komac](https://github.com/russellbanks/Komac/) 使用 Sundry,将此配置设为 `komac` 可以直接读取你在 komac 设置的 Token。

你现在也可以直接用 `sundry config token <set/remove>` 命令管理 Token,而不是让 Sundry 去使用别的工具的 Token 或环境变量。

> [!NOTE]
> 要让 Sundry 使用 Sundry 自己设置的 Token,需要在设置完 Token 后通过命令修改 Token 读取源:
> ```bash
> sundry config github.token keyring
> ```

与此修改相关的议题: [DuckDuckStudio/Sundry#267](https://github.com/DuckDuckStudio/Sundry/issues/267)

---

添加了 `git.retry_interval` 配置项,用于配置命令重试的间隔。
该配置项接受一个整数作为配置值:

- 负数表示不重试
- `0` 表示立即重试
- 正数表示在重试前等待 `n` 秒

默认配置值为 `50`(在重试前等待 `50` 秒),你可以根据你自己的网络状况调整重试间隔。

与此修改相关的议题: [DuckDuckStudio/Sundry#205](https://github.com/DuckDuckStudio/Sundry/issues/205)

---

允许 [winget-tools](https://github.com/DuckDuckStudio/winget-tools/) 仓库的路径和仓库信息配置为空(`null`)。
如果你不打算使用 `sundry ignore`,可以设置 `winget-tools` 相关的配置为空(`null`)。

如果你未来又想使用 `sundry ignore`,只需要补全设置即可:
```bash
sundry config paths.winget-tools "仓库路径"
sundry config repos.winget-tools "owner/repo"
```
90 changes: 90 additions & 0 deletions docs/config/1.4/config.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
// Sundry config.json 版本 1.4 示例

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

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

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

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

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

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

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

"git": {
// 重试命令的间隔
// -1 表示不重试
// 0 表示立即重试
"retry_interval": 50, // int

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

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

// 自己在 Auth.csv 中作为包修改的审查者时,是否在 PR 中请求自己审查
"mention_self_when_reviewer": false // bool
},
// 设置 Token 读取源
"token": "keyring" // str
},

"tools": {
"autoremove": {
// 是否在浏览器中打开安装程序链接以供检查
"open_in_browser": false // bool
},
"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 - 全小写
}
}
3 changes: 2 additions & 1 deletion docs/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@

| 配置文件版本 | 适用 Sundry 版本 | 状态 |
|-----|-----|-----|
| [1.3](1.3) | 1.6.x | ✓ |
| [1.4](1.4) | 1.7.x | ✓ |
| [1.3](1.3) | 1.6.x | O |
| [1.2](1.2) | 1.5.x | O |
| [1.1](1.1) | 1.4.2 - 1.4.3 | O |
| [1.0](1.0) | 1.2.0 - 1.4.1 | ✕ |
Expand Down
Loading