XM Cloud - Sitecore CLI Deployment Status

Jared Arnofsky,•XM CloudPowerShellAzure DevOps
Back

Summary

In a previous blog post (opens in a new tab) I discussed how we leveraged the Sitecore CLI to deploy to XM Cloud.

Our old solution was as follows:

#dotnet tool restore --add-source https://sitecore.myget.org/F/sc-packages/api/v3/index.json
#dotnet sitecore cloud login --client-credentials --client-id $env:XMCloud_ClientID --client-secret $env:XMCloud_ClientSecret
#dotnet sitecore cloud deployment create --working-dir . --upload --environment-id $env:XMCloud_EnvironmentID

While this is a nice approach, and fairly straightforward, we wanted more reporting on the build status. If there is an error we want to know about it. In our previous approach a deployment could still fail in XM Cloud, but it could appear as if it was successful from the Azure DevOps pipeline.

The Solution

Leveraging the Sitecore CLI Deploy documentation (opens in a new tab) we can find additional commands and options to add to our script.

The first part of our solution was to learn to get a response back from the CLI that we could parse. We learned that adding the --json option to the end of a command will return a json response from the CLI. We added that to our deployment create command. Once we return JSON we could see the object and details of our response:

JSON Object

The next step was to make it so the deployment create command would run and not make us wait for it to finish. This is important as we needed to check the status actively while it was running. Using the --no-watch option let us accomplish this.

The last step was to use the deployment info command so that we could query the status of the deploy and get our information. Combining all of these new elements into one new script allowed us deploy to sitecore, while actively checking our status and reporting back in our pipeline any errors.

Additionally, we added some safeguards to handle malformed JSON (just in case) and a function to translate the Status returned from Sitecore's CLI.

The final code was:

function Get-Status {
    param ($Status)

    $fromattedStatus

    switch ($Status) {
        0 {$fromattedStatus = "Not Started"}
        1 {$fromattedStatus = "In Progress"}
        2 {$fromattedStatus = "Complete"}
        3 {$fromattedStatus = "Error"}
    }

    return $fromattedStatus
}

dotnet tool restore --add-source https://sitecore.myget.org/F/sc-packages/api/v3/index.json
dotnet sitecore cloud login --client-credentials --client-id $env:XMCloud_ClientID --client-secret $env:XMCloud_ClientSecret
$deployment = (dotnet sitecore cloud deployment create --working-dir . --upload --environment-id $env:XMCloud_EnvironmentID --no-watch --json) | Out-String

#Wrap the deployment json just in case it is malformed
$deploymentFormatted = "[$deployment]"

$deploymentFormattedJson = $deploymentFormatted | ConvertFrom-Json

$deploymentId = $deploymentFormattedJson.id
Write-Host "Deployment Id: $deploymentId"

$deploymentStart = dotnet sitecore cloud deployment start --deployment-id $deploymentId --no-watch

Do {
    $deployInfo = (dotnet sitecore cloud deployment info --deployment-id $deploymentId --json) | Out-String

    #Wrap the deploy info json just in case it is malformed
    $deployInfoFormatted = "[$deployInfo]"
    $deployInfoFormattedJson = $deployInfoFormatted | ConvertFrom-Json

    Write-Host "Deployment In Progress - Status: $((Get-Status -Status $deployInfoFormattedJson.calculatedStatus))"
    Start-Sleep 10
} While (($deployInfoFormattedJson.calculatedStatus -ne 2) -and ($deployInfoFormattedJson.calculatedStatus -ne 3))

Write-Host "Deployment Complete - Status: $((Get-Status -Status $deployInfoFormattedJson.calculatedStatus))"

if($deployInfoFormattedJson.postActionStatus -eq 3){
    Write-Host "Post Action Error: $($deployInfoFormattedJson.postActionLastFailureMessage)"
}

if($deployInfoFormattedJson.calculatedStatus -eq 3){

    if($deployInfoFormattedJson.provisioningStatus -eq 3){
        Write-Host "Provision Error: $($deployInfoFormattedJson.provisioningLastFailureMessage)"
    }

    if($deployInfoFormattedJson.deploymentStatus -eq 3){
        Write-Host "Deployment Error: $($deployInfoFormattedJson.deploymentLastFailureMessage)"
    }

    throw "Error - Deployment Failed"
}

Conclusion

Leveraging the Sitecore CLI Deploy commands we were able to modify our deployment to Sitecore XM Cloud to better fit our needs and development approach. Being notified when something is not going as expected is key to running a smooth development schedule and timeline. Sitecore makes it easy for us to customize and create our own workflows with their flexible CLI tools.