DotNet Tool Restore Action

The DotNet Tool Restore action in Continua CI is a wrapper around the .NET command line tools. If you're having trouble using the DotNet Tool Restore action, please refer to the .NET CLI documentation.

The DotNet Tool Restore action is used to restore .NET tools according to a manifest file.

DotNet Tool Restore

DotNet Tool Restore action main tab

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.

Working Folder

Optional working folder for running the executable. Defaults to the workspace folder.

Using

The Using drop down is populated with any property collector whose namespace matches the pattern defined by the DotNet CLI actions. The pattern for this action is ^NetCore\.App(?:\.|$) and is restricted to .NET 3.0 or later.

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. Example names listed here, search the table's Plugin column for "DotNet Tool 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.

DotNet Bitness

The bitness of the DotNet executable. Options are Default, 32 Bit (X86), or 64 Bit (X64).

SDK Version

The SDK version to set in global.json file before running the DotNet executable.

Custom SDK Version

A custom SDK version string. This field is only visible when the SDK Version is set to 'Custom'.

Settings

DotNet Tool Restore action settings tab

Configuration File

The NuGet configuration file (nuget.config) to use for the restore operation. [--configfile]

Additional Package Sources

One or more additional NuGet package sources to use during the restore operation. [--add-source]

Tool Manifest

Path to the tool manifest file that specifies which .NET local tools and their versions to restore. The manifest file is typically named dotnet-tools.json and located in a .config subfolder. If left blank, the dotnet executable searches for the manifest in the working folder and .config subfolder. [--tool-manifest]

Flags

DotNet Tool Restore action flags tab

Enable restoring multiple projects in parallel

If this is ticked, multiple restore operations are run concurrently. Untick to disable parallel restoring. [--disable-parallel]

Ignore failed sources

When this is ticked, package source failures are treated as warnings rather than errors. The restore will still succeed if the required packages can be found from other configured sources. This is useful when a secondary package source may be temporarily unavailable. [--ignore-failed-sources]

Cache packages and http requests

If this is ticked, packages and http requests are cached. Untick to disable caching. [--no-cache]

Options

DotNet Tool Restore action options tab

Log standard output

If this is ticked, the command line output is written to the build log.

Verbosity

The amount of information detail to display in the build log. Only visible when Log standard output is enabled. [--verbosity]

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

DotNet Tool Restore action environment tab

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.