Skip to content

Commit

Permalink
docs: update CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ljzd-PRO committed May 24, 2024
1 parent 7bd6b15 commit f7719fc
Showing 1 changed file with 22 additions and 24 deletions.
46 changes: 22 additions & 24 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,40 @@

### 💡 Feature

- Add support for filename allow-list/block-list to filter downloaded files.
- Use Unix shell-style wildcards
- Edit `KTOOLBOX_JOB__ALLOW_LIST`, `KTOOLBOX_JOB__BLOCK_LIST` in `prod.env` or environment variables to set this option
- Add support for customizing filename:
- Edit `KTOOLBOX_JOB__FILENAME_FORMAT` in `prod.env` or environment variables to set this option
- 📖More information: [Configuration-Reference-JobConfiguration](https://ktoolbox.readthedocs.io/latest/configuration/reference/#ktoolbox.configuration.JobConfiguration)
```dotenv
# Only download files that match these pattern
KTOOLBOX_JOB__ALLOW_LIST=["*.jpg","*.jpeg","*.png"]
# Rename attachments in numerical order, e.g. `1.png`, `2.png`, ...
KTOOLBOX_JOB__SEQUENTIAL_FILENAME=True
# Not to download files that match these pattern
KTOOLBOX_JOB__BLOCK_LIST=["*.psd"]
# `{}`: Basic filename
# Can be used with the configuration option above.
# Rename attachments to `[2024-1-1]_1.png`, `[2024-1-1]_2.png`, ...
KTOOLBOX_JOB__FILENAME_FORMAT="[{published}]_{}"
```
- Default not to save `creator-indices.ktoolbox` (because it's useless now :(
- Change default post text content filename `index.html` to `content.txt`
### 🪲 Fix
- Fix missing `Post.file.name` may cause download file (`Post.file`) named to `None`
[//]: # (### 🪲 Fix)
- - -
### 💡 新特性
- 增加文件名白名单/黑名单支持以进行下载文件的过滤
- 使用 Unix 风格通配符
- 在 `prod.env` 或环境变量中编辑 `KTOOLBOX_JOB__POST_DIRNAME_FORMAT` 以设置该选项
- 📖更多信息: [Configuration-Reference-JobConfiguration](https://ktoolbox.readthedocs.io/latest/configuration/reference/#ktoolbox.configuration.JobConfiguration)
- 支持自定义下载的文件名格式:
- 在 `prod.env` 或环境变量中编辑 `KTOOLBOX_JOB__FILENAME_FORMAT` 以设置该选项
- 📖更多信息: [配置-参考-JobConfiguration](https://ktoolbox.readthedocs.io/latest/configuration/reference/#ktoolbox.configuration.JobConfiguration)
```dotenv
# 只下载匹配这些模式的文件
KTOOLBOX_JOB__ALLOW_LIST=["*.jpg","*.jpeg","*.png"]
# 按照数字顺序重命名附件, 例如 `1.png`, `2.png`, ...
KTOOLBOX_JOB__SEQUENTIAL_FILENAME=True
# 不下载匹配这些模式的文件
KTOOLBOX_JOB__BLOCK_LIST=["*.psd"]
# `{}`:基本文件名
# 可以和上面的配置选项搭配使用
# 附件将被重命名为 `[2024-1-1]_1.png`, `[2024-1-1]_2.png`, ...
KTOOLBOX_JOB__FILENAME_FORMAT="[{published}]_{}"
```
- 默认不保存 `creator-indices.ktoolbox` (因为它现在已经没什么用了 :(
### 🪲 修复
- 更改默认的作品文本内容文件名 `index.html` 为 `content.txt`
- 修复缺失 `Post.file.name` 可能导致下载文件(`Post.file`)被命名为 `None`
[//]: # (### 🪲 修复)
**Full Changelog**: https://github.com/Ljzd-PRO/KToolBox/compare/v0.5.2...v0.6.0
**Full Changelog**: https://github.com/Ljzd-PRO/KToolBox/compare/v0.6.0...v0.7.0

0 comments on commit f7719fc

Please sign in to comment.