Retour à l’aperçu

Utiliser Zeitlicht dans GitHub Actions

Je veux …

… laisser un workflow GitHub modifier des tâches, par exemple transmettre une tâche aux tests quand sa pull request est fusionnée.

Avant de commencer

  • Il vous faut une clé API de cet espace de travail, voir « Créer et révoquer des clés API ». Créez-en une rien que pour GitHub, avec Lecture et écriture et seulement les tableaux dont le workflow a besoin.
  • L'action lance la ligne de commande zl, voir « Utiliser la ligne de commande zl ».
  • Les clés API demandent le forfait Ultra de la personne Propriétaire ou Admin qui les crée, et elles sont en bêta.

Voici comment

  1. Dans votre dépôt GitHub, ouvrez Settings, puis Secrets and variables, puis Actions, et ajoutez la clé comme secret nommé ZEITLICHT_API_KEY.
  2. Nommez les branches d'après l'ID court de la tâche, par exemple 3f2a9c1e-login-fix, ou mettez l'ID court dans le titre de la pull request. L'action le trouve là.
  3. Ajoutez dans .github/workflows/ un fichier de workflow avec une étape uses: vince8000/zeitlicht-action@ suivie du SHA d'un commit. Sous with, mettez api-key à ${{ secrets.ZEITLICHT_API_KEY }}, task-from à branch ou pr-title, et args à la commande zl, un argument par ligne.
  4. Dans args, {task} représente l'ID de tâche trouvé par l'action. Pour transmettre la tâche aux tests, les lignes sont test, request, {task}, --instructions-file et TESTING.md, et si vous voulez --tester avec un e-mail et --move-to avec l'ID d'une colonne.
  5. Pour lier aussi la pull request, ajoutez une deuxième étape avec les lignes link, add, {task} et l'adresse de la pull request.
  6. Fusionnez une pull request. L'exécution du workflow affiche la réponse de la commande, et la tâche affiche la modification.

Le résultat

Le workflow modifie la tâche en votre nom, avec le nom de la clé à côté de la modification dans l'historique de la tâche. Chaque requête apparaît dans le journal d'accès de la clé.

Questions fréquentes

Pourquoi un argument par ligne ?

Pour que rien dans un nom de branche ou un titre de pull request ne puisse s'exécuter comme une commande. L'action ne transmet jamais vos arguments à un shell.

Le texte de la pull request peut-il devenir les instructions de test ?

Oui. Dans une étape précédente, écrivez le texte dans un fichier, avec le corps de la pull request passé par une variable d'environnement, et donnez ce fichier à --instructions-file.

Faut-il épingler l'action ?

Oui, par le SHA du commit plutôt que par une étiquette comme v1. Une action modifiée ne peut alors pas se glisser dans votre workflow sans que vous le remarquiez.

Sujets liés