ContextQMD
Back to Gitlabhq

Les pipelines CI/CD dans l'extension VS Code

doc-locale/fr-fr/editor_extensions/visual_studio_code/cicd.md

19.3.06.1 KB
Original Source

{{< details >}}

  • Édition : Gratuite, GitLab Premium, GitLab Ultimate
  • Offre : GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< history >}}

{{< /history >}}

Si votre projet utilise des pipelines CI/CD GitLab, vous pouvez utiliser l'extension GitLab pour VS Code pour démarrer, surveiller et mettre à jour des pipelines directement dans votre IDE.

Prérequis {#prerequisites}

Surveiller et gérer les pipelines {#monitor-and-manage-pipelines}

Utilisez l'extension pour surveiller et gérer les pipelines de votre projet.

Prérequis :

  • Votre projet utilise des pipelines CI/CD.
  • Une merge request existe pour votre branche Git actuelle.
  • Le commit le plus récent sur votre branche Git actuelle possède un pipeline CI/CD.

Afficher le statut du pipeline {#view-pipeline-status}

Pour afficher le statut de votre pipeline de branche, consultez la barre d'état inférieure dans VS Code.

Les statuts possibles sont les suivants :

  • Pipeline annulé
  • Pipeline en échec
  • Pipeline réussi
  • Pipeline en attente
  • Pipeline en cours d'exécution
  • Pipeline ignoré
  • Aucun pipeline, si un pipeline n'a pas encore été exécuté.

Gérer les pipelines {#manage-pipelines}

Pour démarrer, surveiller et déboguer des pipelines CI/CD dans GitLab :

  1. Dans VS Code, dans la barre d'état inférieure, sélectionnez le statut du pipeline pour ouvrir la Command Palette et accéder aux actions disponibles.

  2. Sélectionnez l'action souhaitée et suivez les instructions :

    • Create New Pipeline from Current Branch
    • Cancel Last Pipeline
    • Download Artifacts from Latest Pipeline
    • Retry Last Pipeline
    • View Latest Pipeline on GitLab

Afficher la sortie d'un job CI/CD {#view-cicd-job-output}

Pour afficher la sortie d'un job CI/CD pour votre branche actuelle :

  1. Dans la barre latérale gauche, sélectionnez GitLab ({{< icon name="tanuki" >}}).

  2. Développez For current branch pour afficher le pipeline le plus récent.

  3. Sélectionnez un job pour l'ouvrir dans un nouvel onglet VS Code :

Pour ouvrir le job log d'un pipeline downstream :

  1. Trouvez les pipelines downstream dans la liste des jobs du pipeline de branche.
  2. Sélectionnez les icônes de flèche pour développer ou réduire les informations du pipeline downstream.
  3. Sélectionnez un pipeline downstream pour ouvrir le job log dans un nouvel onglet VS Code.

Gérer les alertes de pipeline {#manage-pipeline-alerts}

L'extension peut afficher une alerte dans VS Code lorsqu'un pipeline pour votre branche actuelle se termine :

Pour activer ou désactiver les alertes de pipeline :

  1. Dans VS Code, ouvrez l'éditeur Paramètres :
    • Sur macOS, appuyez sur <kbd>Command</kbd>+<kbd>,</kbd>.
    • Sur Windows ou Linux, appuyez sur <kbd>Control</kbd>+<kbd>,</kbd>.
  2. Selon votre configuration, sélectionnez les paramètres Utilisateur/utilisatrice ou Workspace.
  3. Sélectionnez Extensions > GitLab > Autre.
  4. Sous GitLab : Show Pipeline Update Notifications, cochez ou décochez la case.

Gérer votre configuration CI/CD {#manage-your-cicd-configuration}

L'extension fournit également des outils que vous pouvez utiliser pour créer et gérer la configuration CI/CD de votre projet.

Autocomplétion des variables CI/CD {#autocomplete-cicd-variables}

Lorsque vous rédigez ou modifiez votre fichier de configuration CI/CD, utilisez l'autocomplétion des variables pour les trouver rapidement.

Prérequis :

  • Le nom de votre fichier de configuration CI/CD commence par .gitlab-ci et se termine par .yml ou .yaml. Par exemple, .gitlab-ci.yml ou .gitlab-ci.production.yml

Pour autocompléter une variable CI/CD :

  1. Dans VS Code, ouvrez votre fichier .gitlab-ci.yml et assurez-vous que l'onglet du fichier est actif.

  2. Commencez à saisir le nom de la variable CI/CD. L'extension affiche des options d'autocomplétion.

  3. Sélectionnez une option pour l'utiliser :

Tester la configuration GitLab CI/CD {#test-gitlab-cicd-configuration}

Pour tester localement la configuration GitLab CI/CD de votre projet :

  1. Dans VS Code, ouvrez votre fichier .gitlab-ci.yml et assurez-vous que l'onglet du fichier est actif.
  2. Ouvrez la Command Palette :
    • Sur macOS, appuyez sur <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>.
    • Sur Windows ou Linux, appuyez sur <kbd>Control</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>.
  3. Saisissez GitLab: Validate GitLab CI Config et appuyez sur <kbd>Enter</kbd>.

L'extension affiche une alerte si elle détecte un problème dans votre configuration.

Afficher le fichier de configuration fusionné {#show-merged-configuration-file}

Pour afficher un aperçu de votre fichier de configuration CI/CD fusionné, avec toutes les instructions includes et références résolues :

  1. Dans VS Code, ouvrez votre fichier .gitlab-ci.yml et assurez-vous que l'onglet du fichier est actif.

  2. En haut à droite, sélectionnez Show Merged GitLab CI/CD Configuration :

VS Code ouvre un nouvel onglet (.gitlab-ci (Merged).yml) avec toutes les informations.

Sujets connexes {#related-topics}