VSBuild@1 — zadanie kompilacji programu Visual Studio w wersji 1

Artykuł
07/02/2024

To zadanie służy do kompilowania za pomocą programu MSBuild i ustawiania właściwości wersji programu Visual Studio. Dowiedz się więcej na temat instalowania obrazów programu Visual Studio na platformie Azure.

Składnia

# 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.

Dane wejściowe

solution - Rozwiązanie
string. Wymagane. Wartość domyślna: **\*.sln.

Określa rozwiązanie zadania do użycia w procesie kompilacji.

Jeśli chcesz utworzyć jedno rozwiązanie, kliknij przycisk ... i określ rozwiązanie.

Jeśli chcesz utworzyć wiele rozwiązań, określ kryteria wyszukiwania. Można użyć symboli wieloznacznych () z jednym folderem (*) i cyklicznych symboli wieloznacznych (**). Na przykład **.sln wyszukuje wszystkie pliki .sln we wszystkich podkatalogach.

Upewnij się, że określone rozwiązania są pobierane przez ten potok kompilacji. Na karcie Repozytorium:

Jeśli używasz serwera TFVC, upewnij się, że rozwiązanie jest elementem podrzędnym jednego z mapowań na karcie Repozytorium.
Jeśli używasz usługi Git, upewnij się, że projekt lub rozwiązanie znajduje się w repozytorium Git i w gałęzi, którą tworzysz.

Porada

Możesz również skompilować pliki projektu MSBuild (.*proj).
Jeśli tworzysz dostosowany plik projektu MSBuild, zalecamy użycie zadania MSBuild zamiast zadania kompilacji programu Visual Studio.

vsVersion - Wersja programu Visual Studio
string. Dozwolone wartości: latest, 17.0 (Visual Studio 2022), 16.0 (Visual Studio 2019), (Visual Studio 2017), 14.015.0 (Visual Studio 2015), 12.0 (Visual Studio 2013), 11.0 (Visual Studio 2012). Wartość domyślna: latest.

Wartość tych danych wejściowych musi być zgodna z wersją programu Visual Studio użytą do utworzenia rozwiązania.

/p:VisualStudioVersion={numeric_visual_studio_version} Dodaje argument do polecenia MSBuild uruchamiane przez kompilację. Jeśli na przykład określisz program Visual Studio 2015, /p:VisualStudioVersion=14.0 zostanie dodany do polecenia MSBuild.

Azure Pipelines: jeśli twój zespół chce używać programu Visual Studio z agentami hostowanymi przez firmę Microsoft, wybierz pozycję windows-latest jako domyślną pulę kompilacji. Zobacz Agenci hostowani przez firmę Microsoft.

vsVersion - Wersja programu Visual Studio
string. Dozwolone wartości: latest, 16.0 (Visual Studio 2019), 15.0 (Visual Studio 2017), (Visual Studio 2015), 14.012.0 (Visual Studio 2013), 11.0 (Visual Studio 2012). Wartość domyślna: latest.

Wartość tych danych wejściowych musi być zgodna z wersją programu Visual Studio użytą do utworzenia rozwiązania.

msbuildArgs - Argumenty programu MSBuild
string.

Przekazuje dodatkowe argumenty do programu MSBuild. Aby uzyskać informacje na temat składni, zobacz MsBuild Command-Line Reference (Dokumentacja programu MSBuild).

platform - Platformy
string.

Określa platformę, którą chcesz skompilować, na przykład Win32, , x86x64lub any cpu.

Porada

Jeśli używasz pliku projektu MSBuild (.*proj) zamiast rozwiązania, określ AnyCPU (bez białych znaków).
Zadeklaruj zmienną kompilacji, taką jak BuildPlatform na karcie Zmienne (wybierz pozycję Zezwalaj w czasie kolejki) i odwołaj się do niej tutaj jako $(BuildPlatform). Dzięki temu można modyfikować platformę podczas kolejkowania kompilacji i włączania tworzenia wielu konfiguracji.

configuration - Konfiguracji
string.

Określa konfigurację, którą chcesz skompilować, na przykład debug lub release.

Porada

Zadeklaruj zmienną kompilacji, taką jak BuildConfiguration na karcie Zmienne (wybierz pozycję Zezwalaj w czasie kolejki) i odwołaj się do niej tutaj jako $(BuildConfiguration). Dzięki temu można modyfikować platformę podczas kolejkowania kompilacji i włączania tworzenia wielu konfiguracji.

clean - Czyste
boolean. Wartość domyślna: false.

