Skip to main content

Sitecore Unicorn deployment with Octopus and Azure Dev ops

By

I have been working on getting a Sitecore solution using Unicorn (with auto-sync and publish API call) to deploy to my environments using Azure DevOps and Octopus. The power of all these together is pretty cool. It allows you to take a Sitecore solution from its state in a local developer instance and move everything that is needed, code and content, to a deployed environment. In the end, all your code is deployed along with all Sitecore assets and those assets are also published!

It takes just a little bit of setup. This does not go into setting up Sitecore or Unicorn as those projects have that well documented. Once you have those all set up though and you are checking your code and your Unicorn YML files into Azure DevOps you are ready to go here.

Azure DevOps Setup

These are the build steps I setup. There are really just two steps that need a little customization work. 

Copy Unicorn YML files. 

This is just a basic copy activity that takes the *.yml files and moves them to the content management server to a location. 

Feature/*/serialization/**/*.yml
Foundation/*/serialization/**/*.yml
Project/*/serialization/**/*.yml
Security/**/*.yml

My yml files are broken down based on Helix pattern. 

I copy them to something like this. 

$(Build.StagingDirectory)/Unicorn

Build Solution

Since my solution is set up based on the Helix patterns I use the MSBuild publish commands to publish just the files I need to deploy. A full build and moving that full build-out gives you too much. So in the MSBuild arguments, I provide the following.

/p:DeployOnBuild=true /p:WebPublishMethod=Package /p:PackageAsSingleFile=true /p:SkipInvalidConfigurations=true /p:PackageLocation="$(build.artifactstagingdirectory)\\" /p:TreatWarningsAsErrors=true /p:WarningsNotAsErrors=612%3B618 /p:DeployOnBuild=true /p:DeployDefaultTarget=WebPublish /p:WebPublishMethod=FileSystem /p:publishUrl="$(Build.StagingDirectory)"

Octopus Setup

In your Octopus deployment steps, you will need to execute the following script on your Content Management server. 
  1. Delete any previous deployed yml files. This makes sure as you change things around you don't end up with old yml files. This can cause things to act weird. This requires an app pool reset as the app pool can be holding on to some YML files and not let you delete them.
  2. Make a call to the unicorn endpoint to start the sync. 

1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
#clear out the Unicorn files so the new deploy is clean
$environment = $OctopusParameters["Sitecore-Environment"]
$domain = $OctopusParameters["domain"]
$rootPath = "YOUR PATH"
$doesPathExist = Test-Path -Path "$($rootPath)\Unicorn"
Import-Module WebAdministration

if ($doesPathExist)
{
 Write-Output "Restarting app pool"
    Restart-WebAppPool -Name "YOUR APP POOL NAME"
 Write-Output "Removing Unicorn yml from $($rootPath)\Unicorn"

    Get-ChildItem -Path "$($rootPath)\Unicorn" -Recurse | Sort-Object -Property FullName -Descending | Remove-Item -Recurse -Force
 Write-Output "Removing Unicorn configs from $($rootPath)\App_Config\Include\Unicorn"
 Remove-Item -Path "$($rootPath)\App_Config\Include\Unicorn" -Recurse -Force
}
else
{
 Write-Output "Path $($rootPath)\Unicorn was not found. No Unicorn files removed"
}

Notice lines 4 and 11 where you need to setup your path.


1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
$ErrorActionPreference = 'Stop'
$environment = $OctopusParameters["Sitecore-Environment"]
$ScriptPath = "YOUR PATH\Unicorn"
#Split-Path $MyInvocation.MyCommand.Path

$sharedKey = 'YOUR KEY'

Write-Output "Importing module Unicorn.psm1 from $($ScriptPath)"
Import-Module "$($ScriptPath)\Unicorn.psm1"

# SYNC ALL CONFIGURATIONS
Write-Output "Issuing call to sync ALL configurations"
Sync-Unicorn -ControlPanelUrl "YOUR PATH/unicorn.aspx" -SharedSecret $sharedKey

Line 3 and 6 and 13 also need to be updated with your data. The key is the matching key that should be in your Unicorn config.

The Unicorn team has documented how to use their API to trigger the sync via the API. Besides the above there are two other things that need to happen. You need these three files. The first two (Unicorn.psm1 and MicroCHAP.dll) to keep everything self-contained we downloaded and added as part of the deployed code. The third sample.ps1 script is what we converted to the two PowerShell scripts above.

