Skip to content

Generating Nuget Packages

Chris Barth edited this page Feb 21, 2019 · 5 revisions

The Mixed Reality Toolkit Packaging Story

Contributors to the Mixed Reality Toolkit are in the process of setting up a more robust packaging story for distributing components. Tooling for creating NuGet packages is still under construction. The most recent instructions can be found below.

Note: Building the artifacts is NOT currently a required step in validating new contributions to the Mixed Reality Toolkit. Long term, after this new packaging story is completed, building the artifacts will become a required step in validating changes.

Building the Artifacts

Requirements

NuGet

NuGet is the package manager for .Net and you'll need to have it available in the PATH.

UnitySetup

The build process leverages UnitySetup, an OSS PowerShell Module from Microsoft.

Install from PowerShell:

Install-Module UnitySetup -Scope CurrentUser

Git

If you do not specify a version, then Git is used to find relevant tags. In this case it will need to be available in the PATH.

Run the Build

Simply execute the build script as such:

.\build.ps1 -Version '1.2.3'

For help and examples simply use the PowerShell help command:

help .\build.ps1 -Detailed

Note: If you don't specify -Version <version> the script will try to infer it from tags pointing to the current git commit. An error is produced if you don't have a tag and no version is provided.

Clone this wiki locally