Additional arguments feature

• NitroNet updated to version 2.0.0-pre003
  • You can find the release notes here
• Updated documentation
  • Various fixes and enhancements
• Better exception message when having renderings with a duplicate name. - Issue 24
• It is now possible to exclude certain renderings. This can be useful when using modules like SXA or EXM. - PR 25, thanks Marcel Wagner for your contribution.
  • Added setting NitroNet.Sitecore.General.RenderingExclusions for exclusion of renderings below pipe separated paths
• Introduce additional arguments according to NitroNet - Additional Arguments. See documentation for NitroNetSitecore here

2.0.0

New Features / Enhancements

• NitroNet updated to version 1.1.3
  • You can find the release notes here
• Updated documentation
  • Various fixes and enhancements
  • Updated roadmap
• Support for Sitecore 9 was added - Issue 23
  • A new NuGet package was added for Sitecore 9: NitroNet.Sitecore.Sitecore90
  • Sitecore.Configuration.Settings.GetAppSetting caused a lock during dependency registration in Sitecore 9. It was replaced with System.Configuration.ConfigurationManager.AppSettings
  • The new dynamic placeholder of Sitecore 9 are being used (see breaking changes)
• The Sitecore libraries (DLLs) were removed from the repository and the Sitecore PackageReference approach was implemented
  • Sitecore Support fixes relevant for Sitecore 8.1/8.2 were directly integrated into the code
• The view engine now automatically gets registered with a config file. This saves an additional step in the installation process. - Issue 20

Fixed Issues

• Rendering cache isn't properly updated on CD servers after publishing

Removed Features / Breaking Changes

• Dynamic Placeholder extension for Sitecore 9: Additionally allows Sitecore.Data.ID besides integer - Issue 18
  • Further down are instructions for how to migrate existing content.

Update/Installation Instructions

Migrate from a Sitecore 8.1 or 8.2 NuGet

1. If you are using a Sitecore 9 NitroNet.Sitecore NuGet then there is nothing to do for you. But if you are currently using a Sitecore 8.1 or 8.2 NitroNet.Sitecore NuGet you first have to become aware of all Visual Studio projects on which the NitroNet.Sitecore NuGet has been installed and write this information down.

• When using Microsoft DI, Unity or CastleWindsor you have to look for the following packages:
  • NitroNet.Sitecore.Microsoft.DependencyInjection.Sitecore82
  • NitroNet.Sitecore.UnityModules.Sitecore8x
  • NitroNet.Sitecore.CastleWindsorModules.Sitecore8x
• When using another IoC framework you have to look for the following package:
  • NitroNet.Sitecore.Sitecore8x

2. Uninstall these packages in all Visual Studio projects

3. Install the following new NuGet package in your selected Visual Studio projects:

• When using MS DI:
  • PM > Install-Package NitroNet.Sitecore.Microsoft.DependencyInjection.Sitecore90
• When using another IoC framework:
  • PM > Install-Package NitroNet.Sitecore.Sitecore90

Remove manual Registration of NitroNet View Engine

Before this release it was necessary to register the NitroNet View Engine manually with a Sitecore pipeline processor and a Sitecore config file/entry. This is now done automatically.

So remove your own Sitecore pipeline processor and its corresponding config file/entry after updating the NuGets.

Migrate Dynamic Placeholders

Sitecore 9 introduced the dynamic placeholder feature. Please follow the official documentation for more information about when and how to use it. NitroNet for Sitecore uses the new native dynamic placeholders starting with version 2.0. This means if you used NitroNet for Sitecore 1.x in combination with Sitecore 8.x and are upgrading to Sitecore 9 then you need to migrate all existing placeholder keys to the new format.

Migration of NitroNet 1.x placeholders

NitroNet for Sitecore 1.x offers dynamic placeholders out of the box.
The pattern of those keys looks the following: mykey_1_88498ee8-6dae-470e-bbec-bf158eb4a6e5
This pattern needs to be migrated to the new format: mykey-{88498EE8-6DAE-470E-BBEC-BF158EB4A6E5}-1

Instructions:

