Deploy CMS Data

Deploy CMS Data is a component that you can use for your Umbraco application which allows you to build migrations that deploy CMS updates.

The updates are run on startup, and the status is saved to the database so that once they are run successfully, they are never run again.

This project is working but is still under active development so please raise any issues or feedback so I can improve it.

---

Versions

DeployCmsData.UmbracoCms Version	Umbraco Version	Status
7.13.0.5	7.13.0	Published to Nuget
7.6.0.8	7.6.0	Published to Nuget
7.4.0.5	7.4.0	Published to Nuget
8.0.0.7	8.0.0	Work in progress

---

Creating an Upgrade script

Install from Nuget

PM> Install-Package DeployCmsData.UmbracoCms

Then create a new class that implements IUpgradeScript:

using DeployCmsData.Core.Interfaces;

public class Script01 : IUpgradeScript
{
    public bool RunScript()
    {                
        return true;
    }
}

Naming of upgrade scripts

The scripts are run on startup in name order. So you will need to make sure you name them correctly so that they are run in the correct order.

The easiest way is to use the same name with a numeric value postfix.

Example: Script0010.cs, Script00020.cs, Script00010.cs ...

---

RunScriptEveryTime Attributes

The script is only ever run once, so during development you might want to add the following attribute so that the script is run every time on startup, even if it's already been run.

[RunScriptEveryTime]
public class Script01 : IUpgradeScript

---

DeployCmsData Builders

Within the RunScript method in the upgrade script we can use builders to manipulate the CMS data.

Document Type Folder Builder

To create new folders to structure your document types:

new DocumentTypeFolderBuilder("Compositions")
    .BuildAtRoot();

new DocumentTypeFolderBuilder("Composition Sub-Section")
    .BuildWithParentFolder("Compositions");

Document Type Builder

The basic command to create a new document type is:

new DocumentTypeBuilder("contentBase")
    .BuildAtRoot();

To specify a name, icon and folder:

new DocumentTypeBuilder("pageMetaData")
                .Name("Page Meta Data")
                .Icon(Icons.MindMap)
                .BuildInFolder("Compositions");

To update an existing document type:

new DocumentTypeBuilder("pageMetaData")                
                .Icon(Icons.MindMap)
                .Update();

To allow the doctype as root content:

new DocumentTypeBuilder("pageMetaData")                
                .AllowedAsRoot()
                .Update();

To add fields to the document type:

 var builder = new DocumentTypeBuilder("contentBase");

builder
    .Name("Content Base")
    .Icon(Icons.Document);

builder.AddField("pageDescription"); 
// The default data type is text string and the name is generated from the alias - so in this case the name will be Page Description

builder.AddField("pageTitle")
    .Description("The title of the page, this is also the first text in a google search result. The ideal length is between 40 and 60 characters")
    .IsMandatory()
    .Tab("Content");

builder.AddField("bodyText")
    .Name("Content")
    .DataType(DataType.RichTextEditor)
    .Tab("Content");

builder.BuildInFolder("Compositions");

To update existing properties/fields:

var builder = new DocumentTypeBuilder("pageMetaData");

// AddField() can be used to add new fields or update existing ones
// Just set the things that need changing
builder.AddField("pageTitle")
    .DataType(DataType.TextArea)
    .Tab("Meta Data");
    
builder.Update();

To add existing document types as compositions to the document type:

var builder = new DocumentTypeBuilder("homePage");

builder
    .Name("Home Page")
    .Icon(Icons.Home)
    .AddComposition("pageMetaData")
    .AddComposition("contentBase")
    .AddComposition("navigationBase");

builder.AddField("mainContent")
    .DataType(LocalDataTypes.Grid)
    .Tab("Content");

builder.BuildInFolder("Pages");

---

MultiNode TreePicker Builder

To create a new MultiNode TreePicker data type:

var myDataTypeid = Guid.Parse("{60FFCA99-3B98-49EA-9F64-E4C69BB00285}");

new MultiNodeTreePickerBuilder(LocalDataTypes.MultiNodeTreePicker)
    .Name("Multi Node Tree Picker")
    .ShowOpenButton()
    .Build();

And with more options:

var myDataTypeid = Guid.Parse("{60FFCA99-3B98-49EA-9F64-E4C69BB00285}");

new MultiNodeTreePickerBuilder(myDataTypeid)
    .Name("Another Multi Node Tree Picker")
    .AllowItemsOfType("type1", "type2")
    .MinimumNumberOfItems(1)
    .MaximumNumberOfItems(5)
    .ShowOpenButton()
    .Build();

---

Grid DataType Builder

To create a new grid data type:

new GridDataTypeBuilder(LocalDataTypes.Grid)
    .Name("Default Grid View")
    .Columns(12)
    .AddLayout("1 column layout", 12)
    .AddLayout("2 column layout", 4, 8)
    .AddLayout("3 column layout", 4, 4, 4)
    .AddLayout("4 column layout", 3, 3, 3, 3)
    .AddRow("1 column", 12)
    .AddRow("2 columns", 6, 6)
    .AddRow("2 columns (left)", 4, 8)
    .AddRow("2 columns (right)", 8, 4)
    .AddRow("3 columns", 4, 4, 4)
    .AddRow("4 columns", 3, 3, 3, 3)
    .AddStandardToolBar()
    .Build();

---

Template Builder

To add existing views:

new TemplateBuilder("Master") // The alias must match the view name (master.cshtml)
    .Build();

And to specify a master template:

var homeTemplate = new TemplateBuilder("Home")
    .WithMasterTemplate("Master")
    .Build();