- 推荐添加“追踪分支”,将会根据代码变更自动更新Wiki;
- 如需开通新分支和新模块的Wiki、或者马上更新现有Wiki,可使用“手动更新”。
# 自动更新(推荐)
# 使用场景
你的项目已经生成了 Wiki,你希望当分支代码有变更后,对应分支的 Wiki 能够自动更新,那么可以通过添加这个分支的自动追踪策略来实现
# 操作方法
- 入口:项目Wiki 页面右上方「更多设置」-「定制Wiki:项目级 或 多模块」-「更新Wiki」
- 操作步骤: Git:选择要自动更新的分支,和自动更新的频率(每天 / 每周);SVN:只需选择自动更新的频率(每天 / 每周);添加后在下方可查看已设置的追踪分支信息
- 数据源:更新时使用模块/分支最新的代码、最新的“过滤文件”和“定制AI Wiki”规则
- 更新方式:如果未修改“定制AI Wiki”和“定制代码摘要”的规则,则默认增量更新(继承更新,速度快);否则全量更新(无继承,速度慢)
- 限制说明:因资源有限,每个模块只能设置一个追踪分支

# 开通新分支
# 使用场景
对于Git项目,已经基于一个分支生成了 Wiki,现在要为其他的代码分支 也生成对应的 Wiki,除了可以添加“追踪分支”,如果需要马上开通,可通过「手动更新」的「开通新分支Wiki」来实现
# 开通方法
- 入口:项目Wiki 页面右上方「更多设置」-「定制Wiki:项目级 或 多模块」-「更新Wiki」
- 操作步骤:点击“手动更新”的按钮,选择“开通新分支Wiki”,选择分支,提交即可
- 数据源:更新时使用分支最新的代码、最新的“过滤文件”和“定制AI Wiki”规则
- 限制说明:因资源有限,每个模块,最多可以开通 5 个分支的 Wiki

提交后:可以在 任务看板 页面中查看任务的进展,整个过程预计需要6- 24 小时;
生成后:你将收到企微号「工蜂」的消息通知。
# 手动更新现有Wiki
# 使用场景
如果希望实时触发 Wiki 更新的任务,可通过手动更新来实现
- 入口:项目Wiki 页面右上方「更多设置」-「定制Wiki:项目级 或 多模块」-「更新Wiki」
- 操作步骤:点击“手动更新”的按钮,选择“更新现有Wiki”,选择分支,提交即可
- 数据源:更新时使用分支最新的代码、最新的“过滤文件”和“定制AI Wiki”规则
- 更新方式:默认推荐增量更新(继承更新,速度快),你也可以选择全量更新(无继承,速度慢)
- 限制说明:因资源有限,每个模块每天天只能重新生成一次

提交后:任务的进展可以在 任务看板 页面中查看
生成后:你将收到企微号「工蜂」的消息通知。
← 定制 CodeWiki 多模块设置 →