终极指南：使用 GitHub API 构建完整的问题跟踪器

本指南将帮助您创建一个与 GitHub API 集成的自动化、高效的问题跟踪器。您将逐步学习如何设置问题创建、分配、通知等！

---

1. 第 1 步：获取您的 GitHub 个人访问令牌 (PAT)

要访问私有存储库或避免速率限制，您需要一个个人访问令牌（PAT）。

如何生成令牌：

1. 前往设置>开发者设置>您的 GitHub 帐户中的个人访问令牌。
2. 点击生成新令牌。
3. 选择权限，例如 repo（用于存储库访问）。
4. 保存令牌 - 您将需要它来在代码中进行授权。

---

2. 第 2 步：创建基本问题跟踪器

此代码可让您通过 GitHub API 在任何存储库中创建问题。

async function createIssue(owner, repo, title, body, token) {
  const url = `https://api.github.com/repos/${owner}/${repo}/issues`;
  const response = await fetch(url, {
    method: 'POST',
    headers: {
      Authorization: `token ${token}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ title, body }),
  });

  const issue = await response.json();
  console.log(`Issue Created: ${issue.html_url}`);
}

createIssue('YourGitHubUsername', 'my-repo', 'Bug Report', 'Details about the bug.', 'your_token');

？ 工作原理：

• 将“YourGitHubUsername”和“my-repo”替换为您的用户名和存储库名称。
• 此函数将新问题发布到存储库。
• 检查控制台日志中的问题链接。

---

3. 第 3 步：自动分配问题

确保每个问题都会自动分配给团队成员。此步骤可以节省时间，确保问责制。

async function assignIssue(owner, repo, issueNumber, assignees, token) {
  const url = `https://api.github.com/repos/${owner}/${repo}/issues/${issueNumber}`;
  const response = await fetch(url, {
    method: 'PATCH',
    headers: {
      Authorization: `token ${token}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ assignees }),
  });

  const updatedIssue = await response.json();
  console.log(`Issue Assigned: ${updatedIssue.html_url}`);
}

assignIssue('YourGitHubUsername', 'my-repo', 42, ['assignee_username'], 'your_token');

？ 它的作用：

• 创建问题后使用此功能将其分配给团队成员。
• 将 42 替换为您要分配的问题编号。

---

4. 第 4 步：获取未决问题以进行更好的管理

跟踪所有未解决的问题对于有效管理项目至关重要。使用此代码列出所有未解决的问题。

async function getOpenIssues(owner, repo, token) {
  const url = `https://api.github.com/repos/${owner}/${repo}/issues?state=open`;
  const response = await fetch(url, {
    headers: { Authorization: `token ${token}` },
  });

  const issues = await response.json();
  console.log(`Total Open Issues: ${issues.length}`);
  issues.forEach(issue => console.log(`#${issue.number}: ${issue.title}`));
}

getOpenIssues('YourGitHubUsername', 'my-repo', 'your_token');

？ 有什么帮助：

• 获取存储库中的所有未决问题。
• 您可以在仪表板中显示它们或向开发人员发送通知。

---

5. 第 5 步：监控过时问题并发送警报

针对长时间未解决的问题创建警报。设置 cron 作业 定期（例如每天）运行此代码并通过 Slack 或电子邮件发送通知。

async function checkStaleIssues(owner, repo, daysOld, token) {
  const url = `https://api.github.com/repos/${owner}/${repo}/issues?state=open`;
  const response = await fetch(url, {
    headers: { Authorization: `token ${token}` },
  });

  const issues = await response.json();
  const today = new Date();

  issues.forEach(issue => {
    const createdDate = new Date(issue.created_at);
    const ageInDays = (today - createdDate) / (1000 * 60 * 60 * 24);

    if (ageInDays > daysOld) {
      console.log(`Stale Issue: #${issue.number} - ${issue.title}`);
      // Send alert logic here (e.g., Slack or email notification)
    }
  });
}

checkStaleIssues('YourGitHubUsername', 'my-repo', 7, 'your_token');

？ 它的作用：

• 识别早于指定天数的陈旧问题。
• 将此功能与 Slack、Discord 或电子邮件警报结合使用，以通知团队成员。

---

6. 第 6 步：根据关键字自动发布问题标签

使用简单的关键字匹配根据内容自动标记问题。这可以帮助立即对问题进行分类。

async function createIssue(owner, repo, title, body, token) {
  const url = `https://api.github.com/repos/${owner}/${repo}/issues`;
  const response = await fetch(url, {
    method: 'POST',
    headers: {
      Authorization: `token ${token}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ title, body }),
  });

  const issue = await response.json();
  console.log(`Issue Created: ${issue.html_url}`);
}

createIssue('YourGitHubUsername', 'my-repo', 'Bug Report', 'Details about the bug.', 'your_token');

？ 用法：

• 自动为相关问题添加标签，例如“错误”或“功能请求”。
• 将其与文本分析相结合，以检测问题标题或描述中的关键字（例如“错误”、“请求”）。

---

7. 第 7 步：构建仪表板来显示问题

使用 JavaScript 和 GitHub API 创建一个仪表板，以在网页上显示所有未解决的问题。您可以可视化问题状态、分配和标签。

async function assignIssue(owner, repo, issueNumber, assignees, token) {
  const url = `https://api.github.com/repos/${owner}/${repo}/issues/${issueNumber}`;
  const response = await fetch(url, {
    method: 'PATCH',
    headers: {
      Authorization: `token ${token}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ assignees }),
  });

  const updatedIssue = await response.json();
  console.log(`Issue Assigned: ${updatedIssue.html_url}`);
}

assignIssue('YourGitHubUsername', 'my-repo', 42, ['assignee_username'], 'your_token');

？ 这是如何工作的：

• 此代码在基于网络的仪表板中动态显示问题。
• 使用 CSS 设计样式，使其具有视觉吸引力。

---

8. 第 8 步：部署您的问题跟踪器

部署选项：

1. Vercel/Netlify：非常适合部署静态仪表板。
2. Heroku：非常适合需要定期警报的后端服务。
3. GitHub Actions：直接在 GitHub 中自动执行任务（例如，在提交时创建问题）。

---

9. 结论

通过使用 GitHub API 构建问题跟踪器，您可以自动化项目管理、提高生产力并确保责任。无论您是管理小型项目还是大型开源存储库，这些自动化工具都可以节省时间并使您的团队步入正轨。

以上是终极指南：使用 GitHub API 构建完整的问题跟踪器的详细内容。更多信息请关注PHP中文网其他相关文章！