Guide ultime : créez un suivi complet des problèmes avec l'API GitHub

Ce guide vous aidera à créer un suivi des problèmes automatisé et efficace intégré à l'API GitHub. Vous apprendrez comment configurer la création de problèmes, les affectations, les notifications et bien plus encore, étape par étape !

---

1. Étape 1 : obtenez votre jeton d'accès personnel GitHub (PAT)

Pour accéder aux référentiels privés ou éviter les limites de débit, vous avez besoin d'un Jeton d'accès personnel (PAT).

Comment générer un jeton :

1. Allez dans Paramètres > Paramètres du développeur > Jetons d'accès personnels dans votre compte GitHub.
2. Cliquez sur Générer un nouveau jeton.
3. Sélectionnez les autorisations comme repo (pour l'accès au référentiel).
4. Enregistrez le jeton : vous en aurez besoin pour l'autorisation dans votre code.

---

2. Étape 2 : Créer un suivi des problèmes de base

Ce code vous permet de créer un problème dans n'importe lequel de vos référentiels via l'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');

? Comment ça marche :

• Remplacez "YourGitHubUsername" et "my-repo" par votre nom d'utilisateur et le nom du référentiel.
• Cette fonction publie un nouveau numéro dans le référentiel.
• Consultez le journal de la console pour connaître le lien du problème.

---

3. Étape 3 : Automatiser l'attribution des problèmes

Assurez-vous que chaque problème est automatiquement attribué à un membre de l'équipe. Cette étape peut faire gagner du temps, garantissant la responsabilité.

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

? Ce que cela fait :

• Utilisez cette fonction après avoir créé un ticket pour l'attribuer à un membre de l'équipe.
• Remplacez 42 par le numéro de numéro que vous souhaitez attribuer.

---

4. Étape 4 : Récupérer les problèmes ouverts pour une meilleure gestion

Le suivi de tous les problèmes ouverts est essentiel pour gérer efficacement un projet. Utilisez ce code pour répertorier tous les problèmes non résolus.

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

? Comment ça aide :

• Récupère tous les problèmes ouverts dans le référentiel.
• Vous pouvez les afficher dans un tableau de bord ou envoyer des notifications aux développeurs.

---

5. Étape 5 : Surveiller les problèmes obsolètes et envoyer des alertes

Créez des alertes pour les problèmes qui restent trop longtemps non résolus. Définissez une tâche cron pour exécuter ce code périodiquement (par exemple, tous les jours) et envoyer des notifications via Slack ou par e-mail.

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

? Ce que cela fait :

• Identifie les problèmes obsolètes plus anciens que le nombre de jours spécifié.
• Utilisez cette fonction avec Slack, Discord ou les alertes par e-mail pour avertir les membres de l'équipe.

---

6. Étape 6 : Automatiser les étiquettes de problèmes en fonction de mots clés

Étiquetez automatiquement les problèmes en fonction de leur contenu à l'aide d'une simple correspondance de mots clés. Cela peut aider à catégoriser les problèmes instantanément.

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

? Utilisation :

• Ajoutez automatiquement des étiquettes comme « bug » ou « demande de fonctionnalité » aux problèmes pertinents.
• Combinez cela avec analyse de texte pour détecter des mots-clés (par exemple, « erreur », « demande ») dans le titre ou la description du problème.

---

7. Étape 7 : Créer un tableau de bord pour afficher les problèmes

Créez un tableau de bord à l'aide de JavaScript et de l'API GitHub pour afficher tous les problèmes ouverts sur une page Web. Vous pouvez visualiser les statuts des problèmes, les affectations et les étiquettes.

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

? Comment ça marche :

• Ce code affiche dynamiquement les problèmes dans un tableau de bord Web.
• Stylisez-le avec CSS pour le rendre visuellement attrayant.

---

8. Étape 8 : Déployez votre outil de suivi des problèmes

Options de déploiement :

1. Vercel/Netlify : Parfait pour déployer des tableaux de bord statiques.
2. Heroku : Idéal pour les services back-end qui nécessitent des alertes périodiques.
3. Actions GitHub : automatisez les tâches directement dans GitHub (par exemple, créez des problèmes lors des validations).

---

9. Conclusion

En créant un suivi des problèmes avec l'API GitHub, vous automatisez la gestion de projet, améliorez la productivité et garantissez la responsabilité. Que vous gériez de petits projets ou de grands référentiels open source, ces outils d'automatisation peuvent vous faire gagner du temps et garder votre équipe sur la bonne voie.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!