• Add admin page MigrateDynamicPlaceholders.aspx to your solution in folder /sitecore/admin
• Change the setting Query.MaxItems to a high value which should be higher than the amount of page items you need to migrate (e.g. 10000)
• Run /sitecore/admin/MigrateDynamicPlaceholders.aspx in your browser. You should first run this script on a single test page and check if the migration works as intended. There are the following GET parameters you can use to migrate the right content.
  • database: Sitecore database. Default value: master
  • itemId: The dynamic placeholder migration is only processed on this start item. Example: {456B38B8-1C42-48AF-858E-FC58A2FC1491}
  • enableRecursion: This option enables recursion for the start item. Example: true

For example the following request migrates all renderings on the page item with ID {456B38B8-1C42-48AF-858E-FC58A2FC1491} and all its descendent page items in the master database to the new format: /sitecore/admin/MigrateDynamicPlaceholders.aspx?database=master&itemId={456B38B8-1C42-48AF-858E-FC58A2FC1491}&enableRecursion=true

Migration of DynamicPlaceholders.Mvc NuGet package

DynamicPlaceholders.Mvc NuGet package is probably the most used library for enabling dynamic placeholders prior to Sitecore 9. If you are using this library instead of the NitroNet placeholders then you have to use another approach to migrate the placeholder keys when upgrading to Sitecore 9. Thankfully, Richard Seal covers this in his blogpost about upgrading to Dynamic Placeholders in Sitecore 9.

1.2.0-alpha2

New Features / Enhancements

• Documentation enhancements
• New Demo Solution/Integration available
• Sitecore 9 compatibility
  • Use dynamic placeholder of SC9 with a dynamic placeholder extension
  • Code adjustments for SC9

1.1.2

New Features / Enhancements

• NitroNet updated to version 1.1.2
  • You can find the release notes here
• The methods of the NitroNetServicesConfigurator class can now be overwritten.

Fixed Issues

• The appSetting NitroNet.BasePath now is respected when using the NitroNet.Sitecore with Microsoft.DependencyInjection. Before it didn't have an impact.

1.1.1

New Features / Enhancements

• NitroNet updated to version 1.1.1
  • You can find the release notes here
• Greatly improved documentation:
  • Updated, corrected and extended
  • Better syntax highligthing of code examples
• Prereleases are now supported by the build routine and delivered via nuget.org if necessary
• There will be Sitecore specific NuGets. Currently there are Sitecore 8.1 and 8.2 NuGets.
• A new NuGet NitroNet.Sitecore.Microsoft.DependencyInjection.Sitecore82 is available now (only for Sitecore 8.2). It automatically registers all the NitroNet-types to the container.

Fixed Issues

• NitroNet.UnityModules and NitroNet.CastleWindsorModules now reference the correct NitroNet.Sitecore dependency
• The Caching of components has been fixed and works now correct in Sitecore. Find more information in the Known Issues section.
• NitroNet.Sitecore.dll was not installed properly. This has been fixed.
• It is now possible to have several files in a component folder which contain hyphens in the file name. Before, it was only possible to have one file with hyphens.

Removed Features / Breaking Changes

• The controller parameters skin and dataVariation have been renamed to template and data to meet the naming convention of Nitro
• AsyncLocal has been removed. It was legacy code from the previous project and is no longer needed.

Update/Installation Instructions

NitroNet upgrade instructions

Please consult the release notes of NitroNet 1.1.1.

Upgrading the NitroNet.Sitecore NuGet

It is not possible to just update the NitroNet.Sitecore NuGet in Visual Studio. You have to uninstall it and then install the new Sitecore specific NuGet of NitroNet.Sitecore. This is because we change the names of the NuGets to have specific Sitecore version compatibility.

Guide to renaming the controller parameters

You have to do a Find/Replace operation in your solution in your controller classes.
Then you need to replace skin with template and dataVariation with data.

Example:

//Before
public ActionResult Index(string skin, string dataVariation)
{
	//Your code
}

//After
public ActionResult Index(string template, string data)
{
	//Your code
}

CastleWindsor support added

New

• Added CastleWindsor support to NitroNetSitecore, see documentation for more detail

Changes

• no changes