La revue de code améliore la qualité des tâches de planification de production en exigeant une validation humaine avant le déploiement. Lorsque la revue de code obligatoire est activée, seules les tâches ayant passé la revue avec succès peuvent être déployées dans l'environnement de production.
Présentation
Dans DataWorks, activez la revue de code obligatoire pour éviter les échecs de tâches dus à un code non conforme et prévenir le gaspillage de ressources de calcul. Une fois cette option activée, les relecteurs doivent vérifier la qualité du code des tâches avant leur déploiement.
Revue obligatoire désactivée : Lors de la soumission d'un nœud, vous pouvez toujours lancer manuellement une revue. Toutefois, le nœud peut être déployé quel que soit le résultat de la revue.
-
Revue obligatoire activée : Lors de la soumission d'un nœud, vous devez sélectionner un relecteur qualifié pour effectuer la revue de code.
Si la revue est approuvée, le nœud poursuit sa soumission et son déploiement.
Si la revue n'est pas approuvée, le nœud ne peut ni être soumis ni déployé. Modifiez le code en fonction des commentaires de la revue et lancez une nouvelle revue. Le nœud ne pourra être déployé qu'après approbation de cette nouvelle revue.
Par ailleurs, lors du traitement d'un ticket de revue, un relecteur peut utiliser l'IA pour analyser intelligemment les modifications de code et obtenir rapidement une suggestion de conclusion de revue, un résumé des changements ainsi qu'une liste des problèmes afin d'aider à la prise de décision manuelle. L'IA fournit uniquement des suggestions ; c'est le relecteur qui prend la décision finale d'approuver ou non.
De plus, la page des détails de la revue de code prend en charge les commentaires au niveau des lignes sur la vue différentielle des modifications de code et des changements de configuration de planification. Les relecteurs et les initiateurs de revue peuvent laisser des commentaires sur des lignes de code ou des éléments de configuration spécifiques pour améliorer l'efficacité des discussions pendant la revue. Les modifications de configuration de qualité sont en lecture seule et ne permettent pas d'ajouter des commentaires au niveau des lignes.
Limites
La fonctionnalité de revue de code est disponible uniquement dans DataWorks Édition Professionnelle et versions ultérieures. Assurez-vous d'avoir activé DataWorks Édition Professionnelle ou une version supérieure. Pour plus d'informations sur les fonctionnalités des différentes éditions, consultez Éditions de DataWorks.
Seul un compte Alibaba Cloud, un Workspace Administrator ou un utilisateur RAM disposant de l'autorisation AliyunDataWorksFullAccess peut activer ou désactiver la revue de code pour un espace de travail. Pour plus d'informations, consultez Présentation des utilisateurs, des rôles et des autorisations.
Vous ne pouvez pas lancer de revue de code pour certains types de nœuds spéciaux, tels que les nœuds composites (nœuds do-while et for-each), ni pour les fichiers de ressources autres que Python.
(Facultatif) Administrateur : Activer la revue de code obligatoire
Un administrateur d'espace de travail peut activer la revue de code obligatoire depuis la page des paramètres de Data Studio.
Si la revue de code obligatoire est désactivée, vous pouvez toujours lancer une revue, mais celle-ci ne bloquera pas le processus de déploiement.
La suppression d'un nœud ne déclenche pas de revue de code lors de la soumission.
Accéder aux Paramètres de sécurité et autres
Accédez à la page Espaces de travail dans la console DataWorks. Dans la barre de navigation supérieure, sélectionnez la région souhaitée. Localisez l'espace de travail concerné et choisissez dans la colonne Actions.
-
Accédez à la page des paramètres de Data Studio.
Dans le coin inférieur gauche, cliquez sur l'icône
et sélectionnez Data Studio Settings.-
Accédez à Security Settings and Others.
Sur la page des paramètres de Data Studio, basculez vers l'onglet Security Settings and Others.
Activer la revue de code
Dans l'onglet Security Settings and Others, activez l'option Code Review > Mandatory Review.
Si vous ne trouvez pas le commutateur Mandatory Review dans l'onglet Security Settings and Others, vérifiez votre édition de DataWorks. La fonctionnalité de revue de code est disponible uniquement dans DataWorks Édition Professionnelle et versions ultérieures.
Paramètre | Description |
Mandatory Review | Indique si une revue de code est requise avant le déploiement des tâches de l'espace de travail actuel dans l'environnement de production. |
Project Code Reviewer | Configurez les relecteurs de code.
Remarque
|
Specify Mandatory Code Review Baseline Scope | Spécifie quels nœuds nécessitent une revue de code lors de leur soumission. Vous pouvez déterminer quels nœuds nécessitent une revue de code obligatoire en fonction de la priorité de la baseline à laquelle ils appartiennent :
Remarque Lorsque vous sélectionnez les tâches hors baseline, tous les nœuds nouvellement créés dans l'espace de travail requièrent une approbation. |
Code Review Notification Method | Après avoir activé la revue obligatoire, configurez des règles de notification pour garantir que le personnel concerné soit automatiquement informé :
Les méthodes de notification suivantes sont prises en charge : SMS, DingTalk Group Robot Webhook, Mail, WeChat Group Webhook, Lark Webhook et Standard Webhook. Les SMS d'alerte et les appels téléphoniques liés à la revue de code comptent dans votre utilisation des ressources d'alerte. Vous pouvez consulter cette utilisation sur la page Alert Resource de la console de gestion. Pour plus d'informations, consultez Consulter l'utilisation des ressources d'alerte. Remarque
|
Initiateur de revue : Lancer une revue de code
Une revue de code est déclenchée lorsque vous soumettez un nœud. Après avoir sélectionné un relecteur, un ticket de revue est généré. Si la revue de code obligatoire est activée, le déploiement est bloqué à l'étape du vérificateur de production jusqu'à ce que la revue soit approuvée.
Si un nœud fait déjà l'objet d'une revue de code en cours et qu'une nouvelle revue est lancée, le résultat de la revue précédente est automatiquement invalidé.
La suppression d'un nœud ne déclenche pas de revue de code.
-
Déployez la tâche.
Cliquez sur l'icône
pour enregistrer le nœud de développement de données que vous souhaitez déployer, puis cliquez sur l'icône
pour accéder à la page Online publishing content.Cliquez sur le bouton Start Release Production pour lancer le déploiement. Étant donné que la revue de code obligatoire est activée, le processus de déploiement est bloqué à l'étape du vérificateur de production. Le nœud ne peut être déployé qu'après approbation de la revue de code.
-
Lancez une revue de code.
Cliquez sur Initiate Code Review. Sur la page de configuration Code Review, configurez les champs Code Reviewer et Description of change.
Élément de configuration
Description
Code Reviewer
Sélectionnez le Project Code Reviewer configuré sous ce contrôle. Vous pouvez spécifier un ou plusieurs relecteurs de code.
Description of change
Décrivez les modifications apportées au code et toute autre information pertinente.
Une fois la configuration terminée, cliquez sur Confirm pour soumettre la revue de code.
Relecteur : Traiter un ticket de revue
Un relecteur de code peut consulter les revues en attente et traiter les tickets de revue dans Code Review List > Reviewed by Me.
-
Accédez à la page de revue de code.
Cliquez sur l'icône
dans le volet de navigation de gauche de la page Data Studio pour accéder à la page Code Review List > Reviewed by Me, où vous pouvez visualiser les tickets de revue de code qui vous sont assignés. -
Traitez un ticket de revue de code.
Sur la page Code Review List > Reviewed by Me, vous pouvez afficher les détails de la revue de code et effectuer des opérations sur les tickets de revue.
Sur la page de liste des revues de code : Vous pouvez rapidement effectuer les opérations suivantes sur les tickets de revue : By, Reject, Abandoned, Reopen et Share.
-
Sur la page des détails de la revue de code :
Sur la page Code Review List > Reviewed by Me, cliquez sur le ticket de revue de code que vous souhaitez examiner pour accéder à la page Code Review Details. Sur cette page, vous pouvez visualiser les modifications apportées au code et aux paramètres de planification par rapport à la version de production, et décider d'approuver ou non la revue de code.
-
Dans la section des opérations de revue, le relecteur peut effectuer les opérations de revue suivantes sur le ticket de revue :
: Approuver.
: Rejeter.
: Abandonner.
: Rouvrir.Comments.
RemarqueAbandoned : Abandonne la revue en cours. Une fois la revue abandonnée, le nœud peut être soumis et déployé directement.
Reopen : Rouvre une revue abandonnée pour une nouvelle évaluation.
Une fois la revue de code terminée, l'initiateur de la revue peut consulter les détails de la revue et gérer les tickets sur la page Code Review List > Reviewed by Me.
Commentaires au niveau des lignes
Sur la page des détails de la revue de code, les relecteurs et les initiateurs de revue peuvent ajouter des commentaires au niveau des lignes sur la vue différentielle des modifications de code ou des changements de configuration de planification afin de discuter de lignes ou d'éléments de configuration spécifiques.
-
Portée :
Les modifications de code et les changements de configuration de planification sont présentés dans une vue différentielle côte à côte qui permet d'ajouter des commentaires sur une ou plusieurs lignes de chaque côté.
Les commentaires relatifs aux modifications de code et aux changements de configuration de planification sont stockés séparément, ce qui facilite la localisation et le suivi des discussions.
Les changements de configuration de qualité sont en lecture seule et ne proposent pas de point d'entrée pour les commentaires au niveau des lignes.
-
Opérations et statuts :
Lorsque la revue de code n'est pas approuvée, vous pouvez commenter, répondre, modifier, supprimer, résoudre ou rouvrir un commentaire.
Une fois la revue de code approuvée, les commentaires deviennent en lecture seule. Vous pouvez uniquement consulter les commentaires existants. L'ajout, la réponse, la modification, la suppression, la résolution et la réouverture de commentaires ne sont plus autorisés.
Les opérations disponibles pour les commentaires au niveau des lignes dépendent à la fois de votre rôle dans le ticket de revue (auteur, relecteur, soumetteur, administrateur de projet ou autre membre) et du statut actuel de la revue.
Revue intelligente par IA
Un relecteur peut utiliser l'IA pour analyser intelligemment les modifications de code actuelles et obtenir rapidement une suggestion de conclusion de revue, un résumé des changements ainsi qu'une liste des problèmes. L'IA fournit uniquement des suggestions ; c'est le relecteur qui prend la décision finale d'approuver ou non.
-
Générez une suggestion de revue par IA.
Dans la section des opérations de revue, cliquez sur l'icône de revue intelligente située à côté de Comment. L'IA analyse les modifications de code actuelles. Une fois l'analyse terminée, le panneau Generated Result s'affiche.
-
Consultez le résultat généré.
Le panneau Generated Result contient :
Suggestion de conclusion de revue : L'IA propose une recommandation d'Approbation recommandée ou de Rejet recommandé.
Résumé des changements : Résume les principales modifications apportées au code et aux paramètres de planification.
-
Traitez le résultat généré.
Accept : Adopte la suggestion de l'IA. Le commentaire de revue est automatiquement rempli dans la zone de commentaire et la conclusion de l'IA est synchronisée. Soumettez la revue après confirmation.
Regenerate : Réanalyse les modifications et génère une nouvelle suggestion de revue.
Reject : Ignore la suggestion de l'IA. Le panneau se réduit et la revue se poursuit manuellement.
Initiateur de revue : Consulter les résultats de la revue
L'initiateur de la revue peut consulter les résultats de la revue et gérer les tickets de revue dans Code Review List > Reviewed by Me > Created by Me.
-
Accédez à la page de revue de code.
Cliquez sur le bouton
dans le volet de navigation de gauche de la page Data Studio pour accéder à la page de revue de code, où vous pouvez visualiser les tickets de revue de code Created by Me. -
Confirmez les résultats de la revue.
Sur la page Code Review List > Reviewed by Me > Created by Me, vous pouvez afficher les détails de la revue de code et effectuer des opérations sur les tickets de revue.
-
Sur la page de liste des revues de code : L'initiateur de la revue peut rapidement consulter les résultats de la revue et effectuer les opérations suivantes : Abandoned, Reopen ou Share.
RemarqueAprès l'abandon de la revue, la version actuelle du nœud doit être soumise à nouveau pour revue ou le ticket de revue doit être rouvert avant que le déploiement ne puisse se poursuivre.
Sur la page des détails de la revue de code : Sur la page Code Review List > Reviewed by Me, cliquez sur le ticket de revue de code correspondant pour accéder à la page Code Review Details, où vous pouvez décider de Reopen ou Abandoned la revue de code.
-
Si la revue n'est pas approuvée, le nœud ne peut ni être soumis ni déployé. Modifiez le code en fonction des commentaires de la revue et lancez une nouvelle revue. Le nœud ne pourra être déployé qu'après approbation de cette nouvelle revue.
Étape suivante
Une fois la revue de code approuvée, vous pouvez procéder au déploiement. Si la revue n'est pas approuvée, ajustez le code en fonction des commentaires de la revue et lancez une nouvelle revue.