# make-merge-request

**Repository Path**: bignoes187/make-merge-request

## Basic Information

- **Project Name**: make-merge-request
- **Description**: 便于创建 merge request 的命令行工具
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-08-28
- **Last Updated**: 2025-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 简介

便于创建 merge request 的命令行工具

## 安装

**Node.js recommends 14+**

```sh
npm install make-merge-request -g
```

## 初始化

#### 准备工作

由于该工具使用了 Gitlab Api，因此初始化需要准备以下信息支持：

1. Gitlab Access Token，[生成 Access Token 文档地址](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token)
2. Gitlab Api 地址，Gitlab 仓库地址 + '/api/v4'，例如：https://example.gitlab.com/api/v4
#### 初始化方式

初始化有两种方式可选：

1. 使用命令 mr init，根据提示输入上面准备信息
2. 手动创建 config.json 初始化文件并赋值，文件内容参考下面代码片段

- Windows 路径： C:\Users\用户名\.make-merge-request\config.json
- Mac 路径：/Users/用户名/.make-merge-request/config.json

```json
{
  "baseURL": "https://example.gitlab.com/api/v4",
  "token": "xxx",
}
```

## 特性

1. 用于在命令行中快速创建 Merge Request，相比于在 Gitlab 网页中操作简单方便
2. 合并审核人员列表缓存本地，提供更快的响应速度，同时支持手动拉取人员数据，更新本地缓存
3. 支持根据分支维度记录默认审核人，创建 Merge Request 时自动填充默认审核人

## 命令
```sh
Usage: mr [command] [params]

Options:
  -h, --help     output usage information
  -V, --version  output the version number

Commands:
  init           初始化
  fetch          手动拉取审核人员数据列表
  to             创建 Merge Request，参数为目标分支的名称
  compare        比较当前分支与目标分支的差异，mr 前使用