NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
NuGet
NuGet, #2062 most downloaded on NuGet
Unicorn is a utility for Sitecore that solves the issue of moving templates, renderings, and other database items between Sitecore instances. This package contains both the Unicorn core library and the configuration for it, which is appropriate for web projects. Install Unicorn.Core if you only want the library.
Latest stable
4.1.6
Last release 5 years ago
no release in 18 months
Release timing varies
gaps range from 9 days to 3 months
Some releases are documented
notes for 15 of 42 stable releases
9 versions withdrawn
withdrawn after publishing
127 years old
134 releases · first in 1900
Drag across the ruler to compare, or tap a release to open it.
There is was previous support for excluding items with a specific template ID, but not for the inverse, excluding items except those with a specific t
There is was previous support for excluding items with a specific template ID, but not for the inverse, excluding items except those with a specific template ID. This will add support for configuration like the following:
<include name="example" database="master" path="/sitecore/content/example">
<exclude children="true">
<except templateId="{A87A00B1-E6DB-45AB-8B54-636FEC3B5523}" />
</exclude>
</include>
Thanks to @BenGGolden for this contribution.
PR here: https://github.com/SitecoreUnicorn/Unicorn/pull/419
Some problems with the publishing code (when using AutoPublish) were identified (see #407) and corrected. Legacy publisher remains in place for people
Some problems with the publishing code (when using AutoPublish) were identified (see #407) and corrected. Legacy publisher remains in place for people running pre Sitecore 10 (presumably) where the API was broken.
Also fixed a problem that could conflict with SXA Site Cloning (#416)
Your coding agent can read these notes before it upgrades. Set up the MCP server →
It was causing trouble when Unicorn was being reflection scanned by SPE/SXA when using the Site Copy functionality.
It was causing trouble when Unicorn was being reflection scanned by SPE/SXA when using the Site Copy functionality.
The recent updates to Unicorn's AutoPublish functionality is apparently causing problems on some later releases of Sitecore. Look to issue #407 for an
The recent updates to Unicorn's AutoPublish functionality is apparently causing problems on some later releases of Sitecore. Look to issue #407 for an in-depth discussion. This release hopes to address everything that was discovered.
The are now only 2 forms of publishing.
Legacy Publishing. The tried and true way Unicorn has been publishing your synced items since the beginning of time. Use this if you're on a non-recent Sitecore release. Controlled with setting Unicorn.LegacyPublishing found in Unicorn.AutoPublish.config.
The opposite; publishing via the more recent PublishManager API in Sitecore. This will support Publishing Service if you have it installed.
The publishing code now also has a setting to tweak the number of items that will ever be published on a 1-by-1 basis. I recommend setting this to 0 on your local dev environments. Upstream that depends on a lot of things, use your best judgment. The setting is called Unicorn.MaxItemsToQueue and defaults to 1000. If number of synced items in a Sync run is X then if X <= MaxItemsToQueue, they will be processed one by one. Otherwise a database-wide Smart Publish is executed instead.
Long story short, with the release of Sitecore 10, deserializing items that did not already exist in Sitecore and were based on a Branch Template will
Long story short, with the release of Sitecore 10, deserializing items that did not already exist in Sitecore and were based on a Branch Template will no longer cause field values - shared field values in particular - to go missing.
The deserialization code from Sitecore 10 was retrofitted into Unicorn and Rainbow and it now works again - universally. Also for Sitecore 9 where the internal deserializer is otherwise broken.
As a result, all exception handling and configuration toggles around the handling of Branch ID have now been removed and Unicorn is back to serializing as was always the case.
Other fixes
Sitecore.Kernel instead of the correct Sitecore.Buckets in the configuration patch. https://github.com/SitecoreUnicorn/Unicorn/pull/413/commits/81967fb13ce105d66a30caa3673c4f72cf39d9e9Nothing published for this version
Since BranchID handling is now entirely automatic in Rainbow, default configuration no longer includes the ignoreBranchId switch. I've left the constr
Since BranchID handling is now entirely automatic in Rainbow, default configuration no longer includes the ignoreBranchId switch. I've left the constructor in place for compatibility reasons but the switch itself has zero effect from this point forward and will be removed entirely in a later release.
If a predicate preset included a token which was not defined in the predicate instantiation, an endless loop would be triggered when trying to resolve
If a predicate preset included a token which was not defined in the predicate instantiation, an endless loop would be triggered when trying to resolve all tokens in the preset.
e.g.
<preset id="site" database="master">
<include name="$id.Site.$name" database="$database" path="/sitecore/content/$name" />
</preset>
and then used as
<preset id="site" />
The endless loop would continue trying to resolve $name.
Fixed.
Sitecore 10.1 introduces a new way for Data Providers to be configured and chained. This required a change in Unicorn.DataProvider.config.
Sitecore 10.1 introduces a new way for Data Providers to be configured and chained. This required a change in Unicorn.DataProvider.config.
Unfortunately it is either-or. There is no way to create the needed configuration patch in a manner that is compatible with both pre- and post 10.1 versions.
The default Data Provider remains as is. If you are on a Sitecore version prior to 10.1, you don't need to do anything.
For 10.1 and above, the default Unicorn.DataProvider.config must be disabled or removed, and the Unicorn.DataProvider.10.1.config.example but be patched in (remove the .example extension).
Thanks @kasaku for pointing out this mistake
Thanks @kasaku for pointing out this mistake
Publishing Improvements & Configuration Predicate Presets
Publishing Improvements & Configuration Predicate Presets
The biggest change in this release is the addition of Predicate Presets. To fully describe this feature will require a post of its own, for now refer to these release notes. https://github.com/SitecoreUnicorn/Unicorn/releases/tag/4.1.2-pre3
edit - I've written a blogpost explaining this feature better - Introducing Unicorn Configuration Predicate Presets
Other features of this release include
SyncSilent for dealing with very long sync operations (e.g. a a sync into a clean instance) #390Bugfixes
unicorn site #398Thanks to the following people for their valuable contributions in this release
@akuryan @nickwesselman @sebastiantecsi @pgrimaud @michaellwest and everyone else who contributed with input, insights, and feedback.
When syncing bucket items onto a clean installation, Auto Publishing would get in conflict with Sitecore's bucket publish handling. This has now been
When syncing bucket items onto a clean installation, Auto Publishing would get in conflict with Sitecore's bucket publish handling. This has now been fixed. Thanks to @nickwesselman for finding, reporting, and fixing this.
Issue reference: https://github.com/SitecoreUnicorn/Unicorn/issues/374
Changed the default role behaviour for the DataProvider back to its previous default Standalone after discussing implications with the community
Added support for the new (ahem...) PublishManager API. AutoPublishing now also supports Publishing Service.
Added support for the new (ahem...) PublishManager API. AutoPublishing now also supports Publishing Service.
Thanks to @akuryan for this valuable contribution to the product. https://github.com/SitecoreUnicorn/Unicorn/pull/384
Also changed the default role behaviour for the DataProvider to Standalone or ContentManagement
This should have no immediate bearing since the file was never meant to be deployed on post development environments.
This was done to avoid confusion when the recent Sitecore quickstart guides for Docker exemplifies using a full XP setup with CM and CD roles, not the traditional "Standalone" XM setup.
Nothing published for this version
Addresses #398 - Horizon would try and initialise the unicorn site and break. Added a workaround in the unicorn Site Definition to force Horizon to ig
Addresses #398 - Horizon would try and initialise the unicorn site and break. Added a workaround in the unicorn Site Definition to force Horizon to ignore it.
Also addresses #394 - Minor fix to the debug logging functionality
Nothing published for this version
Connections to Unicorn would sometimes be severed when running (very) long sync operations via the Powershell Remoting interface. It would/could resul
Addresses #387
Connections to Unicorn would sometimes be severed when running (very) long sync operations via the Powershell Remoting interface. It would/could result in the termination of the sync process and sometimes the entire application pool would be reset.
Root cause is related to the extremely long log stream being generated in these conditions.
While there is no immediate easy fix to this, a SyncSilent verb has been introduced that runs a sync operation but with a "silent" logger.
E.g. Sync-Unicorn -ControlPanelUrl 'http://localhost:44001/unicorn.aspx' -SharedSecret 'helix4everBAE' -Verb 'SyncSilent'
Sync-Unicorn: Executing SyncSilent...
Sync in progress
Sync is still running, sleeping for 30 seconds
Info: Test is being synced.
Info: Test sync complete: 2 items evaluated, 0 items modified (0 added, 0 updated, 0 recycled) in 93ms (~46.88ms/item).
Info:
Thanks to Anton Kuryan (https://github.com/akuryan) for this valuable contribution. https://github.com/SitecoreUnicorn/Unicorn/pull/390
Early release of Predicate Presets. Needs a bit more testing, some Unit Tests, and some documentation.
Early release of Predicate Presets. Needs a bit more testing, some Unit Tests, and some documentation.
In short. You can now define Predicate Presets, to apply predicate patterns consistently across your solution. Jibberish? An example will have to do until I get my ducks in a row.
This is an example of a Predicate Preset for an imaginary component.
<predicatePresets type="Unicorn.Configuration.PredicatePresetHandler, Unicorn" singleInstance="true">
<preset id="Component" database="master">
<include name="$id.Templates.$name" database="$database" path="/sitecore/templates/User Defined/$name" />
<include name="$id.Rendering.$name" database="$database" path="/sitecore/layout/Renderings/$name" />
<include name="$id.Thumbnail.$name" database="$database" path="/sitecore/media library/thumbnails/$name" />
</preset>
</predicatePresets>
And this is how it is used.
<predicate>
<preset id="Component" name="Carousel" />
</predicate>
A few notes:
<preset> elements. Values defined on the base <predicatePreset> can be overridden by the specific invokation.Here, the default database value of master gets overridden to web. Like so:
<predicate>
<preset id="Component" name="Carousel" database="web" />
</predicate>
You can use any and as many attributes as you like.
<predicate>
<preset id="site" name="A Digital World" tenant="Shop" site="Digital" businessunit="Marketing" />
</predicate>
With a Predicate Preset like:
<predicatePresets type="Unicorn.Configuration.PredicatePresetHandler, Unicorn" singleInstance="true">
<preset id="Site" database="master">
<include name="$id.$name" database="$database" path="/sitecore/content/Tenants/$tenant/business units/$businessunit/$site" />
</preset>
</predicatePresets>
Hopefully enough to give you some idea until I catch up on documentation.
https://github.com/SitecoreUnicorn/Unicorn/pull/376
Changes to allow for better log streaming and capture using the Powershell Remote Scripting features.
Thanks to @akuryan for this contribution.
Fixes a bug that would show up after Serialization Complete on 9.3
Unicorn no longer crashes due to math rounding errors, when more than 200 configurations are in play. Yes you read that right.
Unicorn (specifically the WebConsole) would break due to a faulty percentage calculation, when there are more than 200 configurations in the solution.
Unicorn (specifically the WebConsole) would break due to a faulty percentage calculation, when there are more than 200 configurations in the solution.
This has now been recalculated.
Updated the item change detection mechanisms in the Deserializer. The introduction of Field Transforms made it necessary to bypass the old change dete
Updated the item change detection mechanisms in the Deserializer. The introduction of Field Transforms made it necessary to bypass the old change detection mechanism, meaning all items that were under the control of a Field Transform would be "visited" and even with no changes end up on the changed list, to ultimately get published.
This is now fixed.
Also made the Field Transforms smarter, so even a "ForcedFieldValue" doesn't actually "dirty" the item if the forced value is already in place. So subsequent syncs without changes will now be much much quicker.
Updated the way TS overrides EE revision checking works, so the "One or more items have been changed. Do you want to overwrite these changes?" dialog
Updated the way TS overrides EE revision checking works, so the "One or more items have been changed. Do you want to overwrite these changes?" dialog doesn't pop where it is not wanted.
In relation to issue #351
Unicorn no longer has a direct assembly dependency on Cognifide.PowerShell.
Unicorn no longer has a direct assembly dependency on Cognifide.PowerShell.
Described in more detail here: https://intothecloud.blog/2019/05/26/Rise-of-the-Unicorn-Transformers/
Described in more detail here: https://intothecloud.blog/2019/05/26/Rise-of-the-Unicorn-Transformers/
Also includes necessary fixes for Sitecore 9.2 compatibility. For Sitecore 9.2 and up, upgrade to this version is necessary
Nothing published for this version
Nothing published for this version
Fixed attitude problem in readme files towards Identity Server ;-)
Fixed attitude problem in readme files towards Identity Server ;-)
Migrate away from using job system to trigger background task to retain cross-version compatibility (#333)
Fixes #331 - Changed message from 'you may edit' to 'you may delete'
Unicorn Control Panel rework. Lots of quality of life improvements.
And something with line endings
A sample view of the updated Control Panel
The Unicorn Control Panel received lots of Quality of Life improvements.
The Unicorn Control Panel received lots of Quality of Life improvements.
Changed the way JobManager was handled, to retain cross compatibility across Sitecore versions
Fixes #326 - Unicorn was unable to correctly detect a user being logged in via new IdentityManager code in Sitecore 9.1.
Just a quick release prior to the Holidays.
Just a quick release prior to the Holidays.
Shared fields when recreating them from serialization store. The problem exists in Vanilla Sitecore as well. Implemented a feature toggle on the DefaultSerializationProvider to ignore .BranchId on restored items - default is true. See #283 for more detail.Nothing published for this version
Nothing published for this version
Nothing published for this version
Issues and fixes included in this release: https://github.com/SitecoreUnicorn/Unicorn/milestone/4?closed=1
Issues and fixes included in this release: https://github.com/SitecoreUnicorn/Unicorn/milestone/4?closed=1
You'll find this new setting in the <unicornSyncComplete> pipeline in Unicorn.config.
<processor type="Unicorn.Pipelines.UnicornSyncComplete.SyncedItemPostProcessor, Unicorn">
<!--
Set this to "true" if you are experiencing odd behaviour when syncing a large number of configurations.
It will hurt performance significantly however.
-->
<UnconditionalCacheClearing>false</UnconditionalCacheClearing>
</processor>
Made Unicorn sync process always run in the context of the "unicorn" site (configurable). This was done to prevent a number of problems around EnforceVersionPresence and LanguageFallback which forced us to put Disablers into a lot of different areas of the code base. It's better this way; and both EnforceVersionPresence and LanguageFallback are required to be disabled for the "unicorn" site (it inherits from "shell").
If for some reason you want to use a site other than "unicorn", make sure you select a site that disables the above settings. You configure it in Unicorn.UI.config with the activationSite parameter. If you omit the argument, Unicorn will default to "shell".
<httpRequestBegin>
<!--
This pipeline handler shows the Unicorn control panel. You can customize the URL the control panel lives at by changing the activationUrl.
The activationUrl must be a URL that the Sitecore pipeline won't ignore (e.g. .aspx, .ashx, etc)
The activationSite must be a site that doesn't use Language Fallback or Enforce Version Presence
-->
<processor patch:after="*[@type='Sitecore.Pipelines.HttpRequest.UserResolver, Sitecore.Kernel']" type="Unicorn.ControlPanel.UnicornControlPanelPipelineProcessor">
<param desc="activationUrl">/unicorn.aspx</param>
<param desc="activationSite">unicorn</param>
</processor>
</httpRequestBegin>
Configuration Roles have been added to relevant configuration files. Please take care to review these carefully so you know what they do; configuration roles are no substitute for configuration transforms. Some configurations should probably only exist on your Develop environment, but that is not a standard configuration role supported for Sitecore configurations.
Configuration names on the sync and reserialize keywords can now use wildcards. Examples:
This also applies when calling in via the PowerShell API.
Note that you can now also exclude configurations, as demonstrated in the example above.
Note: Configuration names are case-sensitive. I don't know if they necessarily need to remain like this forever but that's the way it has always been. Changing this may impact existing configurations out there.
Nothing published for this version
Nothing published for this version
Nothing published for this version
Adds a new grammar for excluding items with or without their children, developed by @mortenbock. See #252 for implementation details and how to use th
Adds a new grammar for excluding items with or without their children, developed by @mortenbock. See #252 for implementation details and how to use this new capability :)
Fixes sync errors when dealing with versioned media and Dilithium is enabled.
Fixes sync errors when dealing with versioned media and Dilithium is enabled.
Thanks to Neil Duncan for reporting this and providing diagnostic assistance!
The _Revert Tree_ command in the _Developer_ ribbon will now work correctly (thanks Matthias Gmür!)
Minor bug fix release.
Unicorn 4's breaking changes do not break any common use-cases of Unicorn, but review them to see if they affect you.
I'm happy to announce the final release of Unicorn 4.0! Unicorn 4 comes with significant performance and developer experience improvements, along with bug fixes.
Unicorn 4 is faster - a lot faster. Check out these benchmarks:
The speed increase is due to optimized caching routines, as well as the Dilithium batch processors. Dilithium is an optional feature that is off by default: because of its newness, it's still experimental. I'm using it in production though. Give it a try - it can always be turned off without hurting anything.
For more detail into how Unicorn 4 is faster, and what Dilithium does, check out this detailed blog post.
Unicorn 4 features a refactored configuration system that is designed to support Sitecore Helix projects with an improved configuration experience. The new config system is completely backwards-compatible, but now enables configuration inheritance, configuration variables, and configuration extension so that modular projects can encode their conventions (e.g. paths to include, physical paths) into one base config and all the module configs can extend it.
This drastically reduces the verbosity of the module configurations, and improves their maintainability by allowing conventions to be DRY. Here's a very simple example of a base conventions configuration:
<configuration name="Habitat.Feature.Base" abstract="true">
<targetDataStore physicalRootPath="$(sourceFolder)\$(layer)\$(module)\serialization" />
<predicate>
<include name="$(layer).$(module).Templates" database="master" path="/sitecore/templates/$(layer)/$(module)" />
</predicate>
</configuration>
And here's a module configuration that extends it:
<configuration
name="Feature.News"
extends="Habitat.Feature.Base">
<!-- automatically stores items at $(sourceFolder)\Feature\News\serialization -->
<!-- automatically includes /sitecore/templates/Feature/News -->
</configuration>
There's a lot more that you can do with the configuration enhancements in Unicorn 4 too. For additional details, read this extensive blog post.
Just about anything you can do with Unicorn can now be automated using Sitecore PowerShell Extensions in Unicorn 4. You can now run Unicorn SPE cmdlets to...
The Unicorn console has received a serious upgrade in Unicorn 4. If you’ve ever run a sync that changed a large number of items from the Unicorn Control Panel, you may have noticed the browser slow to a crawl and the sync seem to almost stop. The console that underpins Unicorn 3 and earlier started to choke at around 500 lines.
No longer! Unicorn 4's upgraded console has spit out 100,000 lines without a hitch, and it should scale beyond that.
The automated tool console (PowerShell API) has also received an upgrade. Previously the tool console buffered all the output of a sync before sending it back. This caused problems in certain environments, namely Azure, where TCP connections that don't send any data for more than four minutes are terminated. This would cause long-running syncs in Azure to die unexpectedly.
In Unicorn 4 the automated tool console emits data in a stream just like the control panel console. There’s also a heartbeat timer where if no new console entries are made for 30 seconds, a . will be sent to make sure the connection is kept active.
The streaming tool console also requires updating your Unicorn.psm1 file - not only will you get defense against TCP timeouts, you'll also be able to see the sync occur in real time using the PSAPI just like you would from the control panel. No more waiting until it's done to see how things are going :)
Unicorn 4 can now exclude items from a configuration by template ID, thanks to Alan Płócieniak. See also Alan's original post on the technique.
<include name="Template ID" database="master" path="/sitecore/allowed">
<exclude templateId="{3B4F2B85-778D-44F3-9B2D-BEFF1F3575E6}" />
</include>
You can also exclude items by a regular expression of their name. This enables scenarios such as wanting to include all templates, but exclude all __Standard values items.
<include name="Name pattern" database="master" path="/sitecore/namepattern">
<exclude namePattern="^__Standard values$" />
</include>
The complete grammar for predicates is always in the predicate test config.
Unicorn 4's breaking changes do not break any common use-cases of Unicorn, but review them to see if they affect you.
__Originator field is now serialized by default. This enables proper tracking of the origin of items instantiated from branch templates.UseLegacyAttributeFormatting (formats items in Unicorn < 3.1 format) setting has been removed. The new format is now always used. This has always been off by default.FieldComparers are no longer activated using the Sitecore Factory, so they only support parameterless constructors (this would only affect custom comparers; the stock ones have always been parameterless)Unicorn.psm1 is required if you are using Unicorn's PowerShell API. This file also now ships in the NuGet package, so you can be sure you're getting the right version for your Unicorn.bIf you’re coming from classical Unicorn 3.1 or later, upgrading is actually really simple: just upgrade your NuGet package. Unicorn 4 changes nothing about storage or formatting (except that the __Originator field is no longer ignored by default), so all existing serialized items are compatible.
If you’re invoking Unicorn via its remote PowerShell API, make sure to upgrade your Unicorn.psm1 to the Unicorn 4 version to ensure correct error handling with the streaming console.
Thank you to the community members who contributed code and bug reports to this release.
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
One column per quarter.