{
"id": "5541a522-603c-47ad-91fc-a4b1d163081b",
"name": "DotNetCoreCLI",
"friendlyName": ".NET Core",
"description": "Build, test, package, or publish a dotnet application, or run a custom dotnet command",
"author": "Microsoft Corporation",
"helpUrl": "https://docs.microsoft.com/azure/devops/pipelines/tasks/build/dotnet-core-cli",
"helpMarkDown": "[Learn more about this task](https://go.microsoft.com/fwlink/?linkid=832194) or [see the .NET Core documentation](https://docs.microsoft.com/dotnet/core/)",
"category": "Build",
"visibility": [
"Build",
"Release"
],
"runsOn": [
"Agent"
],
"demands": [],
"version": {
"Major": 2,
"Minor": 275,
"Patch": 0
},
"minimumAgentVersion": "2.144.0",
"instanceNameFormat": "dotnet $(command)",
"groups": [
{
"name": "restoreAuth",
"displayName": "Feeds and authentication",
"isExpanded": true,
"visibleRule": "command = restore"
},
{
"name": "restoreAdvanced",
"displayName": "Advanced",
"isExpanded": false,
"visibleRule": "command = restore"
},
{
"name": "pushAuth",
"displayName": "Destination feed and authentication",
"isExpanded": true,
"visibleRule": "command = push"
},
{
"name": "pushAdvanced",
"displayName": "Advanced",
"isExpanded": false,
"visibleRule": "command = push"
},
{
"name": "packOptions",
"displayName": "Pack options",
"isExpanded": false,
"visibleRule": "command = pack"
},
{
"name": "packAdvanced",
"displayName": "Advanced",
"isExpanded": false,
"visibleRule": "command = pack"
},
{
"name": "generalAdvanced",
"displayName": "Advanced",
"isExpanded": false,
"visibleRule": "command != pack && command != push && command != restore"
}
],
"inputs": [
{
"name": "ConnectedServiceName",
"aliases": [
"azureSubscription"
],
"type": "connectedService:AzureRM",
"label": "Azure Resource Manager connection",
"defaultValue": "",
"helpMarkDown": "Select an Azure Resource Manager service connection"
},
{
"name": "command",
"type": "pickList",
"label": "Command",
"defaultValue": "build",
"required": true,
"helpMarkDown": "The dotnet command to run. Select 'Custom' to add arguments or use a command not listed here.",
"options": {
"build": "build",
"push": "nuget push",
"pack": "pack",
"publish": "publish",
"restore": "restore",
"run": "run",
"test": "test",
"custom": "custom"
},
"properties": {
"EditableOptions": "False"
}
},
{
"name": "publishWebProjects",
"type": "boolean",
"visibleRule": "command = publish",
"label": "Publish web projects",
"defaultValue": "true",
"required": true,
"helpMarkDown": "If true, the task will try to find the web projects in the repository and run the publish command on them. Web projects are identified by presence of either a web.config file or wwwroot folder in the directory."
},
{
"name": "projects",
"type": "multiLine",
"label": "Path to project(s) or solution(s)",
"defaultValue": "",
"visibleRule": "command = build || command = restore || command = run || command = test || command = custom || publishWebProjects = false",
"required": false,
"helpMarkDown": "The path to the csproj or sln file(s) to use. You can use wildcards (e.g. **/*.csproj for all .csproj files in all subfolders). **This field follows glob pattern, and is run against root of the repository at all times irrespective of Working Directory.**"
},
{
"name": "custom",
"type": "string",
"label": "Custom command",
"defaultValue": "",
"helpMarkDown": "The command to pass to dotnet.exe for execution.",
"required": true,
"visibleRule": "command = custom"
},
{
"name": "arguments",
"type": "string",
"label": "Arguments",
"defaultValue": "",
"visibleRule": "command = build || command = publish || command = run || command = test || command = custom",
"required": false,
"helpMarkDown": "Arguments to the selected command. For example, build configuration, output folder, runtime. The arguments depend on the command selected."
},
{
"name": "restoreArguments",
"type": "string",
"label": "Arguments",
"defaultValue": "",
"visibleRule": "command = restore",
"required": false,
"helpMarkDown": "Write the additional arguments to be passed to **restore** command."
},
{
"name": "publishTestResults",
"type": "boolean",
"label": "Publish test results and code coverage",
"defaultValue": "true",
"visibleRule": "command = test",
"required": false,
"helpMarkDown": "Enabling this option will generate a test results TRX file in `$(Agent.TempDirectory)` and results will be published to the server.
This option appends `--logger trx --results-directory $(Agent.TempDirectory)` to the command line arguments.
Code coverage can be collected by adding `--collect \"Code coverage\"` option to the command line arguments. This is currently only available on the Windows platform."
},
{
"name": "testRunTitle",
"type": "string",
"label": "Test run title",
"defaultValue": "",
"visibleRule": "command = test",
"required": false,
"helpMarkDown": "Provide a name for the test run."
},
{
"name": "zipAfterPublish",
"type": "boolean",
"visibleRule": "command = publish",
"label": "Zip published projects",
"defaultValue": "true",
"required": false,
"helpMarkDown": "If true, folder created by the publish command will be zipped."
},
{
"name": "modifyOutputPath",
"type": "boolean",
"visibleRule": "command = publish",
"label": "Add project's folder name to publish path",
"defaultValue": "true",
"required": false,
"helpMarkDown": "If true, folders created by the publish command will have project's folder name prefixed to their folder names when output path is specified explicitly in arguments. This is useful if you want to publish multiple projects to the same folder."
},
{
"name": "selectOrConfig",
"aliases": [
"feedsToUse"
],
"type": "radio",
"label": "Feeds to use",
"defaultValue": "select",
"helpMarkDown": "You can either select a feed from Azure Artifacts and/or NuGet.org here, or commit a nuget.config file to your source code repository and set its path here.",
"required": "true",
"options": {
"select": "Feed(s) I select here",
"config": "Feeds in my NuGet.config"
},
"groupName": "restoreAuth"
},
{
"name": "feedRestore",
"aliases": [
"vstsFeed"
],
"type": "pickList",
"label": "Use packages from this Azure Artifacts feed. Select from the dropdown or enter [project name/]feed name.",
"defaultValue": "",
"helpMarkDown": "Include the selected feed in the generated NuGet.config.\n\nFormat:\n* For organization-scoped feeds: `FeedName`\n* For project-scoped feeds: `ProjectName/FeedName`",
"required": "false",
"groupName": "restoreAuth",
"visibleRule": "selectOrConfig = select",
"properties": {
"EditableOptions": "True"
}
},
{
"name": "includeNuGetOrg",
"type": "boolean",
"label": "Use packages from NuGet.org",
"defaultValue": "true",
"helpMarkDown": "Include NuGet.org in the generated NuGet.config.",
"required": "false",
"groupName": "restoreAuth",
"visibleRule": "selectOrConfig = select"
},
{
"name": "nugetConfigPath",
"type": "filePath",
"label": "Path to NuGet.config",
"defaultValue": "",
"helpMarkDown": "The NuGet.config in your repository that specifies the feeds from which to restore packages.",
"required": "false",
"groupName": "restoreAuth",
"visibleRule": "selectOrConfig = config"
},
{
"name": "externalEndpoints",
"aliases": [
"externalFeedCredentials"
],
"type": "connectedService:ExternalNuGetFeed",
"label": "Credentials for feeds outside this organization/collection",
"required": false,
"helpMarkDown": "Credentials to use for external registries located in the selected NuGet.config. For feeds in this organization/collection, leave this blank; the build’s credentials are used automatically.",
"properties": {
"EditableOptions": "False",
"MultiSelectFlatList": "True"
},
"groupName": "restoreAuth",
"visibleRule": "selectOrConfig = config"
},
{
"name": "noCache",
"type": "boolean",
"label": "Disable local cache",
"defaultValue": "false",
"helpMarkDown": "Prevents NuGet from using packages from local machine caches.",
"required": "false",
"groupName": "restoreAdvanced"
},
{
"name": "packagesDirectory",
"aliases": [
"restoreDirectory"
],
"type": "string",
"label": "Destination directory",
"defaultValue": "",
"helpMarkDown": "Specifies the folder in which packages are installed. If no folder is specified, packages are restored into the default NuGet package cache.",
"required": "false",
"groupName": "restoreAdvanced"
},
{
"name": "verbosityRestore",
"type": "pickList",
"label": "Verbosity",
"defaultValue": "Normal",
"helpMarkDown": "Specifies the amount of detail displayed in the output.",
"required": "false",
"groupName": "restoreAdvanced",
"options": {
"-": "-",
"Quiet": "Quiet",
"Minimal": "Minimal",
"Normal": "Normal",
"Detailed": "Detailed",
"Diagnostic": "Diagnostic"
}
},
{
"name": "searchPatternPush",
"aliases": [
"packagesToPush"
],
"type": "filePath",
"label": "Path to NuGet package(s) to publish",
"defaultValue": "$(Build.ArtifactStagingDirectory)/*.nupkg",
"helpMarkDown": "The pattern to match or path to nupkg files to be uploaded. Multiple patterns can be separated by a semicolon.",
"required": true,
"visibleRule": "command = push"
},
{
"name": "nuGetFeedType",
"type": "radio",
"label": "Target feed location",
"required": true,
"defaultValue": "internal",
"options": {
"internal": "This organization/collection",
"external": "External NuGet server (including other organizations/collections)"
},
"visibleRule": "command = push"
},
{
"name": "feedPublish",
"aliases": [
"publishVstsFeed"
],
"type": "pickList",
"label": "Target feed",
"defaultValue": "",
"required": true,
"helpMarkDown": "Select a feed hosted in this organization. You must have Azure Artifacts installed and licensed to select a feed here.",
"visibleRule": "command = push && nuGetFeedType = internal",
"properties": {
"EditableOptions": "True"
}
},
{
"name": "publishPackageMetadata",
"groupName": "pushAdvanced",
"type": "boolean",
"label": "Publish pipeline metadata",
"defaultValue": true,
"helpMarkDown": "Associate this build/release pipeline’s metadata (run #, source code information) with the package",
"visibleRule": "command = push && nuGetFeedType = internal"
},
{
"name": "externalEndpoint",
"aliases": [
"publishFeedCredentials"
],
"type": "connectedService:ExternalNuGetFeed",
"label": "NuGet server",
"required": true,
"helpMarkDown": "The NuGet service connection that contains the external NuGet server’s credentials.",
"visibleRule": "command = push && nuGetFeedType = external"
},
{
"name": "searchPatternPack",
"aliases": [
"packagesToPack"
],
"type": "filePath",
"label": "Path to csproj or nuspec file(s) to pack",
"defaultValue": "**/*.csproj",
"helpMarkDown": "Pattern to search for csproj or nuspec files to pack.\n\nYou can separate multiple patterns with a semicolon, and you can make a pattern negative by prefixing it with '!'. Example: `**/*.csproj;!**/*.Tests.csproj`",
"required": true,
"visibleRule": "command = pack"
},
{
"name": "configurationToPack",
"aliases": [
"configuration"
],
"type": "string",
"label": "Configuration to Package",
"defaultValue": "$(BuildConfiguration)",
"helpMarkDown": "When using a csproj file this specifies the configuration to package",
"required": false,
"visibleRule": "command = pack"
},
{
"name": "outputDir",
"aliases": [
"packDirectory"
],
"type": "filePath",
"label": "Package Folder",
"defaultValue": "$(Build.ArtifactStagingDirectory)",
"helpMarkDown": "Folder where packages will be created. If empty, packages will be created alongside the csproj file.",
"required": false,
"visibleRule": "command = pack"
},
{
"name": "nobuild",
"type": "boolean",
"label": "Do not build",
"defaultValue": "false",
"helpMarkDown": "Don't build the project before packing. Corresponds to the --no-build command line parameter.",
"required": false,
"visibleRule": "command = pack"
},
{
"name": "includesymbols",
"type": "boolean",
"label": "Include Symbols",
"defaultValue": "false",
"helpMarkDown": "Additionally creates symbol NuGet packages. Corresponds to the --include-symbols command line parameter.",
"required": false,
"visibleRule": "command = pack"
},
{
"name": "includesource",
"type": "boolean",
"label": "Include Source",
"defaultValue": "false",
"helpMarkDown": "Includes source code in the package. Corresponds to the --include-source command line parameter.",
"required": false,
"visibleRule": "command = pack"
},
{
"name": "versioningScheme",
"type": "pickList",
"label": "Automatic package versioning",
"defaultValue": "off",
"helpMarkDown": "Cannot be used with include referenced projects. If you choose 'Use the date and time', this will generate a [SemVer](http://semver.org/spec/v1.0.0.html)-compliant version formatted as `X.Y.Z-ci-datetime` where you choose X, Y, and Z.\n\nIf you choose 'Use an environment variable', you must select an environment variable and ensure it contains the version number you want to use.\n\nIf you choose 'Use the build number', this will use the build number to version your package. **Note:** Under Options set the build number format to be '[$(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r)](https://go.microsoft.com/fwlink/?LinkID=627416)'.",
"required": true,
"groupName": "packOptions",
"options": {
"off": "Off",
"byPrereleaseNumber": "Use the date and time",
"byEnvVar": "Use an environment variable",
"byBuildNumber": "Use the build number",
"bySemVerBuildNumber": "Use full SemVer build number"
}
},
{
"name": "versionEnvVar",
"type": "string",
"label": "Environment variable",
"defaultValue": "",
"helpMarkDown": "Enter the variable name without $, $env, or %.",
"required": true,
"groupName": "packOptions",
"visibleRule": "versioningScheme = byEnvVar"
},
{
"name": "requestedMajorVersion",
"aliases": [
"majorVersion"
],
"type": "string",
"label": "Major",
"defaultValue": "1",
"helpMarkDown": "The 'X' in version [X.Y.Z](http://semver.org/spec/v1.0.0.html)",
"required": true,
"groupName": "packOptions",
"visibleRule": "versioningScheme = byPrereleaseNumber"
},
{
"name": "requestedMinorVersion",
"aliases": [
"minorVersion"
],
"type": "string",
"label": "Minor",
"defaultValue": "0",
"helpMarkDown": "The 'Y' in version [X.Y.Z](http://semver.org/spec/v1.0.0.html)",
"required": true,
"groupName": "packOptions",
"visibleRule": "versioningScheme = byPrereleaseNumber"
},
{
"name": "requestedPatchVersion",
"aliases": [
"patchVersion"
],
"type": "string",
"label": "Patch",
"defaultValue": "0",
"helpMarkDown": "The 'Z' in version [X.Y.Z](http://semver.org/spec/v1.0.0.html)",
"required": true,
"groupName": "packOptions",
"visibleRule": "versioningScheme = byPrereleaseNumber"
},
{
"name": "buildProperties",
"type": "string",
"label": "Additional build properties",
"defaultValue": "",
"required": false,
"helpMarkDown": "Specifies a list of token = value pairs, separated by semicolons, where each occurrence of $token$ in the .nuspec file will be replaced with the given value. Values can be strings in quotation marks.",
"groupName": "packAdvanced"
},
{
"name": "verbosityPack",
"type": "pickList",
"label": "Verbosity",
"defaultValue": "Normal",
"helpMarkDown": "Specifies the amount of detail displayed in the output.",
"required": "false",
"groupName": "packAdvanced",
"options": {
"-": "-",
"Quiet": "Quiet",
"Minimal": "Minimal",
"Normal": "Normal",
"Detailed": "Detailed",
"Diagnostic": "Diagnostic"
}
},
{
"name": "workingDirectory",
"type": "filePath",
"label": "Working directory",
"helpMarkDown": "Current working directory where the script is run. Empty is the root of the repo (build) or artifacts (release), which is $(System.DefaultWorkingDirectory). The project search pattern is **NOT** relative to working directory.",
"required": "false",
"groupName": "generalAdvanced",
"visibleRule": "command != restore && command != push && command != pack"
},
{
"name": "requestTimeout",
"type": "int",
"label": "Set timeout for package download request",
"defaultValue": 300000,
"required": false,
"helpMarkDown": "Provide a timeout value for HTTP requests that the task makes to obtain the .NET package. The value is in milliseconds. Default is 300000 milliseconds (5 minutes). Cannot be more than 600000 milliseconds (10 minutes)."
}
],
"dataSourceBindings": [
{
"target": "feedRestore",
"endpointId": "tfs:feed",
"endpointUrl": "{{endpoint.url}}/_apis/packaging/feeds?includeUrls=False",
"resultSelector": "jsonpath:$.value[*]",
"resultTemplate": "{ \"Value\" : \"{{#if project}}{{{project.id}}}\\/{{/if}}{{{id}}}\", \"DisplayValue\" : \"{{{name}}}\" }"
},
{
"target": "feedPublish",
"endpointId": "tfs:feed",
"endpointUrl": "{{endpoint.url}}/_apis/packaging/feeds?includeUrls=False",
"resultSelector": "jsonpath:$.value[*]",
"resultTemplate": "{ \"Value\" : \"{{#if project}}{{{project.id}}}\\/{{/if}}{{{id}}}\", \"DisplayValue\" : \"{{{name}}}\" }"
}
],
"execution": {
"Node10": {
"target": "dotnetcore.js",
"argumentFormat": ""
},
"Node16": {
"target": "dotnetcore.js",
"argumentFormat": ""
},
"Node20_1": {
"target": "dotnetcore.js",
"argumentFormat": ""
},
"Node24": {
"target": "dotnetcore.js",
"argumentFormat": ""
}
},
"messages": {
"BuildIdentityPermissionsHint": "For internal feeds, make sure the build service identity '%s' [%s] has access to the feed.",
"CouldNotSetCodePaging": "Could not set the code paging of due to following error: %s",
"Error_AutomaticallyVersionReleases": "Autoversion: Getting version number from build option is not supported in releases",
"Error_CommandNotRecognized": "The command %s was not recognized.",
"Error_NoSourceSpecifiedForPush": "No source was specified for push",
"Error_NoValueFoundForEnvVar": "No value was found for the provided environment variable.",
"Error_NoVersionFoundInBuildNumber": "Could not find version number data in the following environment variable: BUILD_BUILDNUMBER. The value of the variable should contain a substring with the following formats: X.Y.Z or X.Y.Z.A where A, X, Y, and Z are positive integers.",
"Error_PackageFailure": "An error occurred while trying to pack the files.",
"Error_PushNotARegularFile": "%s is not a file. Check the 'Path/Pattern to nupkg' property of the task.",
"Info_AttemptingToPackFile": "Attempting to pack file: ",
"Info_NoPackagesMatchedTheSearchPattern": "No packages matched the search pattern.",
"Info_NoFilesMatchedTheSearchPattern": "No files matched the search pattern.",
"PackagesFailedToInstall": "Packages failed to restore",
"PackagesFailedToPublish": "Packages failed to publish",
"PackagesInstalledSuccessfully": "Packages were restored successfully",
"PackagesPublishedSuccessfully": "Packages were published successfully",
"UnknownFeedType": "Unknown feed type '%s'",
"Warning_AutomaticallyVersionReferencedProjects": "The automatic package versioning and include referenced projects options do not work together. Referenced projects will not inherit the custom version provided by the automatic versioning settings.",
"Warning_MoreThanOneVersionInBuildNumber": "Found more than one instance of version data in BUILD_BUILDNUMBER.Assuming first instance is version.",
"dotnetCommandFailed": "Dotnet command failed with non-zero exit code on the following projects : %s",
"noProjectFilesFound": "Project file(s) matching the specified pattern were not found.",
"noPublishFolderFoundToZip": "A publish folder could not be found to zip for project file: %s.",
"noWebProjectFound": "No web project was found in the repository. Web projects are identified by presence of either a web.config file, wwwroot folder in the directory, or by the usage of Microsoft.Net.Web.Sdk in your project file. You can set Publish web projects property to false (publishWebProjects: false in yml) if your project doesn't follow this convention or if you want to publish projects other than web projects.",
"zipFailed": "Zip failed with error: %s",
"Error_ApiKeyNotSupported": "DotNetCore currently does not support using an encrypted Api Key.",
"Error_ExpectedConfigurationElement": "Invalid xml. Expected element named 'configuration'.",
"Error_NoMatchingFilesFoundForPattern": "No matching files were found with search pattern: %s",
"Error_NoUrlWasFoundWhichMatches": "No download URL was found for %s",
"Error_NoVersionWasFoundWhichMatches": "No version was found which matches the input %s",
"Error_NuGetToolInstallerFailer": "Tool install failed: %s",
"Info_AvailableVersions": "The available versions are: %s",
"Info_ExpectBehaviorChangeWhenUsingVersionQuery": "You are using a query match on the version string. Behavior changes or breaking changes might occur as NuGet updates to a new version.",
"Info_MatchingUrlWasFoundSettingAuth": "Using authentication information for the following URI: ",
"Info_ResolvedToolFromCache": "Resolved from tool cache: %s",
"Info_SavingTempConfig": "Saving NuGet.config to a temporary config file.",
"Info_UsingToolPath": "Using tool path: %s",
"Info_UsingVersion": "Using version: %s",
"NGCommon_AddingSources": "Setting credentials in NuGet.config",
"NGCommon_AreaNotFoundInSps": "Unable to locate the '%s' [%s] area. The service containing that area may not be available in your region.",
"NGCommon_DetectedNuGetExtensionsPath": "Detected NuGet extensions loader path (NUGET_EXTENSIONS_PATH environment variable): %s",
"NGCommon_DetectedNuGetVersion": "Detected NuGet version %s / %s",
"NGCommon_IgnoringNuGetExtensionsPath": "Detected NuGet extensions loader path (NUGET_EXTENSIONS_PATH environment variable). Extensions are ignored when using the built-in NuGet client",
"NGCommon_NoSourcesFoundInConfig": "No package sources were found in the NuGet.config file at %s",
"NGCommon_NuGetConfigIsInvalid": "The NuGet.config at %s is invalid.",
"NGCommon_NuGetConfigIsPackagesConfig": "Expected a NuGet.config file at %s, but its contents appear to be a packages.config. Check the settings for the %s task and confirm you selected NuGet.config rather than packages.config.",
"NGCommon_RemovingSources": "Preparing to set credentials in NuGet.config",
"NGCommon_SpsNotFound": "Unable to find the '%s' [%s] area. There may be a problem with your Team Foundation Server installation.",
"NGCommon_UnabletoDetectNuGetVersion": "Unknown NuGet version selected.",
"NGCommon_UnableToFindTool": "Unable to find tool %s",
"Warning_SessionCreationFailed": "Could not create provenance session: %s",
"Warning_UpdatingNuGetVersion": "Updating version of NuGet.exe to %s from %s. Behavior changes or breaking changes might occur as NuGet updates to a new version. If this is not desired, deselect the 'Check for Latest Version' option in the task.",
"Net5Update": "Info: Azure Pipelines hosted agents have been updated and now contain .Net 5.x SDK/Runtime along with the older .Net Core version which are currently lts. Unless you have locked down a SDK version for your project(s), 5.x SDK might be picked up which might have breaking behavior as compared to previous versions. You can learn more about the breaking changes here: https://docs.microsoft.com/en-us/dotnet/core/tools/ and https://docs.microsoft.com/en-us/dotnet/core/compatibility/ . To learn about more such changes and troubleshoot, refer here: https://docs.microsoft.com/en-us/azure/devops/pipelines/tasks/build/dotnet-core-cli?view=azure-devops#troubleshooting",
"Net5NugetVersionCompat": ".NET 5 has some compatibility issues with older Nuget versions(<=5.7), so if you are using an older Nuget version(and not dotnet cli) to restore, then the dotnet cli commands (e.g. dotnet build) which rely on such restored packages might fail. To mitigate such error, you can either: (1) - Use dotnet cli to restore, (2) - Use Nuget version 5.8 to restore, (3) - Use global.json using an older sdk version(<=3) to build",
"DeprecatedDotnet2_2_And_3_0": "Info: .NET Core SDK/runtime 2.2 and 3.0 are now End of Life(EOL) and have been removed from all hosted agents. If you're using these SDK/runtimes on hosted agents, kindly upgrade to newer versions which are not EOL, or else use UseDotNet task to install the required version.",
"Warning_IncludeNuGetOrgEnabled": "IncludeNugetOrg is currently enabled for this task. To resolve this warning, edit your build task and set 'includeNuGetOrg' to 'false' or deselect 'Use packages from NuGet.org'.",
"Error_IncludeNuGetOrgEnabled": "Packages failed to restore. Edit your build task and set 'includeNuGetOrg' to 'false' or deselect 'Use packages from NuGet.org'.",
"Warning_UnsupportedServiceConnectionAuth": "The service connection does not use a supported authentication method. Please use a service connection with personal access token based auth.",
"Error_InvalidSemVer": "Build number is not a valid SemVer 2.0 string."
}
}