Integrations
Free trial

Rollbar - Notify Deployment

Octopus.Script exported 2017-02-07 by sandord belongs to ‘Rollbar’ category.

Posts a deployment notification to Rollbar.

Parameters

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

Access Token

AccessToken =

Your project access token. Required.

Environment

Environment

Name of the environment being deployed, e.g. “production”. Required.

Revision

Revision

Revision number/sha being deployed. If using git, use the full sha. Required unless using Revision Filename.

Revision Filename

RevisionFilename

Name of a file to read revision number/sha being deployed from. If using git, use the full sha. Required unless using Revision.

Local Username

LocalUsername

User who deployed. Optional.

Rollbar Username

RollbarUsername

Rollbar username of the user who deployed. Optional.

Comment

Comment

Deploy comment (e.g. what is being deployed). Optional. Will be rendered as Rollbar-flavored Markdown.

URI

URI = https://api.rollbar.com/api/1/deploy/

Specifies the Rollbar API deploy endpoint.

Script body

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

try {
    $uri = $OctopusParameters["URI"];    
    $accessToken = $OctopusParameters["AccessToken"];
    $environment = $OctopusParameters["Environment"];
    $revision = $OctopusParameters["Revision"];
    $revisionFilename = $OctopusParameters["RevisionFilename"];
    $localUsername = $OctopusParameters["LocalUsername"];
    $rollbarUsername = $OctopusParameters["RollbarUsername"];
    $comment = $OctopusParameters["Comment"];
    
    if ($revisionFilename) {
        $revision = Get-Content $revisionFilename;
    }
    
    $arguments = "access_token=$accessToken&environment=$environment&revision=$revision&local_username=$localUsername&rollbar_username=$rollbarUsername&comment=$comment";
    
    Write-Host 'Notifying Deployment to Rollbar';
    Write-Host $arguments;
    
    (new-object net.webclient).UploadString($uri, $arguments);
    
} catch {
    $ErrorMessage = $_.Exception.Message;
    Write-Error $ErrorMessage;
}

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": "2b204b54-165f-4c5b-a856-ac932dfa979e",
  "Name": "Rollbar - Notify Deployment",
  "Description": "Posts a deployment notification to Rollbar.",
  "Version": 2,
  "ExportedAt": "2017-02-07T13:42:26.852Z",
  "ActionType": "Octopus.Script",
  "Author": "sandord",
  "Parameters": [
    {
      "Id": "8ad2b4ef-72c2-491a-8cc9-8034144f6580",
      "Name": "AccessToken",
      "Label": "Access Token",
      "HelpText": "Your project access token. Required.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      },
      "Links": {}
    },
    {
      "Id": "2252ae4e-d664-4b92-af45-1f8e4049afb1",
      "Name": "Environment",
      "Label": "Environment",
      "HelpText": "Name of the environment being deployed, e.g. \"production\". Required.",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      },
      "Links": {}
    },
    {
      "Id": "47651ca8-9d07-4981-8aa6-c2ccee241bc9",
      "Name": "Revision",
      "Label": "Revision",
      "HelpText": "Revision number/sha being deployed. If using git, use the full sha. Required unless using Revision Filename.",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      },
      "Links": {}
    },
    {
      "Id": "f8b27505-bac6-4690-b1f8-d171a3bc399a",
      "Name": "RevisionFilename",
      "Label": "Revision Filename",
      "HelpText": "Name of a file to read revision number/sha being deployed from. If using git, use the full sha. Required unless using Revision.",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      },
      "Links": {}
    },
    {
      "Id": "2b5926f9-dde9-4abf-97e4-1e71e54ed19d",
      "Name": "LocalUsername",
      "Label": "Local Username",
      "HelpText": "User who deployed. Optional.",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      },
      "Links": {}
    },
    {
      "Id": "5e2656b6-8d61-4813-83d0-cd3d3ff2e559",
      "Name": "RollbarUsername",
      "Label": "Rollbar Username",
      "HelpText": "Rollbar username of the user who deployed. Optional.",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      },
      "Links": {}
    },
    {
      "Id": "81203f12-0c6e-4771-a205-ea9c69a6a3a3",
      "Name": "Comment",
      "Label": "Comment",
      "HelpText": "Deploy comment (e.g. what is being deployed). Optional. Will be rendered as Rollbar-flavored Markdown.",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      },
      "Links": {}
    },
    {
      "Id": "03fcb027-dd94-49c0-9cb4-8b93771118cd",
      "Name": "URI",
      "Label": "URI",
      "HelpText": "Specifies the Rollbar API deploy endpoint.",
      "DefaultValue": "https://api.rollbar.com/api/1/deploy/",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      },
      "Links": {}
    }
  ],
  "Properties": {
    "Octopus.Action.Script.ScriptBody": "try {\r    $uri = $OctopusParameters[\"URI\"];    \r    $accessToken = $OctopusParameters[\"AccessToken\"];\r    $environment = $OctopusParameters[\"Environment\"];\r    $revision = $OctopusParameters[\"Revision\"];\r    $revisionFilename = $OctopusParameters[\"RevisionFilename\"];\r    $localUsername = $OctopusParameters[\"LocalUsername\"];\r    $rollbarUsername = $OctopusParameters[\"RollbarUsername\"];\r    $comment = $OctopusParameters[\"Comment\"];\r    \r    if ($revisionFilename) {\r        $revision = Get-Content $revisionFilename;\r    }\r    \r    $arguments = \"access_token=$accessToken&environment=$environment&revision=$revision&local_username=$localUsername&rollbar_username=$rollbarUsername&comment=$comment\";\r    \r    Write-Host 'Notifying Deployment to Rollbar';\r    Write-Host $arguments;\r    \r    (new-object net.webclient).UploadString($uri, $arguments);\r    \r} catch {\r    $ErrorMessage = $_.Exception.Message;\r    Write-Error $ErrorMessage;\r}\r",
    "Octopus.Action.Script.Syntax": "PowerShell",
    "Octopus.Action.Script.ScriptSource": "Inline",
    "Octopus.Action.RunOnServer": "false",
    "Octopus.Action.Script.ScriptFileName": null,
    "Octopus.Action.Package.FeedId": null,
    "Octopus.Action.Package.PackageId": null
  },
  "Category": "Rollbar",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/75443764cd38076d/step-templates/rollbar-notify-deployment.json",
  "Website": "/step-templates/2b204b54-165f-4c5b-a856-ac932dfa979e",
  "Logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOwgAADsIBFShKgAAAABl0RVh0U29mdHdhcmUAcGFpbnQubmV0IDQuMC4xMzQDW3oAAAznSURBVHhe7Z0/rBxXFcbd0NHQpLGBdFQ4EQj8no0Ehfdt8aRQWLvPQRSpSNwguaUykquUeU6BUDookaCKbEjcU4GEeCYIpXMBTYRkOxTRMt/MnXjevrMze3bnzp0/v0/6KfEk3r0z737v3nPuuXcurVYrANiAeREAChBCCCGEEEIIIYQQQgghhBBCCCGEEEIIIYQQQgghhBBCCCGEEEIIIYQQQgghhBBCCCGEEEKd69r85NXrR8tbh0fLdzP+cDBb/u1wtvhUHMwWfz6YnXxwOL99/N2f/eor4a8gNG7JFFmn/3lmgseZOT67Pj9ZldzIyK5/oX9Wr+v//f7R8rXwEQiNSz9cLL6qkeBwvvztuim2Jvt7N24uD8JHIjRsaVqkDn04W55qymR2eif6nB8c/+Rr4SsQGp6uzxffOri5+IViCKuT70tmuPvhqxAahg6OF5evzRdvHRwtHh4cLT+3OnZbZJ//lFEE9V6txBW7crS8FZqBUH/0ZVyhtGxLccUuKP0bmoRQesWOK7yoHaFpCKVRl3GFF+IQlERJ4woHWkzUqBaajVA8xViv6IIb85MfhVtAqH2pdKNPcYUbMlmobR3OfvrKtaOTO32MK7woPgq3hdDuUjCr37Z9jyu8qOAx3CJCPg01rvCAQZBbiiuy4PXeYOMKBxgEbaUxxRUeMAjaKK1XjDGu8IBB0AWNPa7wgEFQrr7VQfUFDDJh5XFFT+ug+gIGmZjKOiiVcqsYz+oU8BIMMhEpNattpDryxuoIYINBRiwdfaPUbBZsPy4qU+1OAJvBICMTqdl2wSAjUR+2qI4RDDJglacHkpqNBwYZmJhCdQsGGYjyLBRTqM7BID1WfqABWaikYJCeSXssDubLm1rIYwqVHgzSE6kWqthjwUJen8AgCaVtqofzxZt6qcvhbPnM+gFBWjBIArFmMRwwSEcqd+Qp4LZ+ENBPMEhk6eAxbT6icnY/FJuFCuROy/IxSASV6VlWuPdDv1S0IJp10vwFm3quXcdqGKRFabQgPbsfMoA2cGkjl6al4dHmync9MoIMS/oh6iEyWuyHnp+2/NYdFo1BBqSwAYnYYg+UxVM2T1m98FhrhUEGoOyBHRfrFpR+7EQ2/SzjChVehse6lTBIT6UfZH64AdOonVCnLuMKBdrhsbqFQXqm3Bh5Noryj13YJq7wCIP0RBhjd7xxhUcYpAdSbRTGcLJHXOERBkmoYsWbMpBtaSuuOKc//usbWhAMf7ogDJJA2tedL+4ZDwfOk/0SKUo+WowrZIpLH37yzqWHTx5devSPMwzSI+VxBusYjeRxxWx5qlG2rgNvq/wzHp29kZniNDPFfzNWAQzSBxUPevHQeiAQCHFF9s9bbcQVecfXaFGY4qxiiioYJLU0alArZaPFT8Vh6hSaeoZHtp/OT6EsU1TBIKlU1ExlvxGNhzB1FFdkU6j7Kp8Jj2s/yRTFFEqmqE6hmsAgKRQyVOzeq6DYS8mJrAO0kprNO7YdV3jAIF1LU6qu9xD0FXWuTaXkuyjvzM1xhQcM0qW0omvd9NTQFCobRe+pg4VHs598cYUHDNKFNGVQxa11w1OhnELpjK26TretdALLjnGFBwwSW3kwPtEV8ShTqJdxRRtTqCYwSEyp5GGKJeltTqHyDlpOoboxRRUMEkuTM0dYyGtrCvWl8hRttClUExgkhqZkDk0f8xKZtgoE14VBzjF4gyh4HLs5tIaT10JF2GNxQRjkHIM2SJ6tGmlAro6Q732fL97MM0h76uFfrr7y0ZOrdx6fvfY7/Xu4fFEY5ByDNsgYS0fKsg91hnCbO0ud7eMnr/9Ypvj471f/8/js9ZXAINszWIMUnci+qaGhlf5yR15dB9lWf/rnt7+j0aJqihJdwyDbM0iDaNph3czQaHPzUXUKtW6KKhjEx+AMoorTIZerv4wt2hktrClUHRjEx6AMUmSshnmgQvaDfVrUhu0/Wjz9zavf3DSFagKD+BiUQYa4dzw39Oz23X1LP5Sx844WFhjEx2AMMrS4Q8ZQTdS+ey3qAu5dwCA+BmEQrRoPIe7QqR9a1NNK9z7GUAcuRwurk+8DBvExCIMMonQ9M7AyUvss6mm02HcK1QQG8dF7gwxhalUsWO4WfKuzVtOzMc0hMIiPXhtEgW32QHp7bpWmU9nIcSs01y2NGLENsQ4G8dFzgyxPrUb3gfzAgz0zU0WcYXfkWGAQH701SP4u8T6+pCaLNZSdCs3cSxjkAhhkW/WxSlep29bOjsqEQS6AQbaR5vVWY1Oivd6eKdWz969878WDr78d/mgKg1wAgzRJD6hv5SSKN+p+cFVp/ePFe5d/+ez08v+en175fbhsCoNcAIM0KT8712hoKpQoCE1r1OfvXz5+/t6Vv2Yjx0pgEDcYpE767dun0UPFhaFpjSpHjdIcGGQnMEidlB2yGpmCbUcOVdbKCFVjYJCdwSCb1KfRQyvjoVm1UiBenVKtg0HcYJBN6svoofTyNoWGijdePLjyb8sYJRjEDQaxpIfSh6N7VDqyzXlTMsd6vGGBQdxgEEtZI46txnWJHrzeIxKatFHbmkNgEDcYxFIvytlnt++G5myUxxwCg7jBIOtS6UbXN72OVslDczaqWBmvjznWwSBuMMi6ioMM7MZ1Ql58WP/CSnWoumzVJjCIGwxSVZ7aTbzfQyv3oTkbpY5uGaAJDOIGg1SVeregUrqhKRuVdfS31zv+tmAQNxikqpQv89eDbipdV9zhCcrXwSBuMEipFDdbZZtSkl3ijioYxA0GKVWcSWs3Kjo6gaRhQTDr4DtPrUowiBsMIukhpKy7kjlDU0ypANGb0rXAIG4wiJRyv3n2gJ82nV31/MHlX1sd3gsGcYNBpJRrH02jx76BeRUM4gaDpJxeafRo2leuTm119l3AIG4wiKZXVkO6oGmHYDhowezsu4BB3GCQ4oX3dmNiotecNZWUtDl6CAziBoOk2vfRtEuwzdijBIO4mbZBUtxgycF8eTM0w1RbmasqGMTNtA2S6kgfJQXqHnxb6x7rYBA30zZIqo1RTandrDPvvWpugUHcTNcg+Qs4E5S2Fw9087s79APZt+ZqExjEzXQNohjAakBsmnYLtp3arYJB3EzXIIez5X2rAbFp2hAVIzgvwSBupmyQ7l9n0LT2kR80HSE4L8EgbqZpEJWWq7NaDYhJ0/SqOPzN7txtgEHcTNMgqd730XRzMadXAoO4megIMjv5wPrymBQPsj57FXN6JTCIm+kZRDeconq3aXEwZvaqBIO4mZ5BdDBCis1RTZW7ep+H1anbBIO4mZ5B9AXWF8cm+97j0ARTsRYHq2AQNxM0SIrykqPlZ3Ubo1R71XblrgUGcTMtg6i8RJ3V+uKYpE7vlmAQN9MyiKY51pfGpqk4MXZ6twSDuJmYQWbLU+tLY6NtvaEJF6QfQBfxh8AgbqZlkBS7B/WWqLpXqMXYObgJDOJmOgZJcTOiaWtt1nGj7P2wwCBupmOQVLsHG6t3s05rdeYYYBA30zFIivRu8fA2l5eoY8QuL6mCQdxMwyDJdg/2oLykCgZxMw2DZB+aJL2rrFlogqkuykuqYBA3EzFIovSuyupDE0x1GX8IDOJm/AbRDaao3tWGrLp3fsQ62qcODOJm/AbRTSSp3m1432BX5SVVMIib8RtEH2h9UWyyEeR+aIKprspLqmAQNxMwSKrD4ZqOFu2ovKQKBnEzboOkq96tf2tUV+Xt62AQN+M2SPZhadK72agVmmAq66ydlZdUwSBuRm6QVOnd2e27oQmm1FGtDhwbDOJmvAbRjaVJ7y6+aCpv7zq9W4JB3IzXIMkOZ5gtPq17qF2Xl1TBIG7GaxB9kPUFsWksb++4vKQKBnEzYoMkSu9emy/eCk0wlSr+EBjEzTgN0td3f6QoL6mCQdyM0yDZh6Q5nKGhvD1FeUkVDOJmpAY5Wr5rfXhs+lbevg4GcTNOg6R6tXNjeXuC8pIqGMTN+AySotFim/L2FOUlVTCIm/EZRFkk64Nj01TennXQJOUlVTCIm/EZROsQ1gfHpo/l7etgEDfjMogOaMsa3Hl6V9SVt+shp44/BAZxMy6DqAbK+tDYyJR15e0py0uqYBA3IzPI/OSe9aGxaSxvT5zeLemjQcQWBrE6bxeMyyDJ0rsN5e1hgVBBelLUjtAkU8q0ffTk6p2u2dQJdT3/bx9+8k4SHp29EZpiSgYx+0NMGvparZTBksN03GcX6LtEXXoXDVOlOTeZV9K0uuwH630jBvoeVamHr0cIIYQQQgghhNAgtFqtAGAD5kUAKDAvAkCBeREACsyLAFBgXgSAAvMiABSYFwGgwLwIAAXmRQAoMC8CQIF5EQAKzIsAUGBeBIAC8yIAFJgXAaDAvAgABeZFACgwLwJAgXkRAMTq0v8BWqOJzntv4GIAAAAASUVORK5CYII=",
  "$Meta": {
    "Type": "ActionTemplate"
  }
}

History

Page updated on Tuesday, February 7, 2017