Panduan Terbaik: Bina Penjejak Isu Lengkap dengan API GitHub

Panduan ini akan membantu anda mencipta penjejak isu automatik dan cekap yang disepadukan dengan API GitHub. Anda akan belajar cara menyediakan penciptaan isu, tugasan, pemberitahuan dan banyak lagi—langkah demi langkah!

1. Langkah 1: Dapatkan Token Akses Peribadi (PAT) GitHub Anda

Untuk mengakses repositori peribadi atau mengelakkan had kadar, anda memerlukan Token Akses Peribadi (PAT).

Cara Menjana Token:

1. Pergi ke Tetapan > Tetapan Pembangun > Token Akses Peribadi dalam akaun GitHub anda.
2. Klik pada Jana Token Baharu.
3. Pilih kebenaran seperti repo (untuk akses repositori).
4. Simpan token—anda memerlukannya untuk mendapatkan kebenaran dalam kod anda.

2. Langkah 2: Buat Penjejak Isu Asas

Kod ini membolehkan anda membuat isu dalam mana-mana repositori anda melalui API GitHub.

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');

? Cara ia berfungsi:

• Ganti "YourGitHubUsername" dan "my-repo" dengan nama pengguna dan nama repositori anda.
• Fungsi ini menyiarkan isu baharu ke repositori.
• Semak log konsol untuk pautan isu.

3. Langkah 3: Automatikkan Tugasan Isu

Pastikan setiap isu diberikan kepada ahli pasukan secara automatik. Langkah ini boleh menjimatkan masa, memastikan akauntabiliti.

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');

? Apa yang dilakukan oleh ini:

• Gunakan fungsi ini selepas mencipta isu untuk menetapkannya kepada ahli pasukan.
• Ganti 42 dengan nombor keluaran yang ingin anda tetapkan.

4. Langkah 4: Ambil Isu Terbuka untuk Pengurusan yang Lebih Baik

Menjejaki semua isu terbuka adalah penting untuk mengurus projek dengan cekap. Gunakan kod ini untuk menyenaraikan semua isu yang tidak dapat diselesaikan.

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');

? Cara ia membantu:

• Mengambil semua isu terbuka dalam repositori.
• Anda boleh memaparkannya dalam papan pemuka atau menghantar pemberitahuan kepada pembangun.

5. Langkah 5: Pantau Isu Lapuk dan Hantar Makluman

Buat makluman untuk isu yang masih tidak dapat diselesaikan terlalu lama. Tetapkan kerja cron untuk menjalankan kod ini secara berkala (mis., setiap hari) dan menghantar pemberitahuan melalui Slack atau e-mel.

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');

? Apa yang dilakukan oleh ini:

• Mengenal pasti isu lapuk lebih lama daripada bilangan hari yang ditentukan.
• Gunakan fungsi ini dengan amaran Slack, Discord atau e-mel untuk memberitahu ahli pasukan.

6. Langkah 6: Automatikkan Label Isu Berdasarkan Kata Kunci

Melabelkan isu secara automatik berdasarkan kandungannya menggunakan padanan kata kunci mudah. Ini boleh membantu mengkategorikan isu serta-merta.

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');

? Penggunaan:

• Secara automatik tambah label seperti "pepijat" atau "permintaan ciri" kepada isu yang berkaitan.
• Gabungkan ini dengan analisis teks untuk mengesan kata kunci (cth., "ralat", "permintaan") dalam tajuk atau perihalan isu.

7. Langkah 7: Bina Papan Pemuka untuk Memaparkan Isu

Buat papan pemuka menggunakan JavaScript dan API GitHub untuk memaparkan semua isu terbuka pada halaman web. Anda boleh menggambarkan status isu, tugasan dan label.

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');

? Cara ini berfungsi:

• Kod ini memaparkan isu secara dinamik dalam papan pemuka berasaskan web.
• Gayakannya dengan CSS untuk menjadikannya menarik secara visual.

8. Langkah 8: Gunakan Penjejak Isu Anda

Pilihan Penggunaan:

1. Vercel/Netlify: Sesuai untuk menggunakan papan pemuka statik.
2. Heroku: Sesuai untuk perkhidmatan bahagian belakang yang memerlukan makluman berkala.
3. Tindakan GitHub: Automasi tugas secara langsung dalam GitHub (cth., buat isu tentang komitmen).

9. Kesimpulan

Dengan membina penjejak isu dengan API GitHub, anda mengautomasikan pengurusan projek, meningkatkan produktiviti dan memastikan akauntabiliti. Sama ada anda menguruskan projek kecil atau repositori sumber terbuka yang besar, alatan automasi ini boleh menjimatkan masa dan memastikan pasukan anda berada di landasan yang betul.

Atas ialah kandungan terperinci Panduan Terbaik: Bina Penjejak Isu Lengkap dengan API GitHub. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!