Skip to content

自定义工作流

工作流通过为 VJSP 定义分步执行指令,实现重复性任务的自动化。在对话中输入 /[工作流名称.md] 即可调用任意工作流。

创建工作流

工作流为存储在 .vjsp/workflows/ 目录下的 Markdown 文件,分为两类:

  • 全局工作流:路径为 ~/.vjsp/workflows/(可在所有项目中调用)

  • 项目专属工作流:路径为 [project]/.vjsp/workflows/(仅适用于当前项目)

基础配置设置

  1. 创建一个 Markdown 文件,写入分步执行指令

  2. 将文件保存至上述工作流目录

  3. 在聊天中输入 /文件名.md 触发执行

工作流功能

工作流可集成以下能力:

常见工作流模板

版本发布管理

markdown
1. 汇总自上一版本发布以来已合并的 Pull Request(PR)

2. 基于提交信息自动生成更新日志

3. 更新项目版本号

4. 创建发布分支并打标签

5. 部署至预发布环境

项目初始化配置

markdown
1. 克隆项目模板仓库

2. 安装项目依赖(执行 `npm install``pip install -r requirements.txt` 命令)

3. 配置环境变量文件

4. 初始化数据库及相关服务

5. 执行初始化测试用例

代码审查准备

markdown
1. 检索代码中遗留的 `TODO` 注释及调试语句

2. 运行代码静态检查与格式化工具

3. 执行完整测试套件

4. 基于近期提交记录生成 PR 描述文档

示例:PR 提交流程

以下为创建 PR 提交工作流的完整流程,该工作流可实现从代码审查到部署通知的全流程自动化。

.vjsp/workflows 目录下新建 submit_pr.md 文件,写入以下内容:

markdown
# PR 提交工作流

你需要协助完成 Pull Request 的提交流程,请遵循以下步骤:

1.  首先调用 `search_files` 工具,检查代码中是否存在不应提交的 `TODO` 注释或 `console.log` 调试语句

2.  调用 `execute_command` 工具执行测试命令,如 `npm test` 或其他项目适配的测试指令

3.  若测试通过,暂存并提交代码变更,同时撰写清晰的提交说明

4.  推送分支至远程仓库,并调用 `gh pr create` 命令创建 Pull Request

5.  调用 `ask_followup_question` 函数向用户获取 PR 标题及描述信息

(若用户未提供以下参数,需主动询问)

- 待提交的分支名称

- 指定的代码审查人员

在对话中输入 /submit_pr.md 即可触发该工作流,VJSP 将自动完成以下操作:

  • 提交前扫描代码中的常见问题

  • 提前运行测试套件,及时发现潜在 Bug

  • 自动处理 Git 操作与 PR 创建流程

  • 向团队成员自动发送通知

  • 生成部署相关的后续任务清单

该工作流可替代人工执行的 7 步提交流程,大幅提升代码审查与提交效率。