Die automatische Wiederherstellung von NuGet-Paketen funktioniert nicht mit MSBuild

Ich versuche mit MSBuild 12.0 eine Lösung mit packagesfehlendem Inhalt (außer im repositories.configInneren) zu erstellen. Ich erwarte, dass alle fehlenden Pakete vor dem Erstellen automatisch wiederhergestellt werden, aber dies ist nicht der Fall - MsBuild meldet Unmengen von Fehlern:

"Fehlt Ihnen eine using-Direktive oder eine Assembly-Referenz?"

NuGet Manager ist 2.7 (ich sehe dies in Visual Studio 2013 über Box). Ich habe sogar versucht, EnableNuGetPackageRestore=trueParameter zu übergeben - kein Glück. Was vermisse ich?

AKTUALISIERT mit der neuesten offiziellen NuGet-Dokumentation ab Version 3.3.0

Ansätze zur Paketwiederherstellung

NuGet bietet drei Ansätze zur Verwendung der Paketwiederherstellung .

Die automatische Paketwiederherstellung ist der vom NuGet-Team empfohlene Ansatz zur Paketwiederherstellung in Visual Studio und wurde in NuGet 2.7 eingeführt. Ab NuGet 2.7 wird die NuGet Visual Studio-Erweiterung in die Build-Ereignisse von Visual Studio integriert und stellt fehlende Pakete wieder her, wenn ein Build beginnt. Diese Funktion ist standardmäßig aktiviert, Entwickler können sie jedoch bei Bedarf deaktivieren.

So funktioniert das:

1. Beim Erstellen eines Projekts oder einer Lösung löst Visual Studio das Ereignis aus, dass ein Build innerhalb der Lösung beginnt.
2. NuGet reagiert auf dieses Ereignis und sucht nach Paketen.config-Dateien, die in der Lösung enthalten sind.
3. Für jede gefundene Datei packages.config werden die Pakete aufgelistet und im Paketordner der Lösung auf Vorhanden geprüft überprüft.
4. Fehlende Pakete werden aus den konfigurierten (und aktivierten) Paketquellen des Benutzers heruntergeladen, wobei die Reihenfolge der Paketquellen berücksichtigt wird.
5. Wenn Pakete heruntergeladen werden, werden sie in den Paketordner der Lösung entpackt.

Wenn Sie Nuget 2.7+ installiert haben; Es ist wichtig, eine Methode zum> Verwalten der automatischen Paketwiederherstellung in Visual Studio auszuwählen.

Es stehen zwei Methoden zur Verfügung:

1. (Nuget 2.7+): Visual Studio -> Extras -> Paketmanager -> Paketmanagereinstellungen -> Automatische Paketwiederherstellung aktivieren
2. (Nuget 2.6 und niedriger) Klicken Sie mit der rechten Maustaste auf eine Lösung und klicken Sie auf "Paketwiederherstellung für diese Lösung aktivieren".

Die Wiederherstellung eines Befehlszeilenpakets ist erforderlich, wenn eine Lösung über die Befehlszeile erstellt wird. Es wurde in früheren Versionen von NuGet eingeführt, aber in NuGet 2.7 verbessert.

nuget.exe restore contoso.sln

Der in MSBuild integrierte Paketwiederherstellungsansatz ist die ursprüngliche Implementierung der Paketwiederherstellung. Obwohl er in vielen Szenarien weiterhin funktioniert, deckt er nicht alle Szenarien ab, die von den beiden anderen Ansätzen behandelt werden.

Wenn Sie Visual Studio 2017 oder höher verwenden, das mit MSBuild 15 oder höher geliefert wirdPackageReference , und Ihre .csproj-Dateien im neuen Format vorliegen , ist die einfachste Methode die Verwendung des neuen MSBuild- RestoreZiels .

Niemand hat tatsächlich die ursprüngliche Frage beantwortet: "Wie kann ich NuGet-Pakete beim Erstellen über die Befehlszeile mit MSBuild automatisch wiederherstellen?" Die Antwort lautet: Wenn Sie nicht die Option "NuGet-Paketwiederherstellung aktivieren" verwenden (die jetzt gemäß dieser Referenz veraltet ist ), können Sie dies nicht (siehe unten). Wenn Sie versuchen, z. B. automatisierte Builds auf einem CI-Server durchzuführen, ist dies zum Kotzen.

Es gibt jedoch einen kleinen Umweg, um das gewünschte Verhalten zu erreichen:

