VSBuild@1 – Tarefa de build v1 do Visual Studio

  • Artigo

Use essa tarefa para compilar com o MSBuild e definir a propriedade de versão do Visual Studio. Saiba mais sobre como instalar imagens do Visual Studio no Azure.

Syntax

# Visual Studio build v1
# Build with MSBuild and set the Visual Studio version property.
- task: VSBuild@1
  inputs:
    solution: '**\*.sln' # string. Required. Solution. Default: **\*.sln.
    #vsVersion: 'latest' # 'latest' | '17.0' | '16.0' | '15.0' | '14.0' | '12.0' | '11.0'. Visual Studio Version. Default: latest.
    #msbuildArgs: # string. MSBuild Arguments. 
    #platform: # string. Platform. 
    #configuration: # string. Configuration. 
    #clean: false # boolean. Clean. Default: false.
  # Advanced
    #maximumCpuCount: false # boolean. Build in Parallel. Default: false.
    #restoreNugetPackages: false # boolean. Restore NuGet Packages. Default: false.
    #msbuildArchitecture: 'x86' # 'x86' | 'x64'. MSBuild Architecture. Default: x86.
    #logProjectEvents: true # boolean. Record Project Details. Default: true.
    #createLogFile: false # boolean. Create Log File. Default: false.
    #logFileVerbosity: 'normal' # 'quiet' | 'minimal' | 'normal' | 'detailed' | 'diagnostic'. Optional. Use when createLogFile = true. Log File Verbosity. Default: normal.
    #enableDefaultLogger: true # boolean. Enable Default Logger. Default: true.
    #customVersion: # string. Custom Version.

# Visual Studio build v1
# Build with MSBuild and set the Visual Studio version property.
- task: VSBuild@1
  inputs:
    solution: '**\*.sln' # string. Required. Solution. Default: **\*.sln.
    #vsVersion: 'latest' # 'latest' | '16.0' | '15.0' | '14.0' | '12.0' | '11.0'. Visual Studio Version. Default: latest.
    #msbuildArgs: # string. MSBuild Arguments. 
    #platform: # string. Platform. 
    #configuration: # string. Configuration. 
    #clean: false # boolean. Clean. Default: false.
  # Advanced
    #maximumCpuCount: false # boolean. Build in Parallel. Default: false.
    #restoreNugetPackages: false # boolean. Restore NuGet Packages. Default: false.
    #msbuildArchitecture: 'x86' # 'x86' | 'x64'. MSBuild Architecture. Default: x86.
    #logProjectEvents: true # boolean. Record Project Details. Default: true.
    #createLogFile: false # boolean. Create Log File. Default: false.
    #logFileVerbosity: 'normal' # 'quiet' | 'minimal' | 'normal' | 'detailed' | 'diagnostic'. Optional. Use when createLogFile = true. Log File Verbosity. Default: normal.

# Visual Studio Build v1
# Build with MSBuild and set the Visual Studio version property.
- task: VSBuild@1
  inputs:
    solution: '**\*.sln' # string. Required. Solution. Default: **\*.sln.
    #vsVersion: 'latest' # 'latest' | '16.0' | '15.0' | '14.0' | '12.0' | '11.0'. Visual Studio Version. Default: latest.
    #msbuildArgs: # string. MSBuild Arguments. 
    #platform: # string. Platform. 
    #configuration: # string. Configuration. 
    #clean: false # boolean. Clean. Default: false.
  # Advanced
    #maximumCpuCount: false # boolean. Build in Parallel. Default: false.
    #restoreNugetPackages: false # boolean. Restore NuGet Packages. Default: false.
    #msbuildArchitecture: 'x86' # 'x86' | 'x64'. MSBuild Architecture. Default: x86.
    #logProjectEvents: true # boolean. Record Project Details. Default: true.
    #createLogFile: false # boolean. Create Log File. Default: false.

Entradas

solution - Solução
string. Obrigatórios. Valor padrão: **\*.sln.

Especifica a solução para a tarefa a ser usada no processo de build.

Se você quiser criar uma única solução, clique no botão ... e especifique a solução.

Se você quiser criar várias soluções, especifique os critérios de pesquisa. Você pode usar um curinga de pasta única (*) e curingas recursivos (**). Por exemplo, **.sln pesquisa todos os arquivos .sln em todos os subdiretórios.

Verifique se as soluções especificadas são baixadas por este pipeline de build. Na guia Repositório:

  • Se você usar o TFVC, verifique se a solução é filho de um dos mapeamentos na guia Repositório.
  • Se você usar o Git, verifique se o projeto ou a solução está no repositório Git e em um branch que você esteja criando.

Dica

  • Você também pode criar arquivos de projeto do MSBuild (.*proj).
  • Se você estiver criando um arquivo de projeto personalizado do MSBuild, recomendamos que você use a tarefa MSBuild em vez da tarefa Build do Visual Studio.

vsVersion - Versão do Visual Studio
string. Valores permitidos: latest, 17.0 (Visual Studio 2022), 16.0 (Visual Studio 2019), 15.0 (Visual Studio 2017), 14.0 (Visual Studio 2015), 12.0 (Visual Studio 2013) 11.0 (Visual Studio 2012). Valor padrão: latest.

O valor dessa entrada deve corresponder à versão do Visual Studio usada para criar sua solução.

Adiciona o /p:VisualStudioVersion={numeric_visual_studio_version} argumento ao comando MSBuild executado pelo build. Por exemplo, se você especificar o Visual Studio 2015, /p:VisualStudioVersion=14.0 será adicionado ao comando MSBuild.

