Implémenter des stratégies d’archivage d’analyse du code personnalisées pour le code managéImplement Custom Code Analysis Check-in Policies for Managed Code

Une stratégie d’archivage de l’analyse du code spécifie un ensemble de règles que les membres d’un projet Azure DevOps doivent exécuter sur le code source avant qu’il soit archivé pour contrôle de version.A code analysis check-in policy specifies a set of rules that members of an Azure DevOps project must run on source code before it is checked in to version control. Microsoft fournit un ensemble de la norme ensembles de règles cette analyse de code de groupe de règles dans des zones fonctionnelles.Microsoft provides a set of standard rule sets that group code analysis rules into functional areas. Ensembles de règles de stratégie d’archivage personnalisée spécifier un ensemble de règles d’analyse du code qui sont spécifiques à un projet.Custom check-in policy rule sets specify a set of code analysis rules that are specific to a project. Un ensemble de règles est stocké dans un fichier .ruleset.A rule set is stored in a .ruleset file.

Stratégies d’archivage sont définies au niveau du projet d’Azure DevOps et spécifiées par l’emplacement d’un fichier .ruleset dans l’arborescence de contrôle de version.Check-in policies are set at the Azure DevOps project level and specified by the location of a .ruleset file in the version control tree. Il n’existe aucune restriction sur l’emplacement du contrôle de version de l’ensemble de règles personnalisé de stratégie team.There are no restrictions on the version control location of the team policy custom rule set.

Analyse du code est configurée pour les projets de code individuels dans la fenêtre Propriétés pour chaque projet.Code analysis is configured for the individual code projects in the properties window for each project. Une règle personnalisée définie pour un projet de code est spécifiée par l’emplacement physique du fichier .ruleset sur l’ordinateur local.A custom rule set for a code project is specified by the physical location of the .ruleset file on the local computer. Lorsqu’un fichier .ruleset est spécifié qui se trouve sur le même lecteur que le projet de code, Visual Studio utilise un chemin d’accès relatif au fichier dans la configuration de projet.When a .ruleset file is specified that is located on the same drive as the code project, Visual Studio uses a relative path to the file in the project configuration.

Une pratique suggérée pour la création d’un ensemble de règles personnalisé de projet consiste à stocker le fichier .ruleset de stratégie d’archivage dans un dossier spécial qui ne fait pas partie d’un projet de code de Azure DevOps.A suggested practice for creating an Azure DevOps project custom rule set is to store the check-in policy .ruleset file in a special folder that is not a part of any code project. Si vous stockez le fichier dans un dossier dédié, vous pouvez appliquer des autorisations qui limitent ce qui peuvent modifier le fichier de règles, et vous pouvez déplacer facilement la structure de répertoire qui contient le projet vers un autre répertoire ou ordinateur.If you store the file in a dedicated folder, you can apply permissions that restrict who can edit the rule file, and you can easily move the directory structure that contains the project to another directory or computer.

Créer le jeu de règles d’archivage personnalisées de projetCreate the Project Custom Check-in Rule Set

Pour créer une règle personnalisée définie pour un projet Azure DevOps, vous créez tout d’abord un dossier spécial pour la règle de stratégie d’archivage Explorateur du contrôle de Source.To create a custom rule set for an Azure DevOps project, you first create a special folder for the check-in policy rule set in Source Control Explorer. Ensuite, vous créez le fichier d’ensemble de règles et ajoutez le fichier au contrôle de version.Then you create the rule set file and add the file to version control. Enfin, vous spécifiez la règle définie en tant que la stratégie de vérification d’analyse du code pour le projet.Finally, you specify the rule set as the code analysis check-in policy for the project.

Note

Pour créer un dossier dans un projet Azure DevOps, vous devez d’abord mapper la racine du projet vers un emplacement sur l’ordinateur local.To create a folder in an Azure DevOps project, you first must map the project root to a location on the local computer.