1. Laden Sie die neueste ausführbare NuGet-Datei von https://dist.nuget.org/win-x86-commandline/latest/nuget.exe herunter und platzieren Sie sie irgendwo in Ihrem PATH. (Sie können dies als vorgefertigten Schritt ausführen.)
2. Führen Sie aus, nuget restorewodurch alle fehlenden Pakete automatisch heruntergeladen werden.
3. Führen Sie aus msbuild, um Ihre Lösung zu erstellen.

Nebenbei: Während die neue und empfohlene Methode zur automatischen Paketwiederherstellung weniger Unordnung in Ihrer Versionskontrolle mit sich bringt, macht sie auch die Wiederherstellung von Befehlszeilenpaketen unmöglich, es sei denn, Sie springen durch den zusätzlichen Rahmen des Herunterladens und Ausführens nuget.exe. Fortschritt?

Die automatische Paketwiederherstellung von Nuget ist eine Funktion von Visual Studio (ab 2013), nicht von MSBuild. Sie müssen ausgeführt werden, nuget.exe restorewenn Sie Pakete über die Befehlszeile wiederherstellen möchten.

Sie können auch die Funktion "Nuget-Paketwiederherstellung aktivieren" verwenden. Dies wird jedoch von den Nuget-Mitarbeitern nicht mehr empfohlen, da dadurch aufdringliche Änderungen an den Projektdateien vorgenommen werden und Probleme auftreten können, wenn Sie diese Projekte in einer anderen Lösung erstellen.

Ich habe einige Zeit gebraucht, um das ganze Bild herauszufinden, und ich möchte es hier teilen.

Visual Studio bietet zwei Ansätze zur Verwendung der Paketwiederherstellung: Automatische Paketwiederherstellung und MSBuild-integrierte Paketwiederherstellung. Die 'MSBuild-integrierte Paketwiederherstellung' stellt Pakete WÄHREND des Erstellungsprozesses wieder her, die in einigen Szenarien Probleme verursachen können. Die "automatische Paketwiederherstellung" wird vom NuGet-Team empfohlen .

Es gibt mehrere Schritte, damit die automatische Paketwiederherstellung funktioniert:

1. Aktualisieren Sie in Visual Studio unter Extras -> Erweiterungen und Updates NuGet, wenn es eine neuere Version gibt (Version 2.7 oder höher).

2. Wenn Sie TFS verwenden, entfernen Sie im Ordner .nuget Ihrer Lösung die Dateien NuGet.exe und NuGet.targes. Bearbeiten Sie dann NuGet.Config, um NuGet-Pakete nicht einzuchecken:

   <configuration>  
     <solution>  
       <add key="disableSourceControlIntegration" value="true" />  
     </solution>  
   </configuration> 

   Wenn Sie zuvor den Paketordner der Lösung in TFS eingecheckt haben, löschen Sie den Ordner und aktivieren Sie das Löschen des Paketordners.

   Wenn Sie TFS nicht verwenden, löschen Sie den Ordner .nuget.

3. Entfernen Sie in jeder Projektdatei (.csproj oder .vbproj) in Ihrer Lösung die Zeile, die auf die Datei NuGet.targets verweist. Die Referenz sieht folgendermaßen aus:

   <Import Project="$(SolutionDir)\.nuget\NuGet.targets" Condition="Exists('$(SolutionDir)\.nuget\NuGet.targets')" />

   Entfernen Sie diese Zeile in jeder Projektdatei in Ihrer Lösung.

4. Im Visual Studio-Menü entweder durch

   Extras -> Optionen -> Paketmanager -> Allgemein oder Extras -> NuGet-Paketmanager -> Paketmanagereinstellungen

   Bitte aktivieren Sie die folgenden beiden Optionen: 1) 'NuGet darf fehlende Pakete herunterladen' 2) 'Beim Erstellen in Visual Studio automatisch nach fehlenden Paketen suchen'

5. Testen Sie die Konfiguration Ihrer Paketwiederherstellung anhand der folgenden Schritte

   • Speichern Sie Ihre Lösung und schließen Sie Visual Studio
   • Löschen Sie den Paketordner Ihrer Lösung
   • Starten Sie Visual Studio, öffnen Sie Ihre Lösung und erstellen Sie sie neu.

MSBuild 15 verfügt über eine / t: Wiederherstellungsoption , die dies ausführt . es kommt mit Visual Studio 2017.

Wenn Sie dies verwenden möchten, müssen Sie auch die neue PackageReference verwenden. Dies bedeutet, dass Sie die packages.configDatei durch Elemente wie dieses ersetzen müssen (tun Sie dies in * .csproj):

<ItemGroup>
  <!-- ... -->
  <PackageReference Include="Contoso.Utility.UsefulStuff" Version="3.6.0" />
  <!-- ... -->
