VSBuild@1 - Tâche de build Visual Studio v1

  • Article

Utilisez cette tâche pour générer avec MSBuild et définir la propriété de version Visual Studio. En savoir plus sur l’installation d’images Visual Studio sur 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.

Entrées

solution - Solution
string. Obligatoire. Valeur par défaut : **\*.sln.

Spécifie la solution pour la tâche à utiliser dans le processus de génération.

Si vous souhaitez créer une seule solution, cliquez sur le bouton ... et spécifiez la solution.

Si vous souhaitez créer plusieurs solutions, spécifiez les critères de recherche. Vous pouvez utiliser un caractère générique pour un seul dossier (*) et des caractères génériques récursifs (**). Par exemple, **.sln recherche tous les fichiers .sln dans tous les sous-répertoires.

Vérifiez que les solutions que vous spécifiez sont téléchargées par ce pipeline de build. Sous l’onglet Dépôt :

  • Si vous utilisez TFVC, vérifiez que la solution est un enfant d’un des mappages sous l’onglet Dépôt.
  • Si vous utilisez Git, vérifiez que le projet ou la solution est dans votre dépôt Git, dans une branche que vous générez.

Conseil

  • Vous pouvez également générer des fichiers projet MSBuild (.*proj).
  • Si vous générez un fichier projet MSBuild personnalisé, nous vous recommandons d’utiliser la tâche MSBuild au lieu de la tâche Build Visual Studio.

vsVersion - Visual Studio Version
string. Valeurs autorisées : 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). Valeur par défaut : latest.

La valeur de cette entrée doit correspondre à la version de Visual Studio utilisée pour créer votre solution.

Ajoute l’argument /p:VisualStudioVersion={numeric_visual_studio_version} à la commande MSBuild exécutée par la build. Par exemple, si vous spécifiez Visual Studio 2015, /p:VisualStudioVersion=14.0 est ajouté à la commande MSBuild.

Azure Pipelines : si votre équipe souhaite utiliser Visual Studio avec les agents hébergés par Microsoft, sélectionnez windows-latest comme pool de builds par défaut. Consultez Agents hébergés par Microsoft.


vsVersion - Visual Studio Version
string. Valeurs autorisées : 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). Valeur par défaut : latest.

La valeur de cette entrée doit correspondre à la version de Visual Studio utilisée pour créer votre solution.

Ajoute l’argument /p:VisualStudioVersion={numeric_visual_studio_version} à la commande MSBuild exécutée par la build. Par exemple, si vous spécifiez Visual Studio 2015, /p:VisualStudioVersion=14.0 est ajouté à la commande MSBuild.

Azure Pipelines : si votre équipe souhaite utiliser Visual Studio avec les agents hébergés par Microsoft, sélectionnez windows-latest comme pool de builds par défaut. Consultez Agents hébergés par Microsoft.


msbuildArgs - MSBuild Arguments
string.

Passe des arguments supplémentaires à MSBuild. Pour connaître la syntaxe, consultez Informations de référence sur la ligne de commande MSBuild.


platform - Plate-forme
string.

Spécifie la plateforme que vous souhaitez générer, telle que Win32, x86, x64ou any cpu.

Conseil

  • Si vous ciblez un fichier projet MSBuild (.*proj) au lieu d’une solution, spécifiez AnyCPU (aucun espace).
  • Déclarez une variable de build comme BuildPlatform sous l’onglet Variables (en sélectionnant Autoriser au moment de la file d’attente) et référencez-la ici comme $(BuildPlatform). De cette façon, vous pouvez modifier la plateforme quand vous mettez la build en file d’attente et activez la génération de plusieurs configurations.

configuration - Configuration
string.

Spécifie la configuration que vous souhaitez générer, telle que debug ou release.

Conseil

Déclarez une variable de build comme BuildConfiguration sous l’onglet Variables (en sélectionnant Autoriser au moment de la file d’attente) et référencez-la ici comme $(BuildConfiguration). De cette façon, vous pouvez modifier la plateforme quand vous mettez la build en file d’attente et activez la génération de plusieurs configurations.


clean - Propre
boolean. Valeur par défaut : false.

Si la falsevaleur est définie sur , la tâche effectue une génération incrémentielle. Ce paramètre peut réduire le temps de génération, en particulier si votre codebase est grand. Cette option n’a aucun effet pratique, sauf si vous définissez également le dépôt Propre sur false.

Si la valeur est truedéfinie sur , la tâche reconstruit tout le code dans les projets de code. Cela équivaut à l’argument /target:clean MSBuild.


maximumCpuCount - Générer en parallèle
boolean. Valeur par défaut : false.

facultatif. Si votre configuration cible MSBuild est compatible avec la génération en parallèle, vous pouvez case activée cette entrée pour passer le /m commutateur à MSBuild (Windows uniquement). Si votre configuration cible n’est pas compatible avec la génération en parallèle, la sélection de cette option peut entraîner des erreurs de type Fichier en cours d’utilisation, ou des échecs de build intermittents ou incohérents.


restoreNugetPackages - Restaurer des packages NuGet
boolean. Valeur par défaut : false.

Cette entrée est déconseillée. Pour restaurer des packages NuGet, ajoutez une tâche du programme d’installation de l’outil NuGet avant la génération.


msbuildArchitecture - MSBuild Architecture
string. Valeurs autorisées : x86 (MSBuild x86), x64 (MSBuild x64). Valeur par défaut : x86.

facultatif. Fournit l’architecture (x86 ou x64) de MSBuild à exécuter.

Conseil

Étant donné que Visual Studio s’exécute en tant qu’application 32 bits, vous pouvez rencontrer des problèmes lorsque votre build est traitée par un agent de build qui exécute la version 64 bits de Team Foundation Build Service. En sélectionnant MSBuild x86, vous pouvez résoudre ces problèmes.


logProjectEvents - Enregistrer les détails du projet
boolean. Valeur par défaut : true.

facultatif. Enregistre chronologie détails pour chaque projet.


createLogFile - Créer un fichier journal
boolean. Valeur par défaut : false.

facultatif. Crée un fichier journal (Windows uniquement).


logFileVerbosity - Détail du fichier journal
string. facultatif. Utilisez quand createLogFile = true. Valeurs autorisées : quiet, minimal, normal, detailed, diagnostic. Valeur par défaut : normal.

Spécifie le niveau de détail dans les fichiers journaux.


enableDefaultLogger - Activer l’enregistreur d’événements par défaut
boolean. Valeur par défaut : true.

Si la valeur trueest définie sur , active l’enregistreur d’événements par défaut pour MSBuild.


customVersion - Version personnalisée
string.

Définit une version personnalisée de Visual Studio. Exemples : 15.0, 16.0, 17.0. La version requise de Visual Studio doit être installée dans le système.

Azure Pipelines : si votre équipe souhaite utiliser Visual Studio 2022 avec les agents hébergés par Microsoft, sélectionnez windows-2022 comme pool de builds par défaut. Pour plus d’informations, consultez Agents hébergés par Microsoft.


Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Notes

En savoir plus sur l’installation d’images Visual Studio sur Azure.

Important

Cette tâche est uniquement prise en charge sur les agents exécutant Windows.

Configuration requise

Condition requise Description
Types de pipelines YAML, build classique
S’exécute sur Agent, DeploymentGroup
Demandes Les agents auto-hébergés doivent avoir des fonctionnalités qui correspondent aux exigences suivantes pour exécuter des travaux qui utilisent cette tâche : msbuild, visualstudio
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commande Quelconque
Variables paramétrables Quelconque
Version de l’agent 1.95.0 ou version ultérieure
Catégorie de la tâche Build