关于 work-report
这是一项 Codex 技能,可根据多个仓库的 Git 提交主题生成每日或每周工作报告。它按项目归类提交、规范措辞,并以中文格式输出。
主要功能
- 01收集多个仓库的提交
- 02按项目归类报告内容
- 03支持每日和每周周期
- 04规范提交措辞
- 05生成中文编号报告
适用场景
- 01根据仓库提交撰写每日报告
- 02按项目汇总每周变更
- 03收集嵌套 Git 仓库中的提交
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ leeguooooo/ work-report --skill work-report安装后在 Claude Code 中输入/work-report确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
README.mdLICENSEscripts/git_today_commits.sh详细介绍
工作报告
工作流
- 确定本地日期,并将其格式化为
MM.DD(不含年份)。 - 根据用户的请求判断是生成每日报告还是每周报告。
- 确认用于扫描多个仓库的工作区根路径;如果用户尚未提供,先检查 WORK_REPORT_ROOT 或 CODEX_WORK_ROOT,然后询问用户。
- 对于每日报告,按项目(仓库)分组,收集目标根路径下所有仓库中由指定作者提交的 git 提交主题。
- 优先使用
scripts/git_today_commits.sh --root <path> --period daily --group-by-repo。 - 如有需要,可逐个仓库手动运行:
git log --since=midnight --author "<name>" --pretty=format:%s。 - 将提交主题改写为简洁的中文事项,然后按项目整理成编号列表(避免输出英文);将价值较低或敏感的表述(例如“解决冲突”)替换为适合业务场景的措辞(例如“代码集成与稳定性维护”)。
- 如果没有提交记录,询问用户是否有需要手动添加的事项。
- 优先使用
- 对于每周报告,按项目分组,将 git 提交概括为简洁的中文事项(除非没有提交记录,否则无需用户输入)。
- 优先使用
scripts/git_today_commits.sh --root <path> --period weekly --group-by-repo。 - 将提交主题整理为每个项目 1 到 5 条中文总结事项(合并相似的改动)。
- 优先使用
- 仅将包含
.git文件夹或文件的目录视为项目。忽略非 git 目录。包括根路径下的嵌套仓库。
脚本
使用 scripts/git_today_commits.sh 列出提交主题。
- 如果当前不在此技能目录中,请通过
~/.codex/skills/work-report/scripts/git_today_commits.sh(或$CODEX_HOME/skills/work-report/scripts/git_today_commits.sh)调用该脚本。 - 除非提供了
--repo或设置了 WORK_REPORT_ROOT/CODEX_WORK_ROOT,否则必须提供--root <path>。 - 默认作者取自
git config --global user.name,其次取自git config --global user.email。 - 使用
--root <path>指定其他根文件夹。 - 使用
--repo <path>指定单个仓库。 - 使用
--author "Name"覆盖作者。 - 使用
--period daily|weekly选择时间范围。 - 使用
--since "<expr>"覆盖时间范围(例如"yesterday")。 - 使用
--with-repo在每条事项前添加仓库名称。 - 使用
--group-by-repo按仓库分组输出各个部分,便于整理报告。 - 默认会从所有分支收集提交(
git log --all)。使用--no-all将范围限制为当前分支。 - 默认启用规范化处理,使事项更符合业务场景;使用
--no-normalize保留原始提交主题。
输出格式
每日报告的标题文字使用“今日工作总结”。脚本输出项目符号时,将其转换为编号列表。
MM.DD 今日工作总结
<项目A>
1.<item>
2.<item>
<项目B>
1.<item>
每周报告的标题文字使用“本周工作总结”。每周事项应根据 git 提交整理为中文总结。时间范围应遵循自然周,从周一开始。
MM.DD-MM.DD 本周工作总结
<项目A>
1.<item>
2.<item>
<项目B>
1.<item>
评论
支持 Markdown