</ItemGroup>

Wenn Sie mit der rechten Maustaste auf "Referenzen" klicken, erfolgt eine automatische Migration in dieses Format (diese wird möglicherweise nicht angezeigt, wenn Sie gerade Visual Studio geöffnet, das Fenster "NuGet-Pakete für Lösung verwalten" neu erstellt oder geöffnet haben und es wird angezeigt).

Ian Kemp hat die Antwort (habe übrigens einige Punkte), dies ist, einfach etwas Fleisch zu einem seiner Schritte hinzuzufügen.

Der Grund, warum ich hier gelandet bin, war, dass die Maschinen der Entwickler gut gebaut wurden, aber der Build-Server einfach nicht die erforderlichen Pakete herunterzog (leerer Paketordner) und daher der Build fehlschlug. Die Anmeldung am Build-Server und das manuelle Erstellen der Lösung funktionierten jedoch.

Um den zweiten von Ians 3-Punkt-Schritten (Ausführen der Nuget-Wiederherstellung ) auszuführen, können Sie ein MSBuild-Ziel erstellen, auf dem der Befehl exec ausgeführt wird, um den Befehl Nuget-Wiederherstellung wie folgt auszuführen (in diesem Fall befindet sich nuget.exe im Ordner .nuget und nicht auf dem Pfad), der dann in einem TeamCity-Erstellungsschritt (anderes verfügbares CI ...) unmittelbar vor dem Erstellen der Lösung ausgeführt werden kann

<Target Name="BeforeBuild">
  <Exec Command="..\.nuget\nuget restore ..\MySolution.sln"/>
</Target>

Für die Aufzeichnung hatte ich bereits den Runner-Typ "Nuget Installer" ausprobiert, aber dieser Schritt hing an Webprojekten (funktionierte für DLL- und Windows-Projekte).

Beachten Sie, dass Sie, wenn Sie TeamCity als Build-Server verwenden, einen "NuGet Installer" -Schritt erhalten , mit dem Sie alle Pakete vor dem Build-Schritt wiederherstellen können.

Es gibt eine packages.configDas Projekt enthält Datei , die die Paketdetails enthält.

Außerdem gibt es einen .nuget-Ordner, der die NuGet.exe- und NuGet.targets enthält . Wenn eine der Dateien fehlt, wird das fehlende Paket nicht wiederhergestellt und die Ursache "Fehlt Ihnen eine using-Direktive oder eine Assembly-Referenz?" Error

Manchmal tritt dies auf, wenn sich der Ordner des Pakets, das Sie wiederherstellen möchten , im Ordner "packages" befindet (dh "Packages / EntityFramework.6.0.0 /" ) , die "DLLs" jedoch nicht darin enthalten sind (der größte Teil der Versionskontrolle) Systeme ignorieren automatisch ".dll" -Dateien). Dies liegt daran, dass NuGet vor dem Versuch, jedes Paket wiederherzustellen, prüft, ob die Ordner bereits vorhanden sind. Wenn es also vorhanden ist, geht NuGet davon aus, dass sich die "DLL" darin befindet. Wenn dies das Problem für Sie ist, löschen Sie einfach den Ordner, den NuGet korrekt wiederherstellt.

Ich hatte ein Problem mit Nuget-Paketen, die nicht in einem nächtlichen Build mit Skript enthalten waren, der die sln-Datei mit devenv.exe erstellt.

Ich folgte den Ratschlägen von Microsoft und der wichtigste Schritt bestand darin, die NuGet-Konfiguration %AppData%/NuGetso zu aktualisieren , dass sie Folgendes enthielt:

<configuration>
    <packageRestore>
        <add key="automatic" value="True" />
    </packageRestore>
</configuration>

In Visual Studio 2017 - Wenn Sie mit IDE kompilieren - werden alle fehlenden Nuget-Pakete heruntergeladen und im Ordner "packages" gespeichert.

Auf der Build-Maschine wurde die Kompilierung jedoch mit msbuild.exe durchgeführt. In diesem Fall habe ich nuget.exe heruntergeladen und den Pfad beibehalten.

Während jedes Erstellungsprozesses vor der Ausführung von msbuild.exe. Es wird ausgeführt -> nuget.exe wiederherstellen NAME_OF_SLN_File (wenn es nur eine .SLN-Datei gibt, können Sie diesen Parameter ignorieren)

Sie können auch verwenden

Update-Package -reinstall

So stellen Sie die NuGet-Pakete in der Paketverwaltungskonsole in Visual Studio wieder her.