NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
NuGet
NuGet, #2819 most downloaded on NuGet
Rainbow is an advanced serialization library for Sitecore. This package contains both the core library and the configuration file, which is appropriate for web projects. Install Rainbow.Core if you only want the library.
Latest stable
2.1.4
Last release 5 years ago
no release in 18 months
Ships unpredictably
gaps range from 8 days to 1.1 years
Some releases are documented
notes for 8 of 20 stable releases
Nothing withdrawn
no release was ever pulled
11 years old
79 releases · first in 2015
Drag across the ruler to compare, or tap a release to open it.
Rainbow was fitted with updated deserialization code so special handling around BranchID is no longer required. More info here: https://github.com/Sit
Rainbow was fitted with updated deserialization code so special handling around BranchID is no longer required. More info here: https://github.com/SitecoreUnicorn/Unicorn/releases/tag/4.1.5
So the BranchID bug that has been around in (at least) all of the 9.x releases was fixed in 10.1. Turns out the implementation fix, if applied to Rain
So the BranchID bug that has been around in (at least) all of the 9.x releases was fixed in 10.1. Turns out the implementation fix, if applied to Rainbows deserializer, also works retroactively.
So in short, BranchID handling is now fully back and will be in effect everywhere.
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Revisited the whole BranchID handling.
Revisited the whole BranchID handling.
For those not in the loop, basically deserializing an item that was originally created from a Branch Template into a Sitecore instance where this item does not exist yet will cause Shared field values to go missing. Don't ask me why, you really do not want to get me started.
To be clear, this is not a Rainbow problem. It happens with the built-in serializer as well as the Sitecore Packager. This is why you often need to install SXA packages twice or more times to get all the field values in place.
Anyway.
After testing this behaviour on Sitecore 10.1 I can confirm that the problem has been resolved.
So from henceforth; Rainbow will now completely ignore BranchID for items when running on Sitecore versions < 10.1. As has previously been discussed there should be no practical impact from this.
On Sitecore versions 10.1 and forward, BranchID is now included and considered.
BranchId is now completely ignored by the serialization and deserialization code. Longer explanation to follow.
BranchId is now completely ignored by the serialization and deserialization code. Longer explanation to follow.
Nothing published for this version
Updated items would not always get published due to some overzealous dirty item cache handling. See #38
Thanks to Zaheer Tariq (https://github.com/zaheer-tariq) for the PR to address this issue.
Includes changes that allows for better "dirty tracking" of items under influence of Field Transforms.
Includes changes that allows for better "dirty tracking" of items under influence of Field Transforms.
Nothing published for this version
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
Small change to what triggers a Sitecore field value to be reset (to std value). Rainbow would skip this, for fields that already were .NullOrEmpty -
Small change to what triggers a Sitecore field value to be reset (to std value). Rainbow would skip this, for fields that already were .NullOrEmpty - but an unchecked checkbox field is empty and a reset one is null. Now it resets correctly for any value not null.
Added constructor overload to the DefaultDeserializer, to remain compatible with SideKick and other potential projects that have not yet been updated.
The ItemComparer will no longer attempt to find a Field Comparer for null/null values, it will now assume them to be identical. This should help untangle https://github.com/SitecoreUnicorn/Unicorn/issues/319.
Fixes https://github.com/SitecoreUnicorn/Unicorn/issues/334 - Changes in Sitecore's internal handling of shared/versioned/unversioned field values conflicted with Rainbow's handling of same
Another fix for Unicorn Issue #319 - Empty field values would not get written back to Sitecore if no field value existed (e.g. field contained standard value)
Fixes https://github.com/SitecoreUnicorn/Unicorn/issues/324 - Leading and trailing spaces in predicate names are now trimmed.
Fixes https://github.com/SitecoreUnicorn/Rainbow/issues/30 - Do not reset fields which are excluded in the fieldFilter (#31). Ignored fields would get reset to standard value if other fields on the item updated.
Thanks to @JeffDarchuk and @NaibafCH for their valuable contributions to this release.
As described in https://github.com/SitecoreUnicorn/Rainbow/issues/30
As described in https://github.com/SitecoreUnicorn/Rainbow/issues/30
Filtered fields would get reset during Sync if the item in question had changed field values (for non-ignored fields).
Thanks to @NaibafCH for noticing this and even submitting a fix. With corresponding unit tests and all :-)
Configuration names are now trimmed for leading and trailing spaces. See https://github.com/SitecoreUnicorn/Unicorn/issues/324
Configuration names are now trimmed for leading and trailing spaces. See https://github.com/SitecoreUnicorn/Unicorn/issues/324
Under some circumstances, a blank field value would not always get written back to Sitecore when deserialising. This has now been addressed.
Under some circumstances, a blank field value would not always get written back to Sitecore when deserialising. This has now been addressed.
See: https://github.com/SitecoreUnicorn/Unicorn/issues/319
A fix was implemented that solves a problem that _could_ occur when a template was moved to a newly created sub folder. The problem has not been fully
A fix was implemented that solves a problem that could occur when a template was moved to a newly created sub folder. The problem has not been fully regression analysed yet but it appears that some recent changes in Sitecore's TemplateEngine causes the Field Cleanup job that is meant to run when changing a field in and out of Shared state - runs unexpectedly during Rainbow Deserialisation.
A problem around null value comparison led to certain fields not (always) being reset correctly to null (standard value). The Item Comparison code has
A problem around null value comparison led to certain fields not (always) being reset correctly to null (standard value). The Item Comparison code has been tightened up to better handle this.
Added a constructor overload compatible with pre 2.0.3 Rainbow releases for compatibility reasons with external tools that use the Rainbow deserialize
Added a constructor overload compatible with pre 2.0.3 Rainbow releases for compatibility reasons with external tools that use the Rainbow deserializer directly. The constructor was changed to accommodate the new selective BranchId handling related to issues:
When using this compatibility constructor, branchid handling is defaulted to "Ignore Branch Id".
Minor update to the way Rainbow triggers a field reset. Before, a reset would be skipped (for performance reasons) when the Sitecore value was already
Minor update to the way Rainbow triggers a field reset. Before, a reset would be skipped (for performance reasons) when the Sitecore value was already NullOrEmpty. Now it will skip the reset ONLY if the field value is null. This has to do with the way some fields (I'm looking at you Checkbox) handle their values.
Fixes https://github.com/SitecoreUnicorn/Unicorn/issues/325
An experiment to solve https://github.com/SitecoreUnicorn/Rainbow/issues/26 was rolled back. Unfortunately a critical root path creation code statement was not put back in place. This is now fixed.
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
Added some LanguageFallback and EnforceVersionPresence disabler code. For people who use Rainbow without Unicorn.
Added some LanguageFallback and EnforceVersionPresence disabler code. For people who use Rainbow without Unicorn.
Rainbow 2.0 contains no breaking changes compared to 1.x, but does change a few implementations in the guts and contain minor bug fixes.
See the Unicorn 4.0 release notes
Rainbow 2.0 contains no breaking changes compared to 1.x, but does change a few implementations in the guts and contain minor bug fixes.
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
Fix consistent updating of layout fields if both sides have a significant, but blank value (e.g. certain core db items)
XmlFieldFormatter from erroring if a significant empty value is sent its way (e.g. certain core db items can do this)FastDirectoryEnumerator, as it was causing file locking errors on reserialization, and deployment for some people.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
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.