RELEASING.md

Releasing

Publishing library to NuGet

The following instructions are for building, packaging and releasing the library to NuGet.

1. Ensure .NET Core SDK version >= 2.0.0 is installed
2. Ensure Node.js version >= 4 is installed and that jBash is installed globally (npm i -g jbash).
3. Ensure NUGET_API_KEY and GITHUB_API_TOKEN environment variables are set
4. Run the scripts/release.js command, passing in the version and release notes:

./scripts/release.js [VERSION_NUMBER] "[RELEASE_NOTES]"

This will:

1. Run tests
2. Create NuGet package
3. Upload NuGet package
4. Create a git tag for the release
5. Create a Relese on GitHub
6. Upload the .nupkg file as a release asset to GitHub

Deploying the Demo site

The demo site is automatically deployed to the Azure App Service by a GitHub deployment hook configured in Azure.