OpsLevel - Create Deploy Event - Bash

Octopus.Script exported 2021-06-27 by rocktavious belongs to ‘OpsLevel’ category.

Track deploys to your services across different environments in OpsLevel.

Parameters

When steps based on the template are included in a project’s deployment process, the parameters below can be set.

OpsLevel CLI Package

OL_PACKAGE =

The Package that contains the OpsLevel CLI

Service

OL_SERVICE = #{Octopus.Project.Name}

The service alias for the event

Description

OL_DESCRIPTION = #{Octopus.Release.Notes}

The description of the event

Environment

OL_ENVIRONMENT = #{Octopus.Environment.Name}

The environment for the event

Deploy Number

OL_DEPLOY_NUMBER = #{Octopus.Release.Number}

The deploy number of the event

Deploy URL

OL_DEPLOY_URL = #{Octopus.Web.ServerUri}#{Octopus.Web.DeploymentLink}

The deploy url of the event

Dedup Id

OL_DEDUP_ID = #{Octopus.Release.Id}

The dedup id for the event

Deployer Email

OL_DEPLOYER_EMAIL = #{Octopus.Deployment.CreatedBy.EmailAddress}

The email of the deployer who created the event

Deployer Name

OL_DEPLOYER_NAME = #{Octopus.Deployment.CreatedBy.Username}

The name of the deployer who created the event

Script body

Steps based on this template will execute the following Bash script.

if test -f "#{Octopus.Action.Package[OpsLevel].ExtractedPath}/opslevel"; then
	chmod +x #{Octopus.Action.Package[OpsLevel].ExtractedPath}/opslevel
	cat << EOF | #{Octopus.Action.Package[OpsLevel].ExtractedPath}/opslevel create deploy --log-level=WARN -i #{OL_INTEGRATION_URL} -f -
service: #{OL_SERVICE}
description: #{OL_DESCRIPTION}
environment: #{OL_ENVIRONMENT}
deploy-number: #{OL_DEPLOY_NUMBER}
deploy-url: #{OL_DEPLOY_URL}
dedup-id: #{OL_DEDUP_ID}
deployer:
  name: #{OL_DEPLOYER_NAME}
  email: #{OL_DEPLOYER_EMAIL}
#{if Octopus.Release.Package}
#{if Octopus.Release.Package[].Commits}
commit:
  sha: "#{Octopus.Release.Package[0].Commits[0].CommitId}"
  message: "#{Octopus.Release.Package[0].Commits[0].Comment}"
#{/if}
#{/if}
EOF
else
	echo "Please ensure the `opslevel` CLI package is setup and installed!"
fi

Provided under the Apache License version 2.0.

Report an issue

To use this template in Octopus Deploy, copy the JSON below and paste it into the Library → Step templates → Import dialog.

