dotnet-subset 0.1.0

dotnet-subset

dotnet-subset is a .NET tool that copies a subset of files from a repository to a directory.

The tool is mainly used in Dockerfiles to optimize the docker build caching for "dotnet restore" instructions.

Motivation

To learn more about the motivation behind dotnet-subset, please read the related blog post.

Installation

From NuGet

dotnet tool install --global dotnet-subset

From source

Prerequisite: .NET SDK 6

1. Clone this repository
2. Open a terminal in the repository's root
3. dotnet pack --configuration Release
4. dotnet tool install dotnet-subset --global --add-source ./artifacts/Release/nupkg/dotnet-subset/

Usage

Description:
  Create a subset for the restore operation

Usage:
  dotnet-subset restore <project> [options]

Arguments:
  <project>  Project or solution to restore

Options:
  --root-directory <root-directory> (REQUIRED)  Directory from where the files will be copied
  --output <output> (REQUIRED)                  Directory where the subset files will be copied, preserving the
                                                original structure.

Example:

dotnet subset restore /source/complexapp/complexapp.csproj --root-directory /source/ --output /tmp/restore_subset/

dotnet-subset + docker

Please check this pull request on how to use dotnet-subset in your Dockerfile: https://github.com/othmane-kinane-nw/dotnet-docker/pull/1/files?diff=split&w=0

Roadmap

• Add tests
• Automate the versionning
• Automate the deployment to NuGet
• Refactor the codebase
• Add "build" algorithm

License

Copyright © Nimbleways, Othmane Kinane and contributors.

dotnet-subset is provided as-is under the MIT license. For more information see LICENSE.

• For Microsoft.Build, see https://github.com/dotnet/msbuild/blob/main/LICENSE
• For Microsoft.Build.Locator, see https://github.com/microsoft/MSBuildLocator/blob/master/LICENSE
• For System.CommandLine, see https://github.com/dotnet/command-line-api/blob/main/LICENSE.md