Skip to content

Latest commit

 

History

History
74 lines (39 loc) · 2.58 KB

how_to_build.md

File metadata and controls

74 lines (39 loc) · 2.58 KB
Raw

How to build

These instructions are only for building with Rake, which includes compilation, test execution and packaging. This is the simplest way to build. It also replicates the build on the Continuous Integration build server and is the best indicator of whether a pull request will build.

Don't be put off by the prerequisites! It only takes a few minutes to set them up and only needs to be done once. If you haven't used Rake before then you're in for a real treat!

You can also build the solution using Visual Studio 2015 or later, but this doesn't provide the same assurances as the Rake build.

At the time of writing the build is only confirmed to work on Windows using the Microsoft .NET framework.

Prerequisites

  1. Ensure you have .NET framework 4.x installed.

  2. Ensure you have Visual Studio 2015 or MSBuild 14 installed.

  3. Install Ruby 1.8.7 or later.

For Windows we recommend using Chocolatey. Once you have Chocolatey installed (it takes seconds), just run

cinst ruby

from a command prompt.

If you can't use Chocolatey, or prefer not to use it, the next best approach is to use the RubyInstaller and select 'Add Ruby executables to your PATH' when prompted. For other alternatives see the Ruby download page.

  1. Using a command prompt, update RubyGems to the latest version:

    gem update --system

  2. Install bundler:

    gem install bundler

  3. Install gems (after navigating to your clone root folder):

    bundler install

Building

Using a command prompt, navigate to your clone root folder and execute one of two commands:

  • build.netstd.cmd

    This executes the default build tasks to produce both the .NET Standard and the .NET 4.0 artifacts.

  • build.cmd

    This executes the default build tasks to produce only the .NET 4.0 artifacts, and should be used when the build machine does not have tooling to build .NET Standard projects.

After the build has completed, the build artifacts will be located in artifacts.

Extras

build.cmd is a shortcut for bundle exec rake (and build.netstd.cmd for bundle exec rake -f rakefile.netstd.rb), so you can use all the usual command line argument that you would use with Rake, e.g.:

  • View the full list of build tasks:

    build.cmd -T

  • Run a specific task:

    build.cmd spec

  • Run multiple tasks:

    build.cmd spec pack

  • View the full list of rake options:

    build.cmd -h