Pour créer le dossier de contrôle de version pour l’ensemble de règles de stratégie d’archivageTo create the version control folder for the check-in policy rule set

  1. Dans Team Explorer, développez le nœud du projet, puis cliquez sur contrôle de code Source.In Team Explorer, expand the project node, and then click Source Control.

  2. Dans le dossiers volet, cliquez sur le projet, puis nouveau dossier.In the Folders pane, right-click the project and then click New Folder.

  3. Dans le volet principal de contrôle de code Source, cliquez sur nouveau dossier, cliquez sur renommeret tapez un nom pour l’ensemble de règles dossier.In the main Source Control pane, right-click New Folder, click Rename, and type a name for the rule set folder.

Pour créer l’ensemble de règles de stratégie d’archivageTo create the check-in policy rule set

  1. Sur le fichier menu, pointez sur New, puis cliquez sur fichier.On the File menu, point to New, and then click File.

  2. Dans le catégories , cliquez sur général.In the Categories list, click General.

  3. Dans le modèles , double-cliquez sur ensemble de règles d’analyse de Code.In the Templates list, double-click Code Analysis Rule Set.

  4. Spécifier les règles à inclure dans l’ensemble de règles, puis enregistrez la règle définie fichier dans le dossier de jeu de règle que vous avez créé.Specify the rules to include in the rule set, and then save the rule set file to the rule set folder that you created.

Pour ajouter la règle de définie le fichier de contrôle de versionTo add the rule set file to version control

  1. Dans Explorateur du contrôle de Source, cliquez sur le nouveau dossier, puis cliquez sur ajouter des éléments au dossier.In Source Control Explorer, right-click the new folder, and then click Add Items to Folder.

    Pour plus d’informations, consultez Git et les référentiels Azure.For more information, see Git and Azure Repos.

  2. Cliquez sur l’ensemble de règles fichier que vous avez créé, puis cliquez sur Terminer.Click the rule set file that you created, and then click Finish.

    Le fichier est ajouté au contrôle de code source et extrait pour vous.The file is added to source control and checked out to you.

  3. Dans le Explorateur du contrôle de Source fenêtre de détails, cliquez sur le nom de fichier, puis archiver les modifications en attente.In the Source Control Explorer details window, right-click the file name and then click Check in Pending Changes.

  4. Dans le archivage boîte de dialogue, vous pouvez ajouter un commentaire, puis cliquez sur archiver.In the Check-in dialog box, you have the option to add a comment and then click Check In.

    Note

    Si vous avez déjà configuré une stratégie d’archivage de l’analyse du code pour votre projet Azure DevOps et que vous avez sélectionné le appliquer l’archivage pour qu’il contienne uniquement les fichiers qui font partie de la solution actuelle, vous déclenchera un avertissement d’échec de stratégie.If you have already configured a code analysis check-in policy for your Azure DevOps project and you have selected the Enforce check-in to only contain files that are part of current solution, you will trigger a policy failure warning. Dans la boîte de dialogue d’échec de la stratégie, sélectionnez substituer l’échec de stratégie et poursuivre l’archivage.In the Policy Failure dialog box, select Override policy failure and continue checkin. Ajouter un commentaire requis, puis cliquez sur OK.Add a required comment, and then click OK.

