API et intégrations
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 écritureet 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étaireouAdminqui les crée, et elles sont en bêta.
Voici comment
- Dans votre dépôt GitHub, ouvrez Settings, puis Secrets and variables, puis Actions, et ajoutez la clé comme secret nommé
ZEITLICHT_API_KEY. - 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à. - Ajoutez dans
.github/workflows/un fichier de workflow avec une étapeuses: vince8000/zeitlicht-action@suivie du SHA d'un commit. Souswith, mettezapi-keyà${{ secrets.ZEITLICHT_API_KEY }},task-fromàbranchoupr-title, etargsà la commandezl, un argument par ligne. - Dans
args,{task}représente l'ID de tâche trouvé par l'action. Pour transmettre la tâche aux tests, les lignes sonttest,request,{task},--instructions-fileetTESTING.md, et si vous voulez--testeravec un e-mail et--move-toavec l'ID d'une colonne. - Pour lier aussi la pull request, ajoutez une deuxième étape avec les lignes
link,add,{task}et l'adresse de la pull request. - 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.