Implementar políticas de check-in de análise de código personalizadas para código gerenciado

Uma política de check-in de análise de código especifica um conjunto de regras que os membros de um projeto do Azure DevOps devem executar no código-fonte antes de fazer check-in no controle de versão. A Microsoft fornece um conjunto de conjuntos de regras padrão que agrupam regras de análise de código em áreas funcionais. Os conjuntos de regras de política de check-in personalizados especificam um conjunto de regras de análise de código específicas de um projeto. Um conjunto de regras é armazenado em um arquivo .ruleset.

As políticas de check-in são definidas no nível do projeto do Azure DevOps e especificadas pelo local de um arquivo .ruleset na árvore de controle de versão. Não há restrições no local de controle de versão do conjunto de regras personalizadas da política de equipe.

A análise de código é configurada para os projetos de código individuais na janela de propriedades de cada projeto. Um conjunto de regras personalizado para um projeto de código é especificado pelo local físico do arquivo .ruleset no computador local. Quando um arquivo .ruleset é especificado que está localizado na mesma unidade que o projeto de código, o Visual Studio usa um caminho relativo para o arquivo na configuração do projeto.

Uma prática sugerida para criar um conjunto de regras personalizadas do projeto do Azure DevOps é armazenar o arquivo .ruleset de política de check-in em uma pasta especial que não faz parte de nenhum projeto de código. Se você armazenar o arquivo em uma pasta dedicada, é possível aplicar permissões que restringem quem pode editar o arquivo de regra e pode mover facilmente a estrutura de diretório que contém o projeto para outro diretório ou computador.

Criar o conjunto de regras de check-in personalizado do projeto

Para criar um conjunto de regras personalizado para um projeto do Azure DevOps, primeiro crie uma pasta especial para a regra de política de check-in definida no Source Control Explorer. Em seguida, você cria o arquivo de conjunto de regras e adiciona o arquivo ao controle de versão. Por fim, especifique o conjunto de regras como a política de check-in de análise de código para o projeto.

Observação

Para criar uma pasta em um projeto do Azure DevOps, primeiro você deve mapear a raiz do projeto para um local no computador local.

Para criar a pasta de controle de versão para o conjunto de regras de política de check-in

1. No Team Explorer, expanda o nó do projeto e clique em Controle do Código-Fonte.

2. No painel Pastas, clique com o botão direito do mouse no projeto e clique em Nova Pasta.

3. No painel principal controle do código-fonte, clique com o botão direito do mouse em Nova Pasta, clique em Renomear e digite um nome para a pasta do conjunto de regras.

Para criar o conjunto de regras de política de check-in

1. No menu Arquivo , aponte para Novoe clique em Arquivo.

2. Na lista Categorias, clique em Geral.

3. Na lista Modelos, clique duas vezes em Conjunto de Regras de Análise de Código.

4. Especifique as regras a serem incluídas no conjunto de regras e salve o arquivo de conjunto de regras na pasta do conjunto de regras criada.

Para adicionar o arquivo de conjunto de regras ao controle de versão

1. No Source Control Explorer, clique com o botão direito do mouse na nova pasta e clique em Adicionar Itens à Pasta.

   Para obter mais informações, consulte Git e Azure Repos.

2. Clique no arquivo de conjunto de regras criado e clique em Concluir.

   O arquivo é adicionado ao controle do código-fonte e faz check-out para você.

3. Na janela Detalhes do Source Control Explorer, clique com o botão direito do mouse no nome do arquivo e clique Verificar alterações pendentes.

4. Na caixa de diálogo Check-in, você tem a opção de adicionar um comentário e clicar Fazer check-in.

   Observação

   Se você já tiver configurado uma política de check-in de análise de código para seu projeto do Azure DevOps e tiver selecionado a opção Impor check-in para conter apenas arquivos que fazem parte da solução atual, você disparará um aviso de falha de política. Na caixa de diálogo Falha de Política, selecione Substituir falha de política e continuar check-in. Adicione um comentário necessário e clique em OK.

Para especificar o arquivo de conjunto de regras como a política de check-in

1. No menu Equipe, aponte para Configurações do Projeto e clique Controle do Código-Fonte.

2. Clique em Política de Check-in e, em seguida, clique em Adicionar.

3. Na lista Política de Check-in, clique duas vezes em Análise de Código e verifique se a caixa de seleção Impor Análise de Código para Código Gerenciado está selecionada.

4. Na lista Executar este conjunto de regras, clique <Selecionar Conjunto de Regras no Controle do Código-Fonte>.

5. Digite o caminho do arquivo de conjunto de regras de política de check-in no controle de versão.

   O caminho deve estar de acordo com a seguinte sintaxe:

   $/ TeamProjectName / VersionControlPath

   Observação

   É possível copiar o caminho usando um dos seguintes procedimentos no Source Control Explorer:

   • No painel Pastas, clique na pasta que contém o arquivo de conjunto de regras. Copie o caminho de controle de versão da pasta que aparece na caixa Origem e digite o nome do arquivo de conjunto de regras manualmente.

   • Na janela de detalhes, clique com o botão direito do mouse no arquivo de conjunto de regras e clique em Propriedades. Na guia Geral, copie o valor em Nome do Servidor.

Sincronizar projetos de código com o conjunto de regras de política de check-in

Especifique um conjunto de regras de política de check-in do projeto como o conjunto de regras de análise de código de uma configuração de projeto de código na caixa de diálogo propriedades do projeto de código. Se o conjunto de regras estiver localizado na mesma unidade que o projeto de código, um caminho relativo será usado para especificar o conjunto de regras quando o caminho for selecionado na caixa de diálogo do arquivo. O caminho relativo permite que as configurações de propriedades do projeto sejam portáteis para outros computadores que usam estruturas de controle de versão locais semelhantes.

Para especificar um conjunto de regras de projeto como o conjunto de regras de um projeto de código

1. Se necessário, recupere a pasta e o arquivo do conjunto de regras de política de check-in do controle de versão.

   É possível executar esta etapa no Source Control Explorer clicando com o botão direito do mouse na pasta conjunto de regras e clicando em Obter Versão Mais Recente.

2. No Gerenciador de Soluções, clique com o botão direito do mouse no projeto de código e, em seguida, clique em Propriedades.

3. Clique em Análise de código.

4. Se necessário, clique nas opções apropriadas nas listas Configuração e Plataforma.

5. Para executar a análise de código sempre que o projeto de código for criado usando a configuração especificada, selecione Executar no build na seção Analisadores binários.

6. Na lista Executar este conjunto de regras, clique em <Procurar>.

7. Selecione a versão local do arquivo de conjunto de regras de política de check-in.