The NuGet Restore action is used to populate a set of NuGet packages on the build server (usually prior to these packages being built into your project).
NuGet Restore
Name
A friendly name for this action (will be displayed in the actions workflow area).
Enabled
Determines if this action will be run within the relevant stage.
Packages.config or Solution File
The location of your .sln or packages.conf file within your source control.
Sources
An optional list of NuGet Feed package sources (the default source location is nuget.org). [-Source]
Specify configuration file
Shows a field for specifying the path to the configuration file. If not ticked, no -ConfigFile parameter is set and NuGet will automatically attempt to detect the configuration file. [-ConfigFile]
Configuration File
Location of the nuget.config file within your source control.
Using
The Using drop down is populated with any property collector whose namespace matches the pattern defined by the NuGet Restore action. The pattern for this action is ^NuGet.*
If you create a property collector for this action, make sure you select the Path Finder PlugIn type and give it a name that will match the pattern above in blue. Example names listed here, search the table's Plugin column for "NuGet Restore".
For more in-depth explanations on property collectors see Property Collectors.
Alternatively, you can select the Custom option from the Using drop down list and specify a path in the resulting input field that will be displayed. Please read Why it's a good idea to use a property collector before using this option.
Settings
Use Cache
If this is ticked, the local package Cache is checked first before going to NuGet or external sources. [-NoCache]
Require Consent
As of NuGet version 2.0 a privacy-related constraint option for restores from introduced. When ticked NuGet will check to see if package restore consent has been granted before installing package(s). If ticked NuGet will look for the presence of the following within your NuGet.config file (if not present a build error will occur). [-RequireConsent]
<packageRestore> <add key="enabled" value="true" /> </packageRestore>
For further information on the NuGet require consent feature please see the NuGet documentation
Packages Directory
The relative or absolute directory that NuGet will look to resolve packages. This can also be specified within the NuGet configuration file. [-PackagesDirectory]
Solution Directory
The relative or absolute directory to use when restoring packages for a solution. <solutionDirectory>\packages is used as the packages directory. This option is not valid when restoring packages for a solution file in this scenario $(SolutionDir)\packages is used as the packages directory. [-SolutionDirectory]
Enable Parallel Processing
By Default NuGet will download and install dependency chains in Parallel. To disable this feature tick off this option. [-DisableParallelProcessing]
Enable Package Restore
When ticking this check box adds the relevant system environment variable 'EnableNuGetPackageRestore = true'. This is the equivalent of clicking “Allow NuGet to download missing packages during build' ticked within Visual Studio.
Options
Log standard output
If this is ticked, the command line output is written to the build log.
Timeout (in seconds)
How long to wait for the action to finish running before timing out. Leaving this blank (or zero) will default to 86400 seconds (24 hours).
Treat failure as warning
Tick to continue build on failure marking the action with a warning status.
Ignore warnings
If this is ticked, any warnings logged will not mark the action with a warning status.
Environment
Environment Variables
Multiple environment variables can be defined - one per line. These are set before the command line is run.
Log environment variables
If this is ticked, environment variable values are written to the build log.
Generate system environment variables
Tick this checkbox to set up a list of new environment variables prefixed with 'ContinuaCI.' for all current system expression objects and variables.
Mask sensitive variable values in system environment variables
This checkbox is visible only if the 'Generate system environment variables' checkbox is ticked.
If this is ticked, the values of any variables marked as sensitive will be masked with **** when setting system environment variables. Clear this to expose the values.