Common/README.md

2.7 KiB

Steeltoe Common Packages

NOTICE: This repository has been relocated as a sub-directory under the Steeltoe repository. All issues and future development will be done under that repository.

This repository contains several packages that are common to other Steeltoe components.

Windows Master (Stable): AppVeyor Master

Windows Dev (Less Stable): AppVeyor Dev

Linux/OS X Master (Stable): Travis Master

Linux/OS X Dev (Less Stable): Travis Dev

Nuget Feeds

All new development is done on the dev branch. More stable versions of the packages can be found on the master branch. The latest prebuilt packages from each branch can be found on one of two MyGet feeds. Released version can be found on nuget.org.

Building Pre-requisites

To build and run the unit tests:

  1. .NET Core SDK 2.0.3 or greater
  2. .NET Core Runtime 2.0.3

Building Packages & Running Tests - Windows

To build the packages on windows:

  1. git clone ...
  2. cd <clone directory>
  3. cd src\ <project> (e.g. cd src\Steeltoe.Common)
  4. dotnet restore
  5. dotnet pack --configuration <Release or Debug>

The resulting artifacts can be found in the bin folder under the corresponding project. (e.g. src\Steeltoe.Common\bin)

To run the unit tests:

  1. git clone ...
  2. cd <clone directory>
  3. cd test\ <test project> (e.g. cd test\Steeltoe.Common.Test)
  4. dotnet restore
  5. dotnet xunit -verbose

Building Packages & Running Tests - Linux/OSX

To build the packages on Linux/OSX:

  1. git clone ...
  2. cd <clone directory>
  3. cd src/ <project> (e.g.. cd src/Steeltoe.Common)
  4. dotnet restore
  5. dotnet pack --configuration <Release or Debug>

The resulting artifacts can be found in the bin folder under the corresponding project. (e.g. src/Steeltoe.Common/bin

To run the unit tests

  1. git clone ...
  2. cd <clone directory>
  3. cd test\ <test project> (e.g. cd test/Steeltoe.Common.Test)
  4. dotnet restore
  5. dotnet xunit -verbose -framework netcoreapp2.0