{
  "Id": "9a22df59-75ea-4867-852e-fddc0d65fa1a",
  "Name": "OpsLevel - Create Deploy Event - Bash",
  "Description": "Track deploys to your services across different environments in [OpsLevel](https://www.opslevel.com/docs/insights/deploys/).",
  "Version": 3,
  "ExportedAt": "2021-06-27T16:56:46.770Z",
  "ActionType": "Octopus.Script",
  "Author": "rocktavious",
  "Packages": [
    {
      "Name": "OpsLevel",
      "Id": "3f494661-a014-4602-9bb3-fd3b7dcc9cbe",
      "PackageId": null,
      "FeedId": null,
      "AcquisitionLocation": "Server",
      "Properties": {
        "Extract": "True",
        "SelectionMode": "deferred",
        "PackageParameterName": "OL_PACKAGE"
      }
    }
  ],
  "Parameters": [
    {
      "Id": "1f3a7c3e-246e-4767-b314-bfc46d77c9e7",
      "Name": "OL_PACKAGE",
      "Label": "OpsLevel CLI Package",
      "HelpText": "The Package that contains the OpsLevel CLI",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "Package"
      }
    },
    {
      "Id": "31ed8779-810d-43e0-a53c-90520b549dab",
      "Name": "OL_SERVICE",
      "Label": "Service",
      "HelpText": "The service alias for the event",
      "DefaultValue": "#{Octopus.Project.Name}",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "033217c3-d9fe-4bf3-a353-5d51768b77e5",
      "Name": "OL_DESCRIPTION",
      "Label": "Description",
      "HelpText": "The description of the event",
      "DefaultValue": "#{Octopus.Release.Notes}",
      "DisplaySettings": {
        "Octopus.ControlType": "MultiLineText"
      }
    },
    {
      "Id": "1cc660c8-bb22-4ff3-bc09-d7488cd6c24a",
      "Name": "OL_ENVIRONMENT",
      "Label": "Environment",
      "HelpText": "The environment for the event",
      "DefaultValue": "#{Octopus.Environment.Name}",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "c60fc4c7-b29c-4f0d-a7d3-691b0bad2a3e",
      "Name": "OL_DEPLOY_NUMBER",
      "Label": "Deploy Number",
      "HelpText": "The deploy number of the event",
      "DefaultValue": "#{Octopus.Release.Number}",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "304310bc-600d-435d-9481-7a71bac9fc24",
      "Name": "OL_DEPLOY_URL",
      "Label": "Deploy URL",
      "HelpText": "The deploy url of the event",
      "DefaultValue": "#{Octopus.Web.ServerUri}#{Octopus.Web.DeploymentLink}",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "53ee85df-3d25-4018-b3e2-0dd34eb721ea",
      "Name": "OL_DEDUP_ID",
      "Label": "Dedup Id",
      "HelpText": "The dedup id for the event",
      "DefaultValue": "#{Octopus.Release.Id}",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "536caa2b-36b3-4a6a-b1ed-245ddea9e647",
      "Name": "OL_DEPLOYER_EMAIL",
      "Label": "Deployer Email",
      "HelpText": "The email of the deployer who created the event",
      "DefaultValue": "#{Octopus.Deployment.CreatedBy.EmailAddress}",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "244d6d8f-a512-4211-8e9e-16ae7caca84a",
      "Name": "OL_DEPLOYER_NAME",
      "Label": "Deployer Name",
      "HelpText": "The name of the deployer who created the event",
      "DefaultValue": "#{Octopus.Deployment.CreatedBy.Username}",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    }
  ],
  "Properties": {
    "Octopus.Action.Script.ScriptSource": "Inline",
    "Octopus.Action.Script.Syntax": "Bash",
    "Octopus.Action.Script.ScriptBody": "if test -f \"#{Octopus.Action.Package[OpsLevel].ExtractedPath}/opslevel\"; then\n\tchmod +x #{Octopus.Action.Package[OpsLevel].ExtractedPath}/opslevel\n\tcat << EOF | #{Octopus.Action.Package[OpsLevel].ExtractedPath}/opslevel create deploy --log-level=WARN -i #{OL_INTEGRATION_URL} -f -\nservice: #{OL_SERVICE}\ndescription: #{OL_DESCRIPTION}\nenvironment: #{OL_ENVIRONMENT}\ndeploy-number: #{OL_DEPLOY_NUMBER}\ndeploy-url: #{OL_DEPLOY_URL}\ndedup-id: #{OL_DEDUP_ID}\ndeployer:\n  name: #{OL_DEPLOYER_NAME}\n  email: #{OL_DEPLOYER_EMAIL}\n#{if Octopus.Release.Package}\n#{if Octopus.Release.Package[].Commits}\ncommit:\n  sha: \"#{Octopus.Release.Package[0].Commits[0].CommitId}\"\n  message: \"#{Octopus.Release.Package[0].Commits[0].Comment}\"\n#{/if}\n#{/if}\nEOF\nelse\n\techo \"Please ensure the `opslevel` CLI package is setup and installed!\"\nfi"
  },
  "Category": "OpsLevel",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/75443764cd38076d/step-templates/opslevel-create-deploy-event-bash.json",
  "Website": "/step-templates/9a22df59-75ea-4867-852e-fddc0d65fa1a",
  "Logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAABKQSURBVHgB7Z1PkFTVFcbvpKzoRmblCodUhU2ApKILGdRSN6BYIZswiLoSgtkahK2ibsOILuO/caVBxBVWVNgIJTJkgVUyuklcDJJFWM1kE7PpvK/fu6Fpu2/fc9+79537+vtVTZVVznQ37/Z37znnnj8zvQJDCBlF7yeGEDIWCoQQBxQIIQ4oEEIcUCCEOKBACHFAgRDigAIhxAEFQogDCoQQBxQIIQ4oEEIcUCCEOKBACHFAgRDigAIhxAEFQogDCoQQBxQIIQ4oEEIcUCCKuLZuzAffGKKIGXY1aZ/1H4x58ytj3rhS/vfcBmOOzhvzxFZD2qVHgbTMxe+N+ePZ8vQYZvdmY155uBQMaQUKpC0gCAgDApnEs/cWP/dQKC1AgaRm2JzyhWZXK1AgKfnkH8a8eH60OeXLpkIoH+7laZIICiQFV28Yc+y8nznly/7iJDkyT6FEhgKJCUyo48uFSXXFRIFmV3QokFjAzzh+yd/P2HB76YgjcgVBffCt8QZm19t7jPnlXYY0CwXSNDCjFpdl5tSocC7MsoNnZP4Kza7GoUCaAifFC+dlN+HY8V8uhPHA3eN/5y/F67267C8UnER/uLcUCqkNBdIEODEkYVt8ieE74H7Dh9VCHIuXZGYX/ZNGoEDq4LoFHwf8jKM7SpFIgVBgdq3c8P8bml21oEBCkNyCWx7YWHxRd7jNKV+kZheAKCHOEGFOMRSIhJBbcKk5Jfksf75SCsUXml1iKBBfUptTvoT4JwgOvLOHZpcHFMgkQs2p1x5N+wUMMbvon0yEAnGB6BQu+3zBFw33GbjXaAt8XpiBviaghs+sGE65dXFyxe/3YEJhJz73dPtfNJh0Z4vP8cQWv9/HifPpd4aM4TZDarO0p5noVFMg9QQm3uzt5WlCwuEJ0gB7T8sd+Jh8XdyTLJymOJqAJ0hDnPymdOTbDKOu/VD6TbGyh6cRniANghPkueIk2b5UFkelBKcF3pfiaBaeIBGAUA6cSRNG/eL7MrzbZDEWuQlPkIjA7MKuvii47fZltTqt4GtQHPGgQAK4f6N/GBXgbgJCaaIp3HrlZ+x6z//1bBh67k5DhFAgAWyaNeb1Iox6+YAx2zyr+Kx/gohXaLQL5tTO92SVikh3+duBMlGSyKFAagDfApeDr+3y9zNgDuE0kYSFYU5BWAsCcSHd5fTe4pb8EWbw1oFOegPAGX98c5nl6+tv+ISFcUq88VWZjOgLLgeROsKM3WbgCdIQ/bT2HaXZJUnzsGHhq0NFUEg+vG9JJg74Gf33pzgagyfIGLB7r/3XiIGpBf8EJ4pvkzj8DpxunES7f17eaUgiUw8W5tSJGtnDa4IOj9MGs3lHMKllD77I8Du8XutK+Xox0lCQc3Vil18eGBZ5/p3ic/x79P9nMdVIejxBBggpipoEKgmR4XtcWNTkwvbQQveSphxwa+5dvM4akUF4ghh5UZTkBBl+nzphXvveIV/gSSfIMPCn4EtNuVCmux7EXrrhbiHFbTS+bHCiJWFhiw3bhvxtCDjxIOZpn3g1tScIwqyLy2G7eegJMgje134GF001fZCeIINMcUf56TtBcFJoqN/oO8VVWHicH4FTA7fgTXdEkYKLSunlZleYGic9dqf1UCCU2Z+OjpghpUXTLbi93LR+0DQwFScIwqz3CWolpi25T5J8iROkyeRL7XRaIDbv6cXP/ZP7YNYgv+roFCX3/axKvkSzB18/w4aFu252ddLECull5dNpvevgGcAnkvTYgtmFn64OGu2UQDS1Bs2ZJ7eWG4WkYyPMV5QZd+02vjMm1skquS+kVoLi+DGbqpyy5QNlfpgP1uyaX+qO2ZW9QAbDthI/A/Y2ayUmA6Es/bbM+fI1n7oUFs5WIBADsmX3CmqyscBo8nZ6gfP8pMDsgn+C6J7vpoJTHVkKMWryU5GlQPDAQ8K2GlqD5o60tWn//injsHBWTnpItu2oAZmkHtY/ge/mO2g012zhLATCsK1O6oaFD91Tik0z6k0slKJKsm03VDXZMANiiQOfJTfnE585pELSB/gnSGZEVNAXmMf7Thv1qBcIbFhtYdtrGUVpBjuirEcsrcVJgKigNCysnU7cg7QVtoWpoLVmwiZn4k4iZefFkLCwZrIWiIaw7WBnEi07YkhHlKYJCQtrJGuBoGgpZtgWJ5Ikea9ts+uL6tL0sODSFB1Rno+Yuo6w8CGBb6INNm1wAPHhR9KZxNZMwB9KlcISMhdE0hFlmmHjOA/wRUc9uKRmArf8KeaESOeC2EtTONMUx2QoEE9sQzjY1RKzC3NCYphdMKfQbE5S6wK/AFG+aap1qQsFIiSkM0mTc0JWK9EhbDvcrnQctiMKTComZ8qgDxLI/qpmwvonPiAnCWIJqZlgrUs78ASpwVx1OXY5oGbiwBl/s6vOXBCKox48QRpgrrock/TagvOOH3yBx6WA2FtwyUUfzCkMy6ED3gwUSIPA7MIPdnpff8MVfZIIg3NB4kATKwLSOSF14VyQePAEiYQNC/ebHyzHuV2vOxeETIYCicyg2YUOIU0Ihbfg6aCJlQiYXZLb+FHYW/CYtS7kViiQhITcxluQE2Y7PvKyLx0USAtIbuORxo+TB2n99DXSQx+kRext/KjxbLwF1wFPkJYZNLu2VUVfvAXXA08QJUAo8DGQgMimdnro/AmC22jfrFcN5CIOjHRDas1qxydOdfYEGZ4oFTodltwKhHHxWnH5edmYL78vfSWMo0bZ7ozpHp08QUZNlOpCn9i2WftPmYm88FEpDmBbi85XrUW7NhG2UyfIpNakdjFDazKmFcxBxqaDzWVcuv1ga1GcJto7JvrSCYHYGnDf+u9c+8SmxppTh8/5p8jY1qK2m0nul5pZC2S96uYhqbIbZHAxn+3AYjYFhHFtrTiNz900paTYkzr3abgzvV5PtdloB+TEpj+3nGZX38+AOYWfplqV4tmOOoHg1P/zOaOZHi8KK6zZBUe+y1Nbx4Fd8ovCnNr1vtvXGMQ3apXz8+y0QGxrUkkHkpUb3Rkf5svqWtXg+iO/fzOEgVqUz54uTaguhnctnTSx4EvAp0B8ftCvkJTCgq6bXdac8n0mEMLcrDGvPGTMYwMtXyEqPNtT38rCvHi968+pFlhPtUAgDiyetGnBa44qO7uYvuONAV4LGbVdiXb1b8FXjDl2wd/PmL2j2HR+XeaHjQtmIIp47Lzsdh0XuIrDwjoFkqLXbAcXcyLDt+A+YHfHM5WMM8C6vfWV/7PF6+LEP3SvutNEl0DwQfpHvqD/E7p5IN4e2k4zZDEPVY2pc7K9YU4h9eYtzyZ31pw6sTOsejHE7Or3GXu4NN+UPFsdAunvbMWO9tJ5/8RCPEDs6JhDWPf+Aou5WJldksXEe+/Ws5gj8bkFH8aaU0ca6OGLjQej1vCMfZ+topO6fYHgAR47L+uC3p9pEaE5GhZxId/FvAVrTr10oZ1NZ5iT1aBPiUkLq6DlJMj2BLJW9Zp984rMnDqSoMouZDGx22oIedpb8BcLYXzquen0/YxIm84g2HisSSs5qRFJ3Le1lWebXiDWnDosuGfAg4ETdyRhwwJ8treqxtSSxTxShYXbEErILTjMqaPbSwc5FX2r4fNCwN/5P1uYsi9X8+4TPtu0ApHOO0+1s7m4Vi3mJ8LFfD3xqIGv/2XM7z/WvekME3JSw3qAI5+ItAKRXPpp6zUrXUzcm6QU9Z8ulZ/Phwdb3nSGOV59dp8vYuL8LZ25WCg7XVbWaxbOK1IrtmVeLw5RnFrQ1XgOp9ip3xmVqBQIoi4YL3ZSSYVaP5GvGnm2klF9+yhwiiNSt7qu49nCb0KI/eDHRiVqkxWtv4IvZZuLuVqFfm34twtAJCiRRaCkraYLIdnDbaA+mxc7dhuLuVY1fcB7XwwsGtIOTmgIP2UtOd5Hmj3cJtmku9vFjG124bXfqEYr4+jvOrYOBhvB1zfiPluYU5jKO/9ueKViarKqB7FmV4zFtH4GRHjsc71HfizwbB99L85JjTgpyqK3v+ufC6YFNQI5IkjXaHoxYU5BeAuCeYCbNuRTb41wue+zxQm9q2qPVHcDsn7G3o/KdCLfKkWEofcriWCqEQjCjgjtShcTp8nxwMXE3+Bvt1c9nXyYzWxGR/9CsLhc+7CaTeJzC1231xV+f1QPrUmfc9Ns+Tk/LMLQG+80KlBnYtnF3L/FP6VgsVpMX//EmlPzS/6p9fgsT24tm0znOKPDNsm+dKDcgHyerfVP7Ent9Wx75TOFOXXKd9O5o9x0lp/Rt+mo9EGwmKgKXBYuJsykg2fcixkStsWRD9Ge2JV/ayA8TzxX/FukJ7WrwMyaU3DAJU0f+pvOM82k1sdAdV+suWoxJWkeg/PHUdhkvwSas4fbwM4msc/W53TAs8OzHcyuDemhpSHHzpcsGsdhMR/fXEZCpIuJLzh+/9XldIl8uVQa9lPJd9wcMupT/WfNLvhub/+mzMjVnj1ch2w6K/YnLlWL6Vv9Z80uX+zO9tIj0zWjY3Bkte9J3Y8kvm+8mZm5WaWYk5maXetR65/cf7c8VdoFRyvfOrIa9xVrDdwFhTR90ES2jeOwkPBPJPcno8gtbJsCnNR4Hk9sCTcXbwnbZtwyKfvOilhMaVgY4Hfh15zlaOWRWLMLz8c3kmixYduzT+W/6XSi9ehwWHgSv7qrFNU7HK08kW13+YeF/7/pPJWfrzGOTvXmtWFhVwoI/t9nNKfEwKQ95aiShDi6uOl0snm168tPYYSDE2THxvH/v4vPluMPaqChIo/EhQIhxAEFQogDCoQQBxQIIQ4oEEIcUCCEOKBACHFAgRDigAKpA28Ko6DpsaoRiGS8gAbQnACfOQc+UNLj2AdbwvvldaMCNQJBiaykM0lbDDYnyKEJGj7vYGcSzdiOKOjXq6XzoqqKQlsii5355YfrFUI1TUhzAk1g48EPal/2bdH3bDFP8fA5fb16VfogaLZgG8Jp2PVsi35NO9swvgVNKKdN3bB6HEGNrBN3xEgqEKRDSwZdLl5K07B6HHjPv/5d1qIfzQnwb0zd9AH1Gr4lsrYzyY6l9kZLhGw6qFR8fadJSvITBEc8ipr2b5E1hJtPuJh4D8z8w8520HPuX7+n7N1ld8A2qulsiaykIRyeZ+rREqGbDnpxocHcvsQ9e1vxQUI6k1yrFjP2XHLsbDDtfB1wCGNutvhi7tRRMBTSmQQnNJp2xxy3DGFcLTadYxeEDeZa7ojSqg8y2Jlk1nPHjTUnpD8XRNiiX3NzAmlnkphzQuxckEffD2hk3XJHFBVOul3MELOr7mLeMhdE0KI/h+YEIZ1JmhwtETIXRNumoyaKZc2ulIspnQsyuLPl1JxA0pnEUmdOSOhcEI2bjrowb53F9J0TEjQX5I5ydonGFv2+wKSNOSckdC6I5jZMM71eT+3FNU4I3z68Fjzg3ZvLm/lRwMFHk2bJhRT8I7S8Qeg2l8bULvAsT66UF3MSIDD87bhNBaZRxxpZ91QLxIIvM+Z+rEQeMjmJ2BG02GjJBqjbPT8heQjEIpkTEov+yICI4dBYwPTB7g6foi1ymgtSkZdAAI5vyZyQWEAob+/Rb3Zhda0w2pzcm9tckIr8BGIJ8U/GYXe2xzaX4UjJCaXV7LIJgIuX5ZOfQp6D6zUzMadGka9ALHXMLnsL/spD5ZfCYqctSV4TdznPz7d/mmAx1wtz6oUL/kM0x2UD4DmEntQdGUaUv0As0sXEkY+JR5g/OGpnwwnlO5bM0rZ/Yv0MaSSpyecwbtPJlO4IBPiYXdL8Hpwi+6qJuL4PCmFm1LPMbUgjlJB6Cnwuax76PAeUILim3IJJYsuQbgnEglvx4dv1ukmFIaZcbP+kjQmzuF8a9k80JBVGopsCsdjFREqJdRTrgN1ZMjYZxDK7QsK2TUWSBs0uTZnMEei2QAAWEzfhTR75of5JE2HhkLBtrAmzeA4dn9DVfYHEJKXZFRy27abpkwoKpAlG2eWT8A0LWz/j+OX6YVsihgJpihhh4RhhWyKCAmmakLDwoBkEodQJ2yK8TGE0BgUSi1D/ZN8vwtJDMkoAzAkKJCaxEyszTQDMCQokBSH+iYt+763t9DMSQIGkpG49C8O2yaFA2kAaFmbYtjUokLbwNbsYtm0VCqRtxoWFGbZVAQWiBeufQCgM26qBAtEEwsJXb1AYiqBACHHQ4xBPQhxQIIQ4oEAIcUCBEOKAAiHEAQVCiAMKhBAHFAghDigQQhxQIIQ4oEAIcUCBEOKAAiHEAQVCiAMKhBAHFAghDigQQhxQIIQ4oEAIcUCBEOKAAiHEAQVCiAMKhBAHFAghDm4zcWa7ENIFev8DV6DtMWQUqAIAAAAASUVORK5CYII=",
  "$Meta": {
    "Type": "ActionTemplate"
  }
}

History

Page updated on Sunday, June 27, 2021