Jeśli ustawiono wartość false, zadanie tworzy kompilację przyrostową. To ustawienie może skrócić czas kompilacji, zwłaszcza jeśli baza kodu jest duża. Ta opcja nie ma praktycznego wpływu, chyba że ustawiono również repozytorium Clean na falsewartość .

Jeśli ustawiono wartość true, zadanie ponownie skompiluje cały kod w projektach kodu. Jest to odpowiednik argumentu MSBuild /target:clean .

maximumCpuCount - Kompilowanie równolegle
boolean. Wartość domyślna: false.

Opcjonalny. Jeśli konfiguracja docelowa programu MSBuild jest zgodna z równoległym kompilowaniem, możesz sprawdzić te dane wejściowe, aby przekazać /m przełącznik do programu MSBuild (tylko system Windows). Jeśli konfiguracja docelowa nie jest zgodna z równoległym kompilowaniem, sprawdzenie tej opcji może spowodować, że kompilacja spowoduje błędy użycia pliku lub sporadyczne lub niespójne błędy kompilacji.

restoreNugetPackages - Przywracanie pakietów NuGet
boolean. Wartość domyślna: false.

Te dane wejściowe są przestarzałe. Aby przywrócić pakiety NuGet, dodaj zadanie Instalatora narzędzi NuGet przed kompilacją.

msbuildArchitecture - Architektura programu MSBuild
string. Dozwolone wartości: x86 (MSBuild x86), x64 (MSBuild x64). Wartość domyślna: x86.

Opcjonalny. Dostarcza architekturę (x86 lub x64) programu MSBuild do uruchomienia.

Porada

Ponieważ program Visual Studio działa jako aplikacja 32-bitowa, może wystąpić problemy podczas przetwarzania kompilacji przez agenta kompilacji z uruchomioną 64-bitową wersją usługi Team Foundation Build Service. Wybierając pozycję MSBuild x86, możesz rozwiązać te problemy.

logProjectEvents - Rejestrowanie szczegółów projektu
boolean. Wartość domyślna: true.

Opcjonalny. Rejestruje szczegóły osi czasu dla każdego projektu.

createLogFile - Tworzenie pliku dziennika
boolean. Wartość domyślna: false.

Opcjonalny. Tworzy plik dziennika (tylko system Windows).

logFileVerbosity - Czasownik pliku dziennika
string. Opcjonalny. Użyj polecenia , gdy createLogFile = true. Dozwolone wartości: quiet, , normalminimal, detailed, diagnostic. Wartość domyślna: normal.

Określa poziom szczegółowości w plikach dziennika.

enableDefaultLogger - Włączanie domyślnego rejestratora
boolean. Wartość domyślna: true.

Jeśli jest ustawiona wartość true, włącza domyślny rejestrator programu MSBuild.

customVersion - Wersja niestandardowa
string.

Ustawia niestandardową wersję programu Visual Studio. Przykłady: 15.0, 16.0, 17.0. Wymagana wersja programu Visual Studio musi być zainstalowana w systemie.

Azure Pipelines: jeśli twój zespół chce używać programu Visual Studio 2022 z agentami hostowanymi przez firmę Microsoft, wybierz windows-2022 jako domyślną pulę kompilacji. Aby uzyskać więcej informacji, zobacz Agenci hostowani przez firmę Microsoft.

Opcje sterowania zadania

Wszystkie zadania mają opcje sterowania oprócz danych wejściowych zadań. Aby uzyskać więcej informacji, zobacz Opcje sterowania i typowe właściwości zadań.

Zmienne wyjściowe

Brak.

Uwagi

Dowiedz się więcej na temat instalowania obrazów programu Visual Studio na platformie Azure.

Ważne

To zadanie jest obsługiwane tylko w przypadku agentów z systemem Windows.

Wymagania

Wymaganie	Opis
Typy potoków	YAML, kompilacja klasyczna
Działa na	Agent, DeploymentGroup
Wymagania	Agenci hostowani samodzielnie muszą mieć możliwości zgodne z następującymi wymaganiami dotyczącymi uruchamiania zadań korzystających z tego zadania: msbuild, visualstudio
Możliwości	To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu.
Ograniczenia poleceń	Dowolne
Zmienne w formie tabeli settable	Dowolne
Wersja agenta	1.95.0 lub nowsza
Kategoria zadania	Kompilacja

Udostępnij za pośrednictwem

VSBuild@1 — zadanie kompilacji programu Visual Studio w wersji 1

Składnia

Dane wejściowe

Opcje sterowania zadania

Zmienne wyjściowe

Uwagi

Wymagania

Opinia

Dodatkowe zasoby