AIGitFlow - Git工作流自动化工具
AIGitFlow 是一个功能丰富的 VSCode 扩展,旨在帮助开发者自动化 Git 工作流程。该工具支持代码检查、Issue 创建和自动提交等功能,提高开发效率和代码质量。
功能特点
- 代码检查: 集成 cppcheck 自动进行代码静态分析,在 VSCode 问题面板中可视化展示问题,支持一键跳转到代码位置。
- GitLab Issue 提交: 一键创建 GitLab Issue,自动填充标题、描述和标签。
- 自动提交: 简化 Git 提交流程,支持分支创建、代码提交和合并请求创建。
- 可视化工作流: 提供直观的工作流控制界面,轻松配置和执行工作流步骤。
- 详细日志记录: 实时记录工作流执行过程,便于问题定位和流程优化。
安装方法
从 VSCode 扩展市场安装:
- 打开 VSCode,点击左侧扩展图标 (Ctrl+Shift+X)
- 搜索 "AIGitFlow" 并点击安装
从 VSIX 文件安装:
- 下载最新的 VSIX 文件
- 在 VSCode 中,选择 扩展 > 从 VSIX 安装...
- 选择下载的 VSIX 文件
配置说明
AIGitFlow 提供多种配置选项,可通过 VSCode 设置进行自定义:
GitLab 相关配置请在项目根目录的 .vscode/settings.json 文件中设置:
{
"workflow-automation.gitlabBaseUrl": "http://gitlab.com",
"workflow-automation.gitlabToken": "你的GitLab访问令牌",
"workflow-automation.gitlabProjectId": "你的GitLab项目ID"
}
workflow-automation.gitlabBaseUrl :GitLab 服务器地址,默认 http://gitlab.com ,如有自建服务请填写实际地址。
workflow-automation.gitlabToken :GitLab API 访问令牌,用于身份验证,确保能够创建 Issue 和合并请求。
workflow-automation.gitlabProjectId :GitLab 项目 ID,指定要操作的 GitLab 项目。
workflow-automation.cppcheckPath: cppcheck 可执行文件的路径
- 默认值:
C:\Program Files\Cppcheck\cppcheck.exe
- 根据您的操作系统和安装位置进行调整
workflow-automation.cppcheckSeverity: cppcheck 检测等级
- 可选值:
error , warning , style , performance , portability , information , all
- 默认值:
error
workflow-automation.steps.codeCheck: 是否默认启用代码检查步骤
workflow-automation.steps.issueSubmit: 是否默认启用 Issue 提交步骤
workflow-automation.steps.autoCommit: 是否默认启用自动提交步骤
配置步骤
- 打开项目根目录下的
.vscode/settings.json 文件(如无则新建)。
- 按上述示例添加或修改 GitLab 相关配置项。
- 其他参数(如 cppcheck 配置、工作流步骤)也可在此文件中统一设置。
使用方法
打开工作流视图:
- 点击 VSCode 活动栏中的 AIGitFlow 图标
配置工作流步骤:
执行工作流:
- 点击 "开始工作流" 按钮
- 根据提示完成各步骤所需的信息输入
代码检查结果查看:
- 检查结果会显示在 VSCode 的"问题"面板中
- 点击问题可以直接跳转到相应的代码位置
需求和依赖
- VSCode: 1.99.0 或更高版本
- Git: 最新版本
- cppcheck: 最新版本 (用于代码检查功能)
支持与反馈
如果您有任何问题或建议,请通过以下方式联系我们:
- GitHub Issues: 在项目仓库提交问题
- 电子邮件: support@aigitflow-extension.com
版本信息
有关版本更新的详细信息,请参阅 CHANGELOG.md 文件。
许可证
此扩展根据 MIT 许可证发布。详情请见 LICENSE 文件。
| |