Create and install a Sitecore Content Serialization package

Abstract

How to create and install a Sitecore Content Serialization (SCS) package in your continuous integration pipeline.

Sitecore Content Serialization (SCS) packages (file extension .itempackage) contain specified modules and all their serialized items. You use packages as build artifacts in your continuous integration pipeline by creating them in your build pipeline and installing them in your delivery pipeline.

Create an SCS package in your build pipeline

To create an SCS package in your build pipeline:

  1. Go to your project folder where your sitecore.json is located.

  2. To create the package, run the following command:

    sitecore ser pkg create -o <name of package>

    Note

    You can use the --include and --exclude arguments to specify what modules go into your package.

    By placing your demo or test content in a separate module, you can use these arguments to exclude it from deployment to upstream environments.

  3. Ensure the package file is present among your build artifacts.

Install an SCS package in your delivery pipeline

To install an SCS package in your delivery pipeline:

  1. Make sure that you have configured you Identity Server and Content Management roles for non-interactive client login.

  2. To install the package, run the following command:

    sitecore ser pkg install -f <name of package>.itempackage --client-id <your client id> --client-secret <your client secret> --cm <your content management host> --auth <your identity host>

    Note

    Your client secret is a password that provides administrative access to the Sitecore instance. Ensure you are properly protecting this password using proper security mechanisms in your build system.

    Use the sitecore ser pkg install --help command to see more arguments for the package install command.