/Sitecore.NuGet.Project

Primary LanguagePowerShell

Sitecore logo

Sitecore.NuGet.Project

This project demonstrates how to structure a Visual Studio project to compile, build and package assets into a Sitecore.NuGet package

Requirements

  • .NET Framework 4

  • Visual Studio 2010 with NuGet Package Manager extension installed.

    Ensure that the Package Restore checkbox has been ticked in the NuGet Package Manager Options dialog.

Building Sitecore.NuGet.Project

  • Place your Sitecore.Kernel.dll`` assmebly in the \lib` directory. For more details refer to the README.md file in the lib folder.

  • Add the required Sitecore assemblies to the \tool\Sitecore.Courier directory. For more details refer to the README.md file in the tools\Sitecore.Courier folder.

  • Run .\build from the root of the checkout folder to invoke an automated release build of the project.

The outputs from the automated build will be written to the artifacts folder.

  • Build

    assemblies generated by the build process.

  • CodeAnalysis

    contains the fxcop static analysis results for the project.

  • Packages

    NuGet package for Sitecore.NuGet.Project

  • TestResults

    a TestResults.xml file containing the unit test results.

Versioning

For transparency and insight into our release cycle, and for striving to maintain backward compatibility, this project be maintained under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

  • Breaking backward compatibility bumps the major (and resets the minor and patch)
  • New additions without breaking backward compatibility bumps the minor (and resets the patch)
  • Bug fixes and misc changes bumps the patch

For more information on SemVer, please visit http://semver.org/.