Serialization Config Builder
Generate Sitecore serialization configuration for Unicorn or SCS item tracking.
{
"namespace": "MyProject",
"items": {
"includes": []
}
}How to Use the Sitecore Serialization Config Builder
The Sitecore Serialization Config Builder generates module.json files for Sitecore Content Serialization (SCS), the built-in serialization system introduced in Sitecore 10.1. These files define which Sitecore items are tracked, serialized to disk, and pushed or pulled as part of your DevOps pipeline.
Enter your module name and namespace, then add one or more includes. Each include specifies an item path in Sitecore, a scope defining how many items to include, and the allowed push operations controlling what changes are permitted during deployment.
Scope Options Explained
- SingleItem — Only serializes the exact item at the specified path. Useful for specific configuration items.
- ItemAndChildren — Serializes the root item and its immediate children. Good for templates with a known, shallow structure.
- ItemAndDescendants — Serializes the root item and all items beneath it recursively. The most common choice for templates and content folders.
- Ignored — Explicitly excludes an item path from serialization, useful for overriding a broader include rule.
Allowed Push Operations
- CreateOnly — Items are created if they do not exist but never modified or deleted. Safe for shared environments.
- CreateAndUpdate — Items are created or updated but never deleted. Recommended for most template includes.
- CreateUpdateAndDelete — Full synchronization: items are created, updated, and items in Sitecore that are not in source control are deleted. Use with caution in production.
Placing Your module.json
Place the generated module.json file in your module's root directory within your Sitecore solution. The SCS CLI (dotnet sitecore ser) will discover and process it automatically when you run serialization commands.