-
Notifications
You must be signed in to change notification settings - Fork 266
[Spec] MSBuild restore target
As part of the move from xproj to MSBuild package restore will move to an MSbuild target. Previous restore entry points such as nuget.exe restore and dotnet.exe restore will start using this target to restore .NET Core projects.
The restore target will gather all msbuild data and pass it into the restore task in NuGet.Build.Tasks, this task is a wrapper for the existing restore command from NuGet.Commands.
- Read all project to project references
- Read the project properties to find the intermediate folder and target frameworks
- Pass msbuild data to NuGet.Build.Tasks.dll
- Run restore
- Download packages
- Write assets file, targets, and props
Additional restore settings may come from MSBuild properties.
| Property | Multiple | Description |
|---|---|---|
| RestoreSources |
; delimited |
List of package sources |
| RestorePackagesPath | User packages directory path | |
| RestoreDisableParallel | Limit downloads to one at a time | |
| RestoreConfigFile | nuget.config file | |
| RestoreNoCache | Avoid using the web cache if set to true | |
| RestoreIgnoreFailedSource | Ignoring failing or missing package sources if set to true | |
| RestoreTaskAssemblyFile | Path to NuGet.Build.Tasks.dll | |
| RestoreGraphProjectInput |
; delimited |
list of projects to restore, this should contain absolute paths |
| RestoreOutputPath | Output directory, by default the obj folder is used |
Example
<PropertyGroup>
<RestoreIgnoreFailedSource>true</RestoreIgnoreFailedSource>
<PropertyGroup>
Restore will create the following files in the build obj folder
| File | Description |
|---|---|
| project.assets.json | Previously project.lock.json |
| project.generated.targets | References to msbuild targets contained in packages |
| project.generated.props | References to msbuild props contained in packages |
Data collected from MSBuild is put into a .dg file. This is kept in memory but can be written to a file and passed to nuget.exe restore as an input.
The file format is basic and consists of | delimited lines that are prefixed with a character to denote the entry type and then a :.
Example of a project with one reference
#:/src/myProj.csproj
+:RestoreOuputPath|/src/myProj/obj/
=:/src/myProj.csproj|/src/myChildProj.csproj
#:/src/myChildProj.csproj
+:RestoreOuputPath|/src/myChildProj/obj/
| Character | Description |
|---|---|
| # | Entry point, these projects will be restored. This also marks the beginning of a section for a project, all entries below this are considered part of that project until another section is encountered. |
| + | Property value. Format ``Name |
| = | Project to project reference. Format ``Parent |
The project to project entries represent edges in the project graph, restore adds these edges to the restore graph along with the package references to create a full graph of all dependencies for the project when building the lock file.
Properties such as RestoreOutputPath are used by restore to determine where the assets file, generated targets, and generated props.
- Could the same msbuild target be used from Visual Studio?
- msbuild /t:restore solution.sln needs a target in the metaproj
Check out the proposals in the accepted & proposed folders on the repository, and active PRs for proposals being discussed today.