Azure Pipelines: se sua equipe quiser usar o Visual Studio com os agentes hospedados pela Microsoft, selecione windows-latest como seu pool de build padrão. Confira Agentes hospedados pela Microsoft.


vsVersion - Versão do Visual Studio
string. Valores permitidos: latest, 16.0 (Visual Studio 2019), 15.0 (Visual Studio 2017), 14.0 (Visual Studio 2015), 12.0 (Visual Studio 2013) 11.0 (Visual Studio 2012). Valor padrão: latest.

O valor dessa entrada deve corresponder à versão do Visual Studio usada para criar sua solução.

Adiciona o /p:VisualStudioVersion={numeric_visual_studio_version} argumento ao comando MSBuild executado pelo build. Por exemplo, se você especificar o Visual Studio 2015, /p:VisualStudioVersion=14.0 será adicionado ao comando MSBuild.

Azure Pipelines: se sua equipe quiser usar o Visual Studio com os agentes hospedados pela Microsoft, selecione windows-latest como seu pool de build padrão. Confira Agentes hospedados pela Microsoft.


msbuildArgs - Argumentos do MSBuild
string.

Passa argumentos adicionais para o MSBuild. Para obter ajuda, confira Referência de linha de comando do MSBuild.


platform - Plataforma
string.

Especifica a plataforma que você deseja criar, como Win32, x86, x64ou any cpu.

Dica

  • Se você estiver direcionando um arquivo de projeto do MSBuild (.*proj) em vez de uma solução, especifique AnyCPU (sem espaço em branco).
  • Declare uma variável de compilação, como BuildPlatform na guia Variáveis (selecionando Permitir no Tempo de Fila) e faça referência a ela aqui como $(BuildPlatform). Dessa forma, você pode modificar a plataforma ao enfileirar o build e habilitar a criação de várias configurações.

configuration - Configuração
string.

Especifica a configuração que você deseja criar, como debug ou release.

Dica

Declare uma variável de compilação, como BuildConfiguration na guia Variáveis (selecionando Permitir no Tempo de Fila) e faça referência a ela aqui como $(BuildConfiguration). Dessa forma, você pode modificar a plataforma ao enfileirar o build e habilitar a criação de várias configurações.


clean - Limpo
boolean. Valor padrão: false.

Se definido como false, a tarefa fará um build incremental. Essa configuração pode reduzir o tempo de compilação, especialmente se a base de código for grande. Essa opção não tem efeito prático, a menos que você também defina o repositório Clean como false.

Se definido como true, a tarefa recompila todo o código nos projetos de código. Isso equivale ao argumento MSBuild /target:clean.


maximumCpuCount - Compilar em Paralelo
boolean. Valor padrão: false.

Opcional. Se a configuração de destino do MSBuild for compatível com a criação em paralelo, você poderá marcar essa entrada para passar a opção /m para o MSBuild (somente Windows). Se a configuração de destino não for compatível com a compilação em paralelo, a marcação dessa opção poderá fazer com que a compilação resulte em erros de arquivo em uso ou falhas de compilações intermitentes ou inconsistentes.


restoreNugetPackages - Restaurar pacotes NuGet
boolean. Valor padrão: false.

Essa entrada foi preterida. Para restaurar pacotes NuGet, adicione uma tarefa do Instalador de Ferramentas do NuGet antes do build.


msbuildArchitecture - Arquitetura do MSBuild
string. Valores permitidos: x86 (MSBuild x86) x64 (MSBuild x64). Valor padrão: x86.

Opcional. Fornece a arquitetura (x86 ou x64) do MSBuild para execução.

Dica

Como o Visual Studio é executado como um aplicativo de 32 bits, você pode enfrentar problemas quando seu build é processado por um agente de build que está executando a versão de 64 bits do Team Foundation Build Service. Selecionando MSBuildx86, você pode resolve esses problemas.


logProjectEvents - Registrar detalhes do projeto
boolean. Valor padrão: true.

Opcional. Registra linha do tempo detalhes de cada projeto.


createLogFile - Criar arquivo de log
boolean. Valor padrão: false.

Opcional. Cria um arquivo de log (somente Windows).


logFileVerbosity - Verbosity do Arquivo de Log
string. Opcional. Use quando createLogFile = true. Valores permitidos: quiet, , minimal, normal, detailed, diagnostic. Valor padrão: normal.

Especifica o nível de detalhamento nos arquivos de log.


enableDefaultLogger - Habilitar o Agente Padrão
boolean. Valor padrão: true.

Se definido como true, habilita o agente padrão para MSBuild.


customVersion - Versão Personalizada
string.

Define uma versão personalizada do Visual Studio. Exemplos: 15.0, 16.0, 17.0. A versão necessária do Visual Studio deve ser instalada no sistema.

Azure Pipelines: se sua equipe quiser usar o Visual Studio 2022 com os agentes hospedados pela Microsoft, selecione windows-2022 como o pool de build padrão. Para obter mais informações, consulte Agentes hospedados pela Microsoft.


Opções de controle da tarefa

Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.

Variáveis de saída

Nenhum.

Comentários

Saiba mais sobre como instalar imagens do Visual Studio no Azure.

Importante

Essa tarefa só é compatível com agentes que executam o Windows.

Requisitos

Requisito Descrição
Tipos de pipeline YAML, build clássico
É executado em Agent, DeploymentGroup
Demandas Os agentes auto-hospedados devem ter recursos que correspondam às seguintes demandas para executar trabalhos que usam esta tarefa: msbuild, visualstudio
Funcionalidades Essa tarefa não atende a nenhuma demanda por tarefas subsequentes no trabalho.
Restrições de comando Qualquer
Variáveis configuráveis Qualquer
Versão do agente 1.95.0 ou superior
Categoria da tarefa Build