Améliorez vos revues de code avec ces outils populaires

par Phil Miller

‍

Dans notre article précédent, nous avons parlé de l'importance des revues de code et nous avons passé en revue un ensemble de meilleures pratiques à cet égard. Si vous ne l'avez pas encore lu, revenez en arrière et commencez par là. Nous vous attendons :) 

En partant de notre compréhension commune de ce qui fait une bonne revue de code, nous pouvons tous convenir qu'à la base, une revue comprend un ensemble de changements proposés (très probablement des commits git) et un certain contexte de soutien (tickets de gestion de projet, documents, actifs de conception, etc). Cette révision existe dans l'outil de contrôle de source de votre choix, sous la forme d'une demande d'extraction/fusion (PR ou MR). Elle comprendra très probablement une forme de flux de travail (par exemple, des approbations), de CI/CD (par exemple, des déploiements de prévisualisation automatisés), ainsi qu'une certaine facilité pour les commentaires et la liaison de ressources connexes. 

Ce flux de travail permet d'améliorer la qualité du code et la maintenabilité grâce à l'examen par les pairs, en plus de l'avantage supplémentaire que représente le partage des connaissances au sein de l'organisation. 

Voyons comment cela se passe : 

• Github
• Bitbucket
• Azure DevOps
• Gitlab

En outre, nous examinerons certains outils qui peuvent fonctionner seuls ou en complément de ces plates-formes.

‍

Github - le choix populaire

Github est un choix immensément populaire pour une bonne raison. Ce qui a commencé comme la plateforme moderne de référence pour les dépôts git hébergés, qu'ils soient open ou closed source, s'est transformé en une plateforme de développement complète qui comprend des éléments tels que : l'hébergement de paquets, l'analyse de la sécurité, les environnements de développement, les assistants IA, la planification de projets et les forums de discussion. 

Méthode d'examen du code : Demande d'extraction

Caractéristiques populaires : 

• Commentaires - les évaluateurs peuvent commenter les différences de code en texte enrichi 
• Modifications suggérées - les évaluateurs peuvent suggérer des mises à jour du code en contexte lors de l'évaluation.

Intégrations populaires : 

• Couverture du code : Codecov, Coveralls
• Examen automatisé : CodeFactor, Codacy
• Mentor du code de l'IA : Korbit

CI/CD

• Actions Github

‍

Bitbucket - collaboration pour ceux qui font partie de l'écosystème Atlassian

Si vous travaillez avec JIRA, Bitbucket est vraiment une évidence lorsqu'il s'agit d'une intégration étroite avec votre contrôle de source. Ceci est encore plus convaincant lorsque vous considérez des fonctionnalités puissantes comme les Pipelines et une multitude d'intégrations et de rapports disponibles. 

Méthode de révision du code : Bitbucket Code Review pull request

Caractéristiques populaires :

• Intégration native de JIRA - tout votre contexte est disponible directement dans la revue, y compris la possibilité de créer et d'attribuer de nouveaux tickets.
• Tâches de premier niveau - tâches assignables dans les listes de tâches 

Intégrations populaires : 

• Beaucoup sont disponibles via Atlassian Cloud

CI/CD : 

• Pipelines Bitbucket

‍

Azure DevOps : la suite unifiée de Microsoft

Si vous êtes dans l'écosystème Azure, Azure DevOps est un choix convaincant. Il offre un nombre illimité de dépôts git privés (Repos), CI/CD (Pipelines et Artifacts), la planification de projets (Boards) et même une sécurité avancée par rapport à son frère GitHub. 

Méthode d'examen du code : Repos pull request

Caractéristiques populaires :

• Dépôts privés illimités
• Recherche sémantique de codes 

Intégrations populaires : 

• Un ensemble complet disponible via les extensions du marché

CI/CD : 

• Pipelines Azure

‍

Gitlab : Open source et fonctionnalités complètes

