MigrationMiner 项目安装与使用教程

1. 项目目录结构及介绍

MigrationMiner 项目的目录结构如下：

MigrationMiner/
├── Database/
│   └── MigrationMinerDBSQL.sql
├── MigrationMiner/
│   ├── LICENSE.md
│   ├── README.md
│   ├── DatabaseLogin.java
│   ├── GithubLogin.java
│   ├── Main.java
│   └── data/
│       └── gitRepositories.csv
├── github/workflows/
│   └── Database.java
└── README.md

目录结构介绍

• Database/: 包含数据库初始化脚本 MigrationMinerDBSQL.sql，用于创建项目所需的数据库表和视图。
• MigrationMiner/: 项目的主要代码目录，包含以下文件：
  • LICENSE.md: 项目的许可证文件。
  • README.md: 项目的介绍和使用说明。
  • DatabaseLogin.java: 数据库连接配置文件，需要设置本地 MySQL 的用户名和密码。
  • GithubLogin.java: GitHub 认证配置文件，需要设置 GitHub 的个人访问令牌。
  • Main.java: 项目的启动文件，负责运行 MigrationMiner 工具。
  • data/: 包含 gitRepositories.csv 文件，用于存储需要扫描的 Git 仓库列表。
• github/workflows/: 包含与 GitHub Actions 相关的配置文件。
• README.md: 项目的根目录下的 README 文件，提供项目的总体介绍。

2. 项目启动文件介绍

项目的启动文件是 Main.java，位于 MigrationMiner/ 目录下。该文件负责运行 MigrationMiner 工具，执行以下主要任务：

• 初始化数据库连接。
• 读取 gitRepositories.csv 文件中的 Git 仓库列表。
• 使用 GitHub 认证令牌进行仓库扫描。
• 检测并提取代码迁移信息。
• 将结果存储到数据库中，并生成 HTML 格式的输出文件。

启动步骤

1. 打开 Eclipse IDE。
2. 导入项目：选择 File -> Import -> Maven -> Existing Maven Projects，然后选择 MigrationMiner 目录。
3. 配置数据库连接：在 DatabaseLogin.java 文件中设置本地 MySQL 的用户名和密码。
4. 配置 GitHub 认证：在 GithubLogin.java 文件中设置 GitHub 的个人访问令牌。
5. 运行 Main.java 文件。

3. 项目的配置文件介绍

数据库配置文件

DatabaseLogin.java:

public class DatabaseLogin {
    public static final String USERNAME = "your_username";
    public static final String PASSWORD = "your_password";
}

• USERNAME: 设置本地 MySQL 数据库的用户名。
• PASSWORD: 设置本地 MySQL 数据库的密码。

GitHub 认证配置文件

GithubLogin.java:

public class GithubLogin {
    public static final String TOKEN = "your_github_token";
}

• TOKEN: 设置 GitHub 的个人访问令牌，用于访问 GitHub API。

Git 仓库列表配置文件

gitRepositories.csv:

repository_url_1
repository_url_2
...

• 该文件用于存储需要扫描的 Git 仓库列表，每行一个仓库 URL。

通过以上配置，MigrationMiner 工具可以顺利运行，并自动检测和提取代码迁移信息。