Commit Graph

44 Commits

Author SHA1 Message Date
uye
cf0a248ae1 ci: Update tools/ChangelogGenerator/changelog_generator.py
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
2025-11-22 02:47:23 +08:00
SherkeyXD
38a7710387 style: changelog 生成器格式化 2025-11-19 20:30:53 +08:00
uye
5d75c247be ci: 更新下 changelog 2025-11-19 18:49:23 +08:00
Lucien Shaw
e461208bf9 chore: 完善容器配置及依赖安装 (#14208)
格式化工具部分:
1. pre-commit 引入 python 的格式化工具,包括 black(代码格式化)和 isort(对“包导入顺序”的规范)
2. 允许 prettier 对文档站的 markdown 文件格式化
3. 不允许 prettier 对 markdown 文件中的代码块的代码本身进行格式化
4. 升级了 pre-commit 的各个 hook 的版本
5. 优化了 pre-commit 的日志文本显示

容器总览部分:
1. 由原来的单一轻量环境转为区分空环境、轻量环境和全量环境
2. 空环境是裸 Linux 镜像(Ubuntu),为默认环境
3. 轻量环境适合开发文档站前端
4. 全量环境适合开发 MaaCore
5. 目前,全量环境完整包含了轻量环境,轻量环境完整包含了空环境
6. 在仓库 README.md 中更新了三个环境的描述,并将链接分别设置为对应环境的创建链接
   **注意:没有修改文档站中的对应文件**
7. 在各个语言的开发指南的最后,移除了 Codespace 部分的“安装额外依赖”相关描述,且将链接设置为全量环境的创建链接
   **注意:没有添加“开发文档站”的指南和对应 codespace 的使用方式**

容器的轻量环境和全量环境共有部分:
1. 安装 black 和 isort 包
2. 调整 VS Code 设置,取消先前(对 markdown 文件单独指定 markdownlint 扩展作为格式化工具)的错误设置,现在 markdown 文件仍然使用默认的 prettier 扩展作为格式化工具
3. 引入 markdown-all-in-one 扩展作为语法提示工具
4. 将 node_modules 和 3rdparty 排除在 VS Code 的文本的搜索路径之外

容器的全量环境部分:
1. 为 tools 下的所有 python 脚本安装依赖
2. 使用 tools/maadeps-download.py 下载 maadeps,且将必要二进制文件软链接到 /usr/local/bin/
3. 使用 apt 安装 cmake 和 clangd-20,将后者通过 update-alternatives 设置为系统 clangd 的默认版本
4. 使用 cmake tools 扩展,并按照 Linux 编译方法进行配置
5. 使用 clang-format 作为 c/cpp 的格式化工具,clang-format 程序主体来自 maadeps(已经软链接到 /usr/local/bin/)
6. 使用 clangd 作为 c/cpp 的语法提示工具
7. 将 MaaDeps、install 和 build 排除在 VS Code 的文本搜索路径之外

其它手动调整:
1. 更新文档站的 package.json,指定 pnpm 包管理器的版本
2. 手动保证 markdown 文件中的列表前后有空行(注意到 MarkdownLint 官方规则不一定能精准定位所有“列表前后空行”的问题,详见:https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md032---lists-should-be-surrounded-by-blank-lines )
3. 修改了部分 markdown 文件中的 json 代码块的语法问题
   **注意:相同的问题并未全部发现,仅修改了两处**
4. 在 tools 目录中,一处 python 脚本的包名误用(本地包名和某个 pip 包重名),这里修改了相应代码
5. 在 tools 目录中,一处 python 脚本使用了弃用的包 cchardet 的问题,这里更换了推荐使用的功能相近的包并修改了相应代码

自动化脚本提交的修改:
1. 自动格式化了大量 tools 中的 python 脚本
2. 自动格式化了大量 docs 中的 markdown 文件

Commits:

* chore: pre-commit引入black和isort规范py文件

* chore: Auto update by pre-commit hooks [skip changelog]

* chore: devcontainer添加isort扩展,排序python导入

* chore: pre-commit任务命名及更名

* style: isort fix

* chore: Auto update by pre-commit hooks [skip changelog]

* chore: 更新pre-commit的hook版本

* fix: 模块名与第三方库重名,大忌

* chore: 容器构建时额外安装isort

* docs: md -> markdown

* chore: 容器安装python包和maadeps

* fix: 修复过时python包

* chore: 指定pnpm版本

* chore: container支持选择轻量环境

* chore: 去掉rust

* chore: add plain env

* chore: 使用clangd语言服务器

* chore: 无需单独设置markdown的格式化工具

* chore: 更新安装的clangd版本

* docs: 简易文档适配

* docs: 在仓库README中重新编排codespaces相关指引

* chore: Auto update by pre-commit hooks [skip changelog]

* style: 调整缩进

* chore: 格式化工具不用特意排除被gitignore忽略的文件

* chore: sh文件在gitattributes中单列一类

* chore: 格式化docs下的markdown文件

* chore: 暂时不修改md文件中的代码块

* style: 人为明确markdown中的部分列表相关格式

* docs: 补上部分markdown的json代码块中缺失的逗号

* chore: Auto update by pre-commit hooks [skip changelog]

* chore: Auto update by pre-commit hooks [skip changelog]

* fix: 补上tools的服务器排序相关代码中缺失的逗号

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* chore: 使用maadeps的clangd

* build: 更新maadeps工具链版本

* style: prettier fix

* revert: 还原maadeps版本

* revert: 取消使用maadeps的clangd依赖,改用系统apt安装

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-09-30 19:39:48 +08:00
Constrat
1a408a7234 chore: Use %B to consider header for skip changelog 2025-01-03 23:54:24 +01:00
Constrat
f55db60431 ci: nightly workflow tweaks (#11441)
* style: comment for changelog generator python

* chore: optimize conditional check for commit build

* feat: remove semver and unify checker and setter tag

* style: tweaked debug output
2024-12-27 16:29:37 +01:00
Constrat
2a31a33194 ci: utilize changelog generator as version difference checker (#11437) 2024-12-27 00:27:10 +01:00
status102
bd0a51ecb3 chore: changelog_generator 2024-11-02 22:10:54 +08:00
status102
70aa3558f0 chore: ChangelogGenerator检查commit message中的skip changelog是否为自动追加 (#11016) 2024-11-02 20:34:27 +08:00
uye
a497a3cfc3 fix: 错误分类 changelog (#10887) 2024-10-23 19:40:47 +08:00
zzyyyl
29ca30cb99 chore(tools): 更新 ChangelogGenerator
* 没有某个分类的提交时不生成该类标题

* 忽略 build|ci|style|debug 类型的提交

* coauthors 改为 list, 避免协作者顺序被随机打乱

* 由于 ignore_merge_author 默认值实际上是 True, 命令行参数调整为 merge_author
2024-07-29 16:20:23 +08:00
zzyyyl
d905457092 chore: 统一 commitizen 2024-07-29 16:06:46 +08:00
SherkeyXD
312e0296bd chore: CHANGELOG中文档修改独立分类 2024-07-14 15:01:34 +08:00
SherkeyXD
4ae002e1bb chore: changelog生成器repo独立设置 2024-06-17 03:29:09 +08:00
Sherkey
b3b09a966d chore: 修复changelog_generator编码问题,以及部分重构 (#8739)
* ci: 修正changelog生成时的编码问题

* refactor: 使用更加现代的python写法部分重构changelog_generator
2024-04-01 08:24:34 +08:00
status102
de43c04f68 chore: 修改changelog_generator的无序列表格式,从- 改为* 2024-03-20 19:35:09 +08:00
Sherkey
8c016ff854 chore: 更改changelog生成时检查coauthor的逻辑 (#7589) 2023-12-15 00:13:04 +08:00
uye
e3060bec4d fix: 反斜杠处理错误
fix #7470
2023-12-04 00:06:30 +08:00
github-actions[bot]
eb90fa0a9f docs: Auto Update Changelogs of v4.28.0-beta.1 (#7456)
Co-authored-by: ABA2396 <ABA2396@users.noreply.github.com>
Co-authored-by: status102 <status102@outlook.com>
Co-authored-by: David <56174894+Constrat@users.noreply.github.com>
Co-authored-by: zzyyyl <aysyxx53@hotmail.com>
2023-12-03 17:30:12 +08:00
quyansiyuanwang
5287e60a58 chore: re-write changelog_generator in algorithm (#6972)
更高效的匹配commit type
2023-10-18 14:42:14 +08:00
zzyyyl
9a44746cb1 chore: 在 commit message 中写上 [skip changelog] 可以在生成更新日志时跳过 2023-10-18 00:25:04 +08:00
zzyyyl
d7033a2298 chore: 默认不输出带信息 merge commit 的 commits tree 2023-10-17 23:51:35 +08:00
zzyyyl
ffab1a3c2c chore: 优化 changelog_generator
- 增加 co-author 处理
- 忽略不带信息的 merge commit
2023-10-17 23:39:11 +08:00
quyansiyuanwang
6b8ac3a720 deleted extra indent 2023-10-17 19:53:53 +08:00
quyansiyuanwang
ddaed3ef4a renamed functions
使用蛇形命名法
2023-10-17 18:46:15 +08:00
quyansiyuanwang
34aa0167e8 Update changelog_generator.py
经讨论决定修改代码逻辑:
    以开头为优先标记
    其次中文(隐)包含标记
2023-10-17 10:30:49 +08:00
quyansiyuanwang
c979cb31ec fix and correct
修正比对顺序
修改函数入口(调整函数名)
2023-10-17 07:44:37 +08:00
quyansiyuanwang
3d20189496 restructed the func print_commits
注意:暂未测试
2023-10-17 00:43:14 +08:00
quyansiyuanwang
5e42641f8f Update changelog_generator.py
deleted XXX label
编辑器里忘了删了导致再次出现这个label
2023-10-16 19:35:44 +08:00
quyansiyuanwang
1772df381b fixed err 2023-10-16 19:12:18 +08:00
quyansiyuanwang
a63a789fed Update changelog_generator.py
deleted XXX label
2023-10-16 19:01:01 +08:00
quyansiyuanwang
e0c5927f3f restructed some code
一些重复性代码被重构
  其中一部分使用列表推导
2023-10-16 18:54:28 +08:00
MistEO
a820d63967 ci: 发版自动生成 changelog 并提交 PR (#4655) 2023-05-06 16:25:34 +08:00
MistEO
f4ca529bd6 chore: fix changelog generator 2023-05-06 14:50:24 +08:00
MistEO
9b55a55bd8 fix: 修复linux CI 及部分版本号获取方法 2023-05-03 19:57:50 +08:00
MistEO
da9f0d235c chore: 更新更新changelog的工具 2023-04-30 23:03:36 +08:00
MistEO
1ba4fc97a5 chore: 修复changelogs脚本笔误 2023-04-07 14:37:13 +08:00
MistEO
8f7c8507d7 docs: changelog 2023-03-14 22:29:49 +08:00
zzyyyl
b8513cf0b6 chore: 重构 Changelog 生成器;增加几个参数
--base TAG: 从哪个版本开始生成,默认最近的 tag;大版本更新时建议使用此选项
-im: 忽略 PR 的合并者(开启后会少很多 [at] MistEO )
-ca: 把一个提交的 committer 也当作 author 对待(开启后会多一些 [at])
2023-03-10 23:37:57 +08:00
zzyyyl
b97b826ba1 chore: 优化 Changelog 生成器 2023-03-09 22:31:33 +08:00
zzyyyl
2ee40f5c35 chore: 修复 Changelog 生成器生成的 merge commit 的作者与 message 中多空格的问题 2023-03-09 22:23:02 +08:00
zzyyyl
385b5d547a chore: 给 Changelog 生成器加几个参数 2023-03-09 00:16:53 +08:00
zzyyyl
c4da03f74a chore: 优化 Changelog 生成器 2023-03-08 23:41:52 +08:00
zzyyyl
7a017b5f04 chore: Changelog 生成器从 GitHub 获取贡献者名字并缓存到本地
使用方法:
`python tools/ChangelogGenerator/changelog_generator.py`

注意:可能需要联网。
2023-03-08 21:08:42 +08:00