Omissione di pacchetti NuGet nei sistemi di controllo del codice sorgente

Gli sviluppatori omettono in genere i pacchetti NuGet nei repository di controllo del codice sorgente e si affidano invece al ripristino dei pacchetti per reinstallare le dipendenze di un progetto prima di una compilazione.

Di seguito sono indicati i motivi validi per affidarsi al ripristino dei pacchetti:

1. I sistemi di controllo della versione distribuiti, come Git, includono copie complete di ogni versione di ogni file all'interno del repository. I file binari che vengono aggiornati di frequente causano aumenti notevoli delle dimensioni del repository e prolungano il tempo necessario per la sua clonazione.
2. Quando i pacchetti vengono inclusi nel repository, gli sviluppatori sono tenuti ad aggiungere i riferimenti direttamente al contenuto del pacchetto su disco anziché fare riferimento ai pacchetti tramite NuGet, e ciò può portare a nomi di percorso hardcoded nel progetto.
3. Diventa più difficile ripulire la soluzione da eventuali cartelle di pacchetti inutilizzate, perché è necessario accertarsi di non eliminare eventuali cartelle di pacchetti ancora in uso.
4. L'omissione dei pacchetti consente di mantenere limiti di proprietà ben definiti tra il proprio codice e i pacchetti di altri da cui si dipende. Molti pacchetti NuGet vengono già gestiti in repository di controllo del codice sorgente specifici.

Anche se il ripristino dei pacchetti è il comportamento predefinito con NuGet, è necessario eseguire alcune operazioni manuali per omettere pacchetti, ovvero la packages cartella nel progetto, dal controllo del codice sorgente, come descritto in questo articolo.

Omissione di pacchetti con Git

Usare il file con estensione gitignore per ignorare i pacchetti NuGet (.nupkg) la cartella packages e project.assets.json, tra le altre cose. Per riferimento, vedere l'esempio.gitignore per i progetti di Visual Studio:

Le parti importanti del file .gitignore sono:

# Ignore NuGet Packages
*.nupkg

# The packages folder can be ignored because of Package Restore
**/[Pp]ackages/*

# except build/, which is used as an MSBuild target.
!**/[Pp]ackages/build/

# Uncomment if necessary however generally it will be regenerated when needed
#!**/[Pp]ackages/repositories.config

# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets

# Ignore other intermediate files that NuGet might create. project.lock.json is used in conjunction
# with project.json (NuGet v3); project.assets.json is used in conjunction with the PackageReference
# format (NuGet v4 and .NET Core).
project.lock.json
project.assets.json

Omissione dei pacchetti con il controllo della versione di Team Foundation

Nota

Se possibile, seguire queste istruzioni prima di aggiungere il progetto al controllo del codice sorgente. In caso contrario, eliminare manualmente la cartella packages dal repository e archiviare la modifica prima di continuare.

Per disabilitare l'integrazione del controllo del codice sorgente con il controllo della versione di Team Foundation per una selezione di file:

1. Creare una cartella denominata .nuget nella cartella della soluzione (dove si trova il file .sln).

   • Suggerimento: in Windows, per creare la cartella in Esplora risorse usare il nome .nuget.con il punto finale.

2. In questa cartella creare un file denominato NuGet.Config e aprirlo per la modifica.

3. Aggiungere come minimo il testo seguente, in cui l'impostazione disableSourceControlIntegration indica a Visual Studio di ignorare tutti gli elementi nella cartella packages:

   <?xml version="1.0" encoding="utf-8"?>
   <configuration>
       <solution>
           <add key="disableSourceControlIntegration" value="true" />
       </solution>
   </configuration>
   

4. Se si usa TFS 2010 o versioni precedenti, mascherare la cartella packages nei mapping dell'area di lavoro.

5. In TFS 2012 o versione successiva oppure con Visual Studio Team Services, creare un file .tfignore come descritto in Add files to the server (Aggiungere file al server). In tale file, includere il contenuto seguente per ignorare in modo esplicito le modifiche per la cartella \packages a livello del repository e alcuni altri file intermedi. È possibile creare il file in Esplora risorse usando il nome .tfignore. con il punto finale, ma potrebbe essere necessario disabilitare prima di tutto l'opzione per nascondere le estensioni di file conosciute:

   # Ignore NuGet Packages
   *.nupkg
   
   # Ignore the NuGet packages folder in the root of the repository. If needed, prefix 'packages'
   # with additional folder names if it's not in the same folder as .tfignore.   
   packages
   
   # Omit temporary files
   project.lock.json
   project.assets.json
   *.nuget.props
   

6. Aggiungere NuGet.Config e .tfignore al controllo del codice sorgente e archiviare le modifiche.