Ce qui était autrefois considéré comme l'alternative open source de facto à GitHub est devenu la plateforme DevSecOps open-core. Dotée de tout ce que l'on peut attendre de plateformes similaires (CI/CD, gestion de projet, sécurité, conformité), elle possède également d'impressionnantes fonctions d'IA(GitLab Duo). 

Méthode d'examen du code : Demande de fusion

Caractéristiques populaires :

• IDE Web puissant basé sur VS Code
• Environnements à la demande pilotés par GitOps et soutenus par Kubernetes

Intégrations populaires : 

• Liste exhaustive d'éléments tels que les traqueurs d'incidents, la sécurité et l'informatique décisionnelle.

CI/CD : 

• CI/CD indépendant de l'infrastructure 

‍

Au-delà du contrôle des sources

Maintenant que vous avez une idée des outils disponibles dans la plateforme de votre choix, examinons quelques autres outils qui pourraient potentiellement améliorer vos révisions de code. 

Creuset 

Crucible, l'outil de révision autonome d'Atlassian, mérite d'être considéré si vous utilisez un contrôle de source autre que Git (par exemple SVG, CVS, Mercurial, Perforce) ou si votre organisation dispose d'un mélange de différents types de dépôts. Il inclut les fonctionnalités que vous attendez, comme les révisions et les rapports. De plus, comme il s'agit d'un produit d'Atlassian, il fonctionnera bien avec Bitbucket et JIRA. 

Commission de révision

‍

Une autre option qui existe depuis plus de 17 ans ( !) est Review Board. Il devrait fonctionner avec pratiquement n'importe quel type de SCM, et certaines des plus grandes entreprises du monde lui font confiance. En plus de la revue de code, il permet également la revue d'images et de documents, et il est gratuit et open source. 

Gerrit

Gerrit est un outil open-source de revue de code et de gestion de projet qui remonte à plusieurs outils similaires de Google. Si vous hébergez vous-même vos dépôts git et que vous voulez un outil (relativement) léger, alors jetez un coup d'oeil à Gerrit. Il a une caractéristique notable dans sa gestion de `git amend`. 

Codestream

Si vous êtes du genre à vivre dans votre IDE (dans ce cas, il doit s'agir de JetBrains, VS Code ou Visual Studio), alors jetez un coup d'œil à New Relic CodeStream. Il vous permet d'examiner les Pull Requests et de voir les commentaires des PRs précédemment fusionnés dans le contexte du code lui-même. Parmi les autres nouvelles fonctionnalités, citons Les demandes de feedback (essentiellement des PR légers), les discussions sur le code (via Slack, MS Teams ou e-mail), la gestion des problèmes (JIRA, Trello, Github, etc.) et, bien sûr, l'intégration étroite avec la plateforme d'observabilité de New Relic. 

Korbit.ai

L'explosion des solutions basées sur l'IA est l'un des développements les plus excitants dans le domaine des outils de revue de code. Korbit AI Mentor révise votre code en toute sécurité et vous aide à résoudre des problèmes tels que les bogues critiques, l'optimisation des performances, les vulnérabilités de sécurité et les normes de codage. Il répondra aux commentaires, suggérera du code de remplacement et fournira même des exercices pour améliorer les compétences de vos ingénieurs ! Il fournit également des informations via son tableau de bord Mentor pour aider à la planification de projets et à la performance de l'équipe. 

‍

Conclusion

Cela devrait vous donner une vue d'ensemble du paysage des outils de revue de code. Il existe une vaste gamme de logiciels disponibles pour tous ceux qui cherchent un bon point de départ, ou même pour les organisations qui souhaitent faire passer leur développement logiciel et leur revue de code au niveau supérieur.

Dans notre prochaine série d'articles, nous nous pencherons sur les spécificités du choix de l'outil adapté à votre organisation, ainsi que sur les meilleures pratiques détaillées pour chacune des plateformes les plus populaires. 

En attendant, si vous voulez améliorer votre équipe et faire de meilleures revues de code avec l'IA, jetez un coup d'œil au Korbit AI Mentor et faites-nous savoir ce que vous en pensez. Nous apprécions vos commentaires ! 

‍