Pour spécifier la règle de définie le fichier en tant que la stratégie d’archivageTo specify the rule set file as the check-in policy

  1. Sur le équipe menu, pointez sur paramètres du projet, puis cliquez sur contrôle de code Source.On the Team menu, point to Project Settings, and then click Source Control.

  2. Cliquez sur stratégie d’archivage, puis cliquez sur ajouter.Click Check-in Policy, and then click Add.

  3. Dans le stratégie d’archivage , double-cliquez sur analyse du Codeet vous assurer que le appliquer l’analyse du Code pour le Code managé case à cocher est activée.In the Check-in Policy list, double-click Code Analysis, and make sure that the Enforce Code Analysis for Managed Code check box is selected.

  4. Dans le exécuter cet ensemble de règles , cliquez sur <sélectionner l’ensemble de règles de contrôle de code Source >.In the Run this rule set list, click <Select Rule Set from Source Control>.

  5. Tapez le chemin d’accès du fichier de jeu de règle de stratégie d’archivage dans le contrôle de version.Type the path of the check-in policy rule set file in version control.

    Le chemin d’accès doit être conforme à la syntaxe suivante :The path must conform to the following syntax:

    $/ TeamProjectName / VersionControlPath$/ TeamProjectName / VersionControlPath

    Note

    Vous pouvez copier le chemin d’accès en utilisant l’une des procédures suivantes dans Explorateur du contrôle de Source:You can copy the path by using one of the following procedures in Source Control Explorer:

    • Dans le dossiers volet, cliquez sur le dossier qui contient le fichier d’ensemble de règles.In the Folders pane, click the folder that contains the rule set file. Copier le chemin d’accès du contrôle de version du dossier qui apparaît dans le Source , puis tapez le nom de fichier d’ensemble de la règle manuellement.Copy the version control path of the folder that appears in the Source box, and type the name of the rule set file manually.

    • Dans la fenêtre de détails, cliquez sur le fichier d’ensemble de règles, puis cliquez sur propriétés.In the details window, right-click the rule set file, and then click Properties. Sur le général onglet, copiez la valeur dans nom du serveur.On the General tab, copy the value in Server Name.

Synchroniser les projets de Code à l’ensemble de règles de stratégie d’archivageSynchronize Code Projects to the Check-in Policy Rule Set

Vous spécifiez une règle de stratégie d’archivage de projet est défini comme l’ensemble de règles code analyse d’une configuration de projet de code dans la boîte de dialogue Propriétés du projet de code.You specify a project check-in policy rule set as the code analysis rule set of a code project configuration in the properties dialog box of the code project. Si l’ensemble de règles se trouve sur le même lecteur que le projet de code, un chemin d’accès relatif est utilisé pour spécifier l’ensemble de règles lorsque le chemin d’accès est sélectionné dans la boîte de dialogue de fichier.If the rule set is located on the same drive as the code project, a relative path is used to specify rule set when the path is selected from the file dialog box. Structures de contrôle de chemin d’accès relatif permet les paramètres de propriétés de projet soit portable sur d’autres ordinateurs qui utilisent la version locale similaire.The relative path enables the project properties settings to be portable to other computers that use similar local version control structures.

Pour spécifier une règle de projet définie en tant que l’ensemble de règles d’un projet de codeTo specify a project rule set as the rule set of a code project

  1. Si nécessaire, extrayez le dossier de jeu de règles de stratégie d’archivage et le fichier à partir du contrôle de version.If necessary, retrieve the check-in policy rule set folder and file from version control.

    Vous pouvez effectuer cette étape dans Explorateur du contrôle de Source en double-cliquant sur la règle définie puis cliquer sur obtenir la dernière Version.You can perform this step in Source Control Explorer by right-clicking the rule set folder and then clicking Get Latest Version.

  2. Dans l’Explorateur de solutions, cliquez sur le projet de code, puis cliquez sur propriétés.In Solution Explorer, right-click the code project, and then click Properties.

  3. Cliquez sur l’analyse du Code.Click Code Analysis.

  4. Si nécessaire, cliquez sur les options appropriées dans le Configuration et plateforme répertorie.If necessary, click the appropriate options in the Configuration and Platform lists.

  5. Pour exécuter l’analyse du code chaque fois que le projet de code est généré à l’aide de la configuration spécifiée, sélectionnez le Enable Code Analysis sur la Build (définit la constante CODE_ANALYSIS) case à cocher.To run code analysis every time that the code project is built using the specified configuration, select the Enable Code Analysis on Build (defines CODE_ANALYSIS constant) check box.

  6. Pour ignorer le code dans les composants d’autres sociétés, sélectionnez le supprimer les résultats du code généré case à cocher.To ignore code in components from other companies, select the Suppress results from generated code check box.

  7. Dans le exécuter cet ensemble de règles , cliquez sur <Parcourir... >.In the Run this rule set list, click <Browse...>.

  8. Spécifiez la version locale du fichier de jeu de règle de stratégie d’archivage.Specify the local version of the check-in policy rule set file.