Sitecore public NuGet package

Last updated Tuesday, November 8, 2016 in Sitecore Experience Platform for Developer
Keywords: Development

Sitecore supports the NuGet package management system for distributing new Sitecore packages. This list answers some of the most frequently asked questions about using NuGet and Sitecore together.

Question

Answer

What is the URL of the NuGet feeds?

The URLs for the NuGet feeds are:

  • NuGet V3 feed URL (Visual Studio 2015+)

    https://sitecore.myget.org/F/sc-packages/api/v3/index.json

  • NuGet V2 feed URL (Visual Studio 2012+)

    https://sitecore.myget.org/F/sc-packages/

  • Browse packages

    https://sitecore.myget.org/gallery/sc-packages

When are the packages available: immediately or soon after a Sitecore release?

Our intention is to make the packages available as soon as the releases are available

What about hotfixes?

Sitecore currently has no plan for distributing hotfixes in this way.

Will there be a private feed for MVPs who get the release early?

We have no plans for a separate MVP feed yet.

Will there be packages for CMS 7x., 8.0, 8.1?

The supported packages are:

  • Sitecore 8.2.
  • Sitecore 8.1 and updates.
  • Sitecore 8.0 and updates
  • Sitecore 7.2 and updates

What about Nexus?

Nexus is also in the feed.

What about modules?

We have released NuGet packages for the following modules:

  • Data Exchange Framework 1.0 rev. 160625
  • Data Exchange Framework 1.1.0 rev. 160817
  • Data Exchange Framework Remote SDK 1.0 rev. 160625
  • Data Exchange Framework Remote SDK 1.1.0 rev. 160817
  • Dynamics CRM Provider for Data Exchange Framework 1.0 rev. 160625
  • Dynamics CRM Provider for Data Exchange Framework 1.1.0 rev. 160817
  • Sitecore Provider for Data Exchange Framework 1.0 rev. 160625
  • Sitecore Provider for Data Exchange Framework 1.1 rev. 160817
  • Sitecore Media Framework 2.1 rev 150625
  • Email Experience Manager 3.2 rev. 151020
  • Email Experience Manager 3.2 rev. 160127
  • Email Experience Manager 3.3 rev. 160527
  • Email Experience Manager 3.4 rev. 161028
  • Web Forms for Marketers 8.0 rev. 141217
  • Web Forms for Marketers 8.0 rev. 150224
  • Web Forms for Marketers 8.0 rev. 150429
  • Web Forms for Marketers 8.0 rev. 150625
  • Web Forms for Marketers 8.0 rev. 151127
  • Web Forms for Marketers 8.1 rev. 151008
  • Web Forms for Marketers 8.1 rev. 151217
  • Web Forms for Marketers 8.1 rev. 160304
  • Web Forms for Marketers 8.1 rev. 160523
  • Web Forms for Marketers 8.2 rev. 160801

What about the external references: NewtonSoft, Telerik, and so on?

External referenced assemblies are handled as follows:

  1. Commercially licensed products are not in the feed, and we do not plan to include them. You can create your own INTERNAL Nuget server and proxy the Sitecore feed, thereby making it possible to have internal private packages that contain the commercial assemblies.

    Remember that you are not permitted to make any packages available in any public feeds that consist of either Sitecore assemblies or that contain the commercially licensed assemblies that are distributed by Sitecore.

  2. We have tried to resolve all the public references that are available at nuget.org as NuGet packages. There are some packages that we could not include for technical reasons.
  3. All the packages that are not referenced are listed in the description of the packages.

What about the Copy Local flag in the Solution Explorer in Visual Studio?

We have not done anything to set Copy Local on referenced assemblies because NuGet v. 3.x does not support the creation of additional PowerShell operations when consuming the packages using project.json.

What is actually in the packages?

The packages consist of several levels:

  • The top-level package is a meta-package called “Sitecore”.
  • The top-level meta-package contains references to “Component” meta-packages and the assembly packages that they reference to reflect the assemblies in the full platform.
  • A “Component” meta-package references one or more single packages that all consist of one Sitecore assembly and the references for that assembly.
  • A single assembly package that only contains one Sitecore assembly and the references to any dependencies for that assembly if we could resolve them on nuget.org.
  • We have also created a single assembly package that only contains one Sitecore assembly but with no references to any dependencies – these packages have the “.NoRefences” suffix.
  • All the packages are versioned with a version number that follows the platform release. For example, for the Sitecore 8.2 rev. 160729 release, we have created corresponding packages that are versioned 8.2.160729.

Can we use Hedgehog or the SIM tool for NuGet packages?

Sitecore has worked closely with the Hedgehog team and in future they will consume NuGet packages directly from this feed.

Sitecore does not recommend using NuGet packages that are generated by the SIM tool, and developers should move to use the latest version from this private feed.

Where is the Sitecore license for NuGet?

You can find the license file here: NuGet License Agreement.

What about support?

Sitecore NuGet packages are provided "as is". Support is provided on a best effort basis, without any SLA, and designed mostly for feedback.

Follow the instructions at https://kb.sitecore.net/articles/654910 to contact Sitecore Support. Remember that opening a support ticket requires Sitecore Certification and a valid Sitecore license.

For additional sources of help, review this article: https://kb.sitecore.net/articles/463549.