关键词

发布说明Git仓库代码分析自动化版本管理

使用说明

项目简介

Iris MCP Server 是一个基于 Model Context Protocol (MCP) 的后端服务器，专注于Git仓库的版本发布说明自动化生成。它通过分析Git仓库的标签差异，提取新功能、改进、Bug修复等信息，并根据预设模板生成结构化的Markdown格式发布说明文件，方便开发者快速创建和管理版本更新日志。

主要功能点

  • 自动化发布说明生成: 根据Git仓库的标签（tag）自动对比版本差异，无需手动编写发布说明。
  • 可定制的发布说明内容: 支持自定义发布说明的标题、新功能、改进、Bug修复、破坏性变更等内容，灵活适应不同项目的需求。
  • Markdown格式输出: 生成的发布说明为标准的Markdown格式，易于阅读和集成到各种文档平台。
  • 本地文件存储: 发布说明默认保存到项目根目录的 '.iris' 文件夹中，方便管理和版本控制。

安装步骤

  1. 安装Node.js和npm: 确保你的开发环境已安装Node.js和npm (Node包管理器)。
  2. 安装Iris MCP Server: 在你的项目根目录下，打开终端并执行以下命令安装 'iris-mcp-server'： 
    npm install iris-mcp-server

服务器配置

MCP客户端需要配置以下信息才能连接到 Iris MCP Server。这是一个 JSON 格式的配置示例，你需要将其提供给你的 MCP 客户端：

{
  "serverName": "iris-mcp-server",  // MCP服务器名称，与代码中定义的一致
  "command": "iris-mcp-server",    // 启动服务器的命令，假设安装后 'iris-mcp-server' 命令已添加到系统路径
  "args": [],                       // 启动命令的参数，此服务器无需额外参数
  "transport": "stdio"              // 使用标准的stdio进行通信
}

配置参数说明:

  • 'serverName': MCP 服务器的名称，必须与服务器自身声明的名称 '"iris-mcp-server"' 一致。
  • 'command': 用于启动 MCP 服务器的可执行命令。安装 'iris-mcp-server' 包后，通常可以直接使用包名作为命令。请确保你的环境变量 '$PATH' 包含了 'node_modules/.bin' 目录，或者全局安装了此包。
  • 'args': 启动命令的参数列表。对于 'iris-mcp-server'，默认情况下不需要额外的启动参数，因此设置为空数组 '[]'。
  • 'transport': 指定 MCP 服务器使用的传输协议。'iris-mcp-server' 使用 'stdio' (标准输入输出) 进行通信。

基本使用方法

  1. 启动MCP服务器: 在安装 'iris-mcp-server' 的项目根目录下，确保 MCP 客户端已配置好上述服务器配置信息，并启动 MCP 客户端。MCP 客户端会自动连接并启动 'iris-mcp-server'。

  2. 调用 'generate_release_note' 工具: 通过 MCP 客户端，你可以调用 'iris-mcp-server' 提供的 'generate_release_note' 工具来生成发布说明。以下是一个调用示例 (伪代码，具体客户端调用方式请参考你使用的 MCP 客户端的文档):

    // 假设你已经有了一个 MCP 客户端实例 mcpClient

async function generateReleaseNote() {
  const result = await mcpClient.useTool('iris-mcp-server', 'generate_release_note', {
    startTag: 'v1.0.0',  // 起始Git标签
    endTag: 'v1.1.0',    // 结束Git标签
    title: 'Version 1.1.0 发布', // (可选) 发布说明标题
    features: [           // (可选) 新功能列表
      '新增用户身份验证功能',
      '优化了数据查询性能'
    ],
    improvements: [       // (可选) 改进列表
      '更新了UI界面',
      '提升了安全性'
    ],
    bugfixes: [         // (可选) Bug修复列表
      '修复了登录页面崩溃的问题',
      '解决了数据同步错误'
    ],
    breaking: [         // (可选) 破坏性变更列表
      '移除了旧的API接口',
      '数据库结构发生变化'
    ]
  });

  if (result && result.content) {
    console.log(result.content[0].text); // 打印发布说明内容或文件路径
  } else {
    console.error('发布说明生成失败');
  }
}

generateReleaseNote();

    'generate_release_note' 工具参数说明:

    • 'startTag': 必需，Git仓库的起始标签，用于对比版本差异。
    • 'endTag': 必需，Git仓库的结束标签，用于对比版本差异。
    • 'title': 可选，发布说明的自定义标题。如果未提供，则默认标题为 "Release [endTag]"。
    • 'features': 可选，新功能的字符串数组，将在发布说明中列为 "新功能"。
    • 'improvements': 可选，改进项的字符串数组，将在发布说明中列为 "改进项目"。
    • 'bugfixes': 可选，Bug修复的字符串数组，将在发布说明中列为 "Bug 修复"。
    • 'breaking': 可选，破坏性变更的字符串数组，将在发布说明中列为 "破坏性变更"。

  3. 查看发布说明: 发布说明生成后，默认会保存到项目根目录下的 '.iris' 文件夹中，文件名为 'release-note-[endTag]-[timestamp].md'。你可以在该目录下找到生成的Markdown文件。

通过以上步骤，你可以使用 Iris MCP Server 自动化生成你的Git仓库的版本发布说明。

信息

分类

开发者工具

访问项目