Quick Start: Utiliser Salesforce CLI avec DevOps Center

Configuration d'un pipeline

Créez un pipeline, ajoutez et configurez ses étapes, activez le pipeline et joignez votre projet.

1. Répertoriez vos projets pour retrouver l'ID du projet.

   sf devops project list --target-org my-devops-org

   Copiez l'ID du projet que vous souhaitez joindre au pipeline. Les exemples de ce 0Hn000000000001 de démarrage rapide utilisent :

2. Créez un pipeline inactif et connectez-le à votre référentiel.

   sf devops pipeline create --target-org my-devops-org --name "Release Pipeline" --repo https://github.com/myorg/myrepo

   Copiez l'ID de pipeline depuis la sortie de la commande. Les exemples de ce 0XB000000000001 de démarrage rapide utilisent :

   Le pipeline reste inactif jusqu'à ce que vous configuriez ses étapes et l'activiez.

   Pour créer un référentiel en créant le pipeline, utilisez --create-repo with --repo-type github|bitbucket.

3. Ajoutez des étapes à votre pipeline. Un nouveau pipeline inclut une étape finale par défaut. Ajoutez chaque nouvelle étape avant une étape existante en spécifiant cette étape existante avec --next-stage-id.

   Par exemple, ajoutez une étape Intégration.

   sf devops pipeline stage add --target-org my-devops-org --pipeline-id 0XB000000000001 --name "Integration" --next-stage-id 0Xc000000000001

   Copiez l'ID d'étape depuis la sortie de la commande. Les exemples restants utilisent 0Xc000000000005 pour l'étape d'intégration. Répétez la commande pour chaque étape supplémentaire, par exemple UAT.

   

   Conseil Visualisez votre pipeline dans l'interface utilisateur du DevOps Center pour récupérer les ID d'étape des commandes suivantes. Ou exécutez sf devops pipeline get --pipeline-id 0XB000000000001.
4. Configurez chaque étape. Chaque étape nécessite une branche et un environnement. Configurez les étapes de droite à gauche, car l'étape finale doit avoir une branche pour pouvoir configurer les étapes qui la précèdent.

   Ajoutez une branche à l'étape Intégration. L'indicateur --create-vcs-branch crée la branche dans le référentiel si elle n'existe pas.

   sf devops stage branch add --target-org my-devops-org --pipeline-id 0XB000000000001 --stage-id 0Xc000000000005 --branch-name integration --create-vcs-branch

   Ajoutez un environnement sandbox à l'étape.

   sf devops stage environment add --target-org my-devops-org --pipeline-id 0XB000000000001 --stage-id 0Xc000000000005 --environment-name Integration_Org --org-type Sandbox

   Une fenêtre de navigateur s'ouvre pour vous authentifier à l'environnement. Utilisez --org-type Production pour des organisations de production. Dans un environnement headless, ajoutez des --no-browser et suivez les instructions d'authentification renvoyées par la commande.

   Répétez les commandes Branche et Environnement pour chaque étape. Utilisez le nom de l'agence, le nom de l'environnement et le type d'organisation appropriés pour chaque étape.

5. Activez le pipeline.
   

   Important Vous ne pouvez pas modifier l'étape du pipeline après avoir promu des modifications à travers ce pipeline. Assurez-vous que toutes les étapes sont correctement configurées avant d'exécuter cette commande.

   sf devops pipeline update --target-org my-devops-org --pipeline-id 0XB000000000001 --activate

6. Joignez votre projet DevOps Center au pipeline.

   sf devops pipeline project add --target-org my-devops-org --pipeline-id 0XB000000000001 --project-id 0Hn000000000001

   Le pipeline est prêt. Créez des éléments de travail dans l'interface utilisateur du DevOps Center ou exécutez la commande sf devops work-item create.

Gestion d'un élément de travail

Complétez un cycle de développement en commençant un élément de travail, en engageant vos modifications, en créant un examen et en marquant l'élément de travail prêt à être promu.

1. Définissez le statut de l'élément de travail sur En cours. DevOps Center crée une branche de fonctionnalité pour l'élément de travail.

   sf devops work-item update --target-org my-devops-org --work-item-name WI-000042 --status "In Progress"

2. Récupérez la branche de fonctionnalité dans le référentiel connecté et examinez-la dans votre projet local.

   git fetch origin
   git checkout WI-000042

3. Récupérez les modifications de votre organisation de développement. Cet exemple récupère une classe Apex de l'organisation avec l'my-sandbox alias.

   sf project retrieve start --target-org my-sandbox --metadata ApexClass:MyNewClass

4. Vérifiez les fichiers récupérés, mettez-les en scène, validez-les et envoyez automatiquement la branche de fonctionnalité.

   git status
   git add force-app
   git commit -am "Implement new feature"
   git push origin WI-000042

   Ajustez le chemin transmis à git add si votre projet Salesforce DX utilise un répertoire de package différent.

5. Créez une requête de modification (pull request) pour fusionner la branche fonctionnalité dans la branche cible.

   sf devops review create --target-org my-devops-org --work-item-name WI-000042

6. Attendez que votre équipe approuve et fusionne la demande de modification.
7. Mettez à jour le statut de l'élément de travail pour indiquer qu'il est prêt pour la promotion.

   sf devops work-item update --target-org my-devops-org --work-item-name WI-000042 --status "Ready to Promote"

Promotion d'un élément de travail

Promouvoir l'élément de travail à l'étape suivante du pipeline. DevOps Center valide la promotion, exécute les suites de tests configurées pour l'étape cible et déploie les modifications si les tests réussissent.

1. Promouvoir l'élément de travail en utilisant l'ID d'élément de travail et l'ID d'étape cible.

   sf devops promote --target-org my-devops-org --work-item-id 0Wx000000000042 --target-stage-id 0Xc000000000002

   La sortie de la commande inclut un ID de requête. Utilisez-le pour vérifier le statut de la promotion.

   Status: Completed
   Message: Work items successfully promoted to UAT.
   Request ID: a0B000000000001
   
   Promoted Work Items
   ───────────────────
   0Wx000000000042

2. Utilisez l'ID de requête pour vérifier le statut de la promotion.

   sf devops request status --target-org my-devops-org --request-token a0B000000000001

Tâches communes

Utilisez ces commandes pendant votre workflow de développement quotidien.

1. Promouvoir plusieurs éléments de travail à la même étape. Spécifiez --work-item-id une fois pour chaque élément de travail.

   sf devops promote --target-org my-devops-org --work-item-id 0Wx000000000042 --work-item-id 0Wx000000000043 --target-stage-id 0Xc000000000002

2. Déployez les modifications fusionnées en externe à une étape désynchronisée avec DevOps Center.

   sf devops promotion complete --target-org my-devops-org --target-stage-id 0Xc000000000002

Cas d'utilisation avancés

Une fois le workflow de base terminé, utilisez ces commandes pour les promotions qui nécessitent un contrôle supplémentaire.