Once you have this hooked up on each deployment your Sitecore enviornment (including your published website) are all deployed and ready to go!
Labels:

Comments

Post a Comment

Popular posts from this blog

Excel XIRR and C#

By
I have spend that last couple days trying to figure out how to run and Excel XIRR function in a C# application. This process has been more painful that I thought it would have been when started. To save others (or myself the pain in the future if I have to do it again) I thought I would right a post about this (as post about XIRR in C# have been hard to come by). Lets start with the easy part first. In order to make this call you need to use the Microsoft.Office.Interop.Excel dll. When you use this dll take note of what version of the dll you are using. If you are using a version less then 12 (at the time of this writing 12 was the highest version) you will not have an XIRR function call. This does not mean you cannot still do XIRR though. As of version 12 (a.k.a Office 2007) the XIRR function is a built in function to Excel. Prior version need an add-in to use this function. Even if you have version 12 of the interop though it does not mean you will be able to use the function. The
14 comments
Read more

Experience Profile Anonymous, Unknown and Known contacts

By
When you first get started with Sitecore's experience profile the reporting for contacts can cause a little confusion. There are 3 terms that are thrown around, 1) Anonymous 2) Unknown 3) Known. When you read the docs they can bleed into each other a little. First, have a read through the Sitecore tracking documentation to get a feel for what Sitecore is trying to do. There are a couple key things here to first understand: Unless you call " IdentifyAs() " for request the contact is always anonymous.  Tracking of anonymous contacts is off by default.  Even if you call "IdentifyAs()" if you don't set facet values for the contact (like first name and email) the contact will still show up in your experience profile as "unknown" (because it has no facet data to display).  Enabled Anonymous contacts Notice in the picture I have two contacts marked in a red box. Those are my "known" contacts that I called "IdentifyAs"
1 comment
Read more

Uniting Testing Expression Predicate with Moq

By
I recently was setting up a repository in a project with an interface on all repositories that took a predicate. As part of this I needed to mock out this call so I could unit test my code. The vast majority of samples out there for mocking an expression predicate just is It.IsAny<> which is not very helpful as it does not test anything other then verify it got a predicate. What if you actually want to test that you got a certain predicate though? It is actually pretty easy to do but not very straight forward. Here is what you do for the It.IsAny<> approach in case someone is looking for that. this .bindingRepository.Setup(c => c.Get(It.IsAny<Expression<Func<UserBinding, bool >>>())) .Returns( new List<UserBinding>() { defaultBinding }.AsQueryable()); This example just says to always return a collection of UserBindings that contain “defaultBinding” (which is an object I setup previously). Here is what it looks like when you want to pass in an exp
2 comments
Read more

Password Management

By
The need to create, store and manage passwords is a huge responsibility in modern day life. So why is it that so many people do it so poorly? This is a loaded questions with answers ranging from people being uneducated, to lazy, to educated but not affective in their methods and many more. This blog is to help those (in some way even myself) around me strengthen their online security. Why does it matter? To answer this let's look at a few numbers. According to the US Department of Justice (DOJ)’s most recent study , 17.6 million people in the US experience some form of identity theft each year. Ok fine but that is identity theft that has nothing to do with password management. What is one way someone can start getting information about who you are? How do they get access to steal your money? From Cyber Security Ventures 2019 report : "Cybersecurity Ventures predicts that healthcare will suffer 2-3X more cyberattacks in 2019 than the average amount for other industries. W
Post a Comment
Read more

Advanced Item Cloning

By
Cloning in Sitecore can be extremely useful. It makes reusing of content items and updating of those items very easy. The default capabilities for item cloning can usually handle most needs. The default behavior does have one thing that can really trip you up. By default clone, child items stay linked to the source cloned item and are not reparented to their new cloned parent. The first thing to understand is there are configuration options for cloning that allow you to change how cloning works. The configuration files have them pretty well documented but if you don't know what you are looking for you may not know they are there. <setting name="ItemCloning.Enabled" value="true"/> Specifies whether the Item Cloning feature is enabled Default value on CM and Standalone servers: true. Default value on CD, Processing and Reporting servers: false. <setting name="ItemCloning.NonInheritedFields" value=""/> Specifies a pipe-separated lis
1 comment
Read more