Octopus Deploy – How to handle deployment errors and script failure response.

Each of your scripts will be bootstrapped by the open-source Calamari project to provide access to variables and helper functions. You can see how your scripts are bootstrapped in the Calamari source code.

https://github.com/OctopusDeploy/Calamari

https://github.com/OctopusDeploy/Calamari/blob/master/source/Calamari.Shared/Integration/Scripting

Octopus Deploy supports the following scripts:

PowerShell scripts (.ps1)
C# scripts (.csx) using ScriptCS
Bash scripts (.sh)
F# scripts (.fsx)
Python scripts (.py)

When Calamari executes your scripts, it does so within the context of the working directory by default: C:\Octopus\Work\

Calamari examines the exit code of the script engine to determine whether the script failed. If the exit code is zero, Calamari assumes the script ran successfully. If the exit code is non-zero, then Calamari assumes the script failed.

Syntax errors and unhandled exceptions will result in a non-zero exit code from the script engine, which will fail the deployment

Error Handling in PowerShell Scripts – For PowerShell scripts Calamari also sets the $ErrorActionPreference to Stop before invoking your script. This means that if a command fails, the rest of the script won’t be executed. At the end of the script, Calamari also checks $LastExitCode to see if the last Windows-based program that you invoked exited successfully.

Note that you’ll need to check $LastExitCode yourself if you run multiple Windows programs. For example, with this script, Calamari would correctly see that ping returned an exit code of 1 (the host couldn’t be contacted) and will assume the script failed:

• https://octopus.com/docs/deployment-examples/custom-scripts/error-handling
• https://octopus.com/docs/deployment-examples/custom-scripts
• https://octopus.com/docs/deployment-examples/custom-scripts/debugging-powershell-scripts

«

Prev

1

/

1

Next

»

Udeploy Tutorial for Beginners, Fundamental to Advance-Part 1/3

Udeploy Tutorial for Beginners, Fundamental to Advance-Part 2/3

Udeploy Tutorial for Beginners, Fundamental to Advance-Part 3/3

«

Prev

1

/

1

Next

»

• Author
• Recent Posts

Follow me

Rajesh Kumar

Mentor for DevOps - DevSecOps - SRE - Cloud - Container & Micorservices at Software AG

Join my following certification courses...
- DevOps Certified Professionals (DCP)
- Site Reliability Engineering Certified Professionals (SRECP)
- Master in DevOps Engineering (MDE)
- DevSecOps Certified Professionals (DSOCP)
URL - https://www.devopsschool.com/certification/

My Linkedin - https://www.linkedin.com/in/rajeshkumarin

Follow me

Latest posts by Rajesh Kumar (see all)

• Installing Jupyter: Get up and running on your computer - November 2, 2024
• An Introduction of SymOps by SymOps.com - October 30, 2024
• Introduction to System Operations (SymOps) - October 30, 2024