60 lines
2.1 KiB
Markdown
60 lines
2.1 KiB
Markdown
# 共享检查
|
|
|
|
`hooks/` 提供只读工作流检查和提交信息检查。脚本不自动修改代码、资源或文档。
|
|
|
|
## 工作流检查
|
|
|
|
```powershell
|
|
powershell -NoProfile -ExecutionPolicy Bypass -File hooks/workflow-check.ps1 `
|
|
[-UnityProjectRoot <path>] [-DocsRoot <path>]
|
|
```
|
|
|
|
项目定位顺序：
|
|
|
|
1. `-UnityProjectRoot`
|
|
2. `UNITY_PROJECT_ROOT`
|
|
3. 当前目录本身是 Unity 项目
|
|
4. UnityAI 同级唯一 Unity 项目
|
|
5. 未找到时只检查文档仓库
|
|
|
|
检查内容：
|
|
|
|
- UnityAI 与 Unity 项目的 tracked、staged、unstaged 和 untracked 文件。
|
|
- 中文路径和未跟踪 Markdown。
|
|
- ESF/General 源码与 CopyTo 生成目标是否同时变化。
|
|
- 改动路径对应的建议构建、Unity 和平台验证。
|
|
- 可能需要复核的模块文档。
|
|
- 本次修改 Markdown 中的相对链接。
|
|
|
|
`archive-check.ps1` 是兼容包装，新接入统一调用 `workflow-check.ps1`。
|
|
|
|
## 提交检查
|
|
|
|
```powershell
|
|
powershell -NoProfile -ExecutionPolicy Bypass -File hooks/commit-check.ps1 `
|
|
-RepositoryRoot <path> `
|
|
-Message "[模块][类型]: 描述"
|
|
```
|
|
|
|
脚本优先检查 staged 文件；没有 staged 文件时检查整个工作树。支持 UnityAI 和目标 Unity 项目，路径映射维护在 `commit-module-mappings.json`。
|
|
|
|
允许类型：`feat`、`fix`、`docs`、`refactor`、`test`、`chore`。
|
|
|
|
提交和推送仍然只在用户明确要求时执行。检查通过不代表可以自动提交。
|
|
|
|
## 维护规则
|
|
|
|
- 新增稳定模块路径时更新工作流与提交映射。
|
|
- 脚本保持 Windows PowerShell 5.1 可运行，不依赖写入仓库的缓存。
|
|
- 脚本只输出建议；源码边界警告不自动回退任何文件。
|
|
- 新增检查后补无改动、中文路径、无 Unity 工程和双仓库场景验证。
|
|
|
|
## 文档关联
|
|
|
|
| 文档 | 关联原因 |
|
|
|---|---|
|
|
| [工作流清单](../rules/40-工作流清单.md) | 检查对应的任务阶段 |
|
|
| [文档同步规则](../rules/50-文档同步规则.md) | 文档影响判断 |
|
|
| [开发规则](../rules/20-开发规则.md) | 源码与生成代码约束 |
|
|
| [AI 接入入口](../ai/AI接入入口.md) | AI 工具调用入口 |
|