Exécution manuelle d’un workflow

Quand un workflow est configuré pour s’exécuter sur l’événement workflow_dispatch, vous pouvez l’exécuter via l’onglet Actions de GitHub, GitHub CLI, ou l’API REST.

Tool navigation

Dans cet article

Configuration d’un workflow à exécuter manuellement

Pour exécuter un workflow manuellement, ce dernier doit être configuré pour s’exécuter sur l’événement workflow_dispatch.

Pour déclencher l’événement workflow_dispatch, votre workflow doit se trouver dans la branche par défaut. Pour plus d’informations sur la configuration de l’événement workflow_dispatch, consultez « Événements qui déclenchent des flux de travail ».

L’accès en écriture au dépôt est requis pour effectuer ces étapes.

Exécution d’un workflow

  1. Sur GitHub, accédez à la page principale du référentiel.

  2. Sous le nom de votre dépôt, cliquez sur Actions.

    Capture d’écran des onglets du référentiel « github/docs ». L’onglet « Actions » est mis en surbrillance avec un encadré orange.

  3. Dans la barre latérale gauche, cliquez sur le nom du workflow que vous souhaitez exécuter.

    Capture d’écran de la page « Actions ». Dans la barre latérale gauche, un nom de workflow est mis en évidence avec un encadré en orange foncé.

  4. Au-dessus de la liste des exécutions de workflows, cliquez sur le bouton Exécuter le workflow.

    Remarque : Pour que le bouton Exécuter le workflow soit visible, votre fichier de workflow doit utiliser le déclencheur d’événements workflow_dispatch. Seuls les fichiers de workflow qui utilisent le déclencheur d’événements workflow_dispatch peuvent exécuter le workflow manuellement à l’aide du bouton Exécuter le workflow. Pour plus d’informations sur la configuration de l’événement workflow_dispatch, consultez « Événements qui déclenchent des flux de travail ».

    Capture d’écran d’une page de workflow. Au-dessus de la liste des exécutions de workflow, un bouton intitulé « Exécuter le workflow » est indiqué en orange foncé.

  5. Sélectionnez le menu déroulant Branche et cliquez sur une branche sur laquelle exécuter le workflow.

  6. Si le workflow nécessite une entrée, renseignez les champs.

  7. Cliquez sur Exécuter le workflow.

Pour plus d’informations sur GitHub CLI, consultez « À propos de GitHub CLI ».

Pour exécuter un workflow, utilisez la sous-commande workflow run. Remplacez le paramètre workflow par le nom, l’ID ou le nom de fichier du workflow que vous souhaitez exécuter. Par exemple, "Link Checker", 1234567 ou "link-check-test.yml". Si vous ne spécifiez pas de workflow, GitHub CLI retourne un menu interactif pour vous permettre de choisir un workflow.

gh workflow run WORKFLOW

Si votre workflow accepte les entrées, GitHub CLI vous invite à les entrer. Vous pouvez également utiliser -f ou -F pour ajouter une entrée au format key=value. Utilisez -F pour lire à partir d’un fichier.

gh workflow run greet.yml -f name=mona -f greeting=hello -F data=@myfile.txt

Vous pouvez également transmettre des entrées au format JSON à l’aide d’une entrée standard.

echo '{"name":"mona", "greeting":"hello"}' | gh workflow run greet.yml --json

Pour exécuter un workflow sur une branche autre que la branche par défaut du dépôt, utilisez l’indicateur --ref.

gh workflow run WORKFLOW --ref BRANCH

Pour afficher la progression de l’exécution du workflow, utilisez la sous-commande run watch et sélectionnez l’exécution dans la liste interactive.

gh run watch

Exécution d’un workflow à l’aide de l’API REST

Lorsque vous utilisez l’API REST, vous configurez inputs et ref comme paramètres du corps de la demande. Si les entrées sont omises, les valeurs par défaut définies dans le fichier de workflow sont utilisées.

Remarque : Vous pouvez définir jusqu’à 10 inputs pour un événement workflow_dispatch.

Pour plus d’informations sur l’utilisation de l’API REST, consultez « Points de terminaison d’API REST pour les workflows ».