Issue-Sync 项目教程

Issue-Sync 项目教程

issue-sync A tool for synchronizing issue tracking between GitHub and JIRA 项目地址: https://gitcode.com/gh_mirrors/is/issue-sync

1. 项目介绍

Issue-Sync 是一个用于在 GitHub 和 JIRA 之间同步问题跟踪的工具。它最初是为了在维护公共 GitHub 仓库的同时，将私有问题跟踪在 JIRA 板上而开发的。Issue-Sync 只支持单向同步，即从 GitHub 同步到 JIRA，而不会将 JIRA 中的问题同步回 GitHub。

主要功能

• 单向同步：从 GitHub 同步问题到 JIRA。
• 自定义字段：支持在 JIRA 中配置自定义字段，如 GitHub ID、GitHub Number、GitHub Labels 等。
• OAuth 支持：支持通过 OAuth 进行 JIRA 认证。

2. 项目快速启动

2.1 环境准备

• 确保你有一个 JIRA 服务器，并且有一个项目用于跟踪问题。
• 创建一个 GitHub 个人访问令牌，用于访问 GitHub API。

2.2 安装

首先，克隆项目到本地：

git clone https://github.com/coreos/issue-sync.git
cd issue-sync

2.3 配置

在 JIRA 中配置自定义字段，并确保字段名称与 Issue-Sync 的要求匹配。

创建一个配置文件 config.json，内容如下：

{
  "log-level": "info",
  "github-token": "your-github-token",
  "jira-uri": "https://your-jira-instance.com",
  "jira-project": "YOUR_PROJECT_KEY",
  "repo-name": "your-github-repo"
}

2.4 运行

使用以下命令运行 Issue-Sync：

go run main.go --config=config.json

3. 应用案例和最佳实践

3.1 应用案例

• 跨团队协作：在多个团队之间同步问题，确保所有团队成员都能看到最新的问题状态。
• 公共与私有问题管理：在维护公共 GitHub 仓库的同时，使用 JIRA 管理私有问题。

3.2 最佳实践

• 定期同步：建议定期运行 Issue-Sync，以确保问题状态的及时更新。
• 专用账户：为 Issue-Sync 创建一个专用的 JIRA 账户，以避免权限问题。

4. 典型生态项目

4.1 GitHub Actions

• 自动化同步：可以使用 GitHub Actions 定期触发 Issue-Sync，实现自动化的问题同步。

4.2 JIRA Plugins

• 扩展功能：结合 JIRA 插件，可以进一步扩展 Issue-Sync 的功能，如自动分配问题、添加标签等。

通过以上步骤，你可以快速上手并使用 Issue-Sync 工具，实现 GitHub 和 JIRA 之间的问题同步。

issue-sync A tool for synchronizing issue tracking between GitHub and JIRA 项目地址: https://gitcode.com/gh_mirrors/is/issue-sync