1. honeybadger-io/deploy@1.1.2

honeybadger-io/deploy@1.1.2

Partner
Sections
Send deployment notifications to the Honeybadger API
Created: November 7, 2018Version Published: March 9, 2020Releases: 4
Org Usage:
< 25

Orb Quick Start Guide

Use CircleCI version 2.1 at the top of your .circleci/config.yml file.

1 version: 2.1

Add the orbs stanza below your version, invoking the orb:

1 2 orbs: deploy: honeybadger-io/deploy@1.1.2

Use deploy elements in your existing workflows and jobs.

Opt-in to use of uncertified orbs on your organization’s Security settings page.

Commands

notify_deploy

Notify Honeybadger of a deployment. The environment variable `HONEYBADGER_API_KEY` must be set if the `api_key` parameter is not provided.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
api_key
The Honeybadger project API key.
No
$HONEYBADGER_API_KEY
string
environment
The deployment environment. Defaults to production.
No
production
string
repository
The URL to a repository, like git@github.com:user/repo.git.
No
$CIRCLE_REPOSITORY_URL
string
revision
The revision being deployed.
No
$CIRCLE_SHA1
string
username
The user who triggered the deployment.
No
$CIRCLE_USERNAME
string

upload_sourcemap

Upload a sourcemap to Honeybadger. The environment variable `HONEYBADGER_API_KEY` must be set if the `api_key` parameter is not provided. See https://docs.honeybadger.io/api/source-maps.html for more info

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
api_key
The Honeybadger project API key.
No
$HONEYBADGER_API_KEY
string
revision
The revision being deployed.
No
$CIRCLE_SHA1
string
minified_url
The URL of the minified file on your server.
Yes
-
string
minified_file
The local path of the unminified javascript file.
Yes
-
string
source_map
The local path of the source map.
Yes
-
string
additional_source_files
One or more additional source files which may be referenced by your source map. The name should be the URL that would normally be used to access the file, and the value should be the file itself.
No
''
string

Orb Source

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 # This code is licensed from CircleCI to the user under the MIT license. # See here for details: https://circleci.com/developer/orbs/licensing version: 2.1 description: > Send deployment notifications to the Honeybadger API display: home_url: https://www.honeybadger.io/ source_url: https://github.com/honeybadger-io/circleci-orb commands: notify_deploy: description: | Notify Honeybadger of a deployment. The environment variable `HONEYBADGER_API_KEY` must be set if the `api_key` parameter is not provided. parameters: api_key: type: string default: $HONEYBADGER_API_KEY description: The Honeybadger project API key. environment: type: string default: production description: The deployment environment. Defaults to production. repository: type: string default: $CIRCLE_REPOSITORY_URL description: The URL to a repository, like git@github.com:user/repo.git. revision: type: string default: $CIRCLE_SHA1 description: The revision being deployed. username: type: string default: $CIRCLE_USERNAME description: The user who triggered the deployment. steps: - run: name: Notify Honeybadger command: | curl --data "deploy[environment]=<< parameters.environment >>&deploy[local_username]=<< parameters.username >>&deploy[revision]=<< parameters.revision >>&deploy[repository]=<< parameters.repository >>&api_key=<< parameters.api_key >>" "https://api.honeybadger.io/v1/deploys" upload_sourcemap: description: | Upload a sourcemap to Honeybadger. The environment variable `HONEYBADGER_API_KEY` must be set if the `api_key` parameter is not provided. See https://docs.honeybadger.io/api/source-maps.html for more info parameters: api_key: type: string default: $HONEYBADGER_API_KEY description: The Honeybadger project API key. revision: type: string default: $CIRCLE_SHA1 description: The revision being deployed. minified_url: type: string description: The URL of the minified file on your server. minified_file: type: string description: The local path of the unminified javascript file. source_map: type: string description: The local path of the source map. additional_source_files: type: string default: "" description: | One or more additional source files which may be referenced by your source map. The name should be the URL that would normally be used to access the file, and the value should be the file itself. steps: - run: name: Upload Sourcemap command: | if [ "<< parameters.additional_source_files >>" != "" ]; then for file in << parameters.additional_source_files >>; do JS_FILES="$JS_FILES -F $file=@$file" done fi curl https://api.honeybadger.io/v1/source_maps \ -F api_key=<< parameters.api_key >> \ -F revision=<< parameters.revision >> \ -F minified_url=<< parameters.minified_url >> \ -F minified_file=@<< parameters.minified_file >> \ -F source_map=@<< parameters.source_map >> \ $JS_FILES
Developer Updates
Get tips to optimize your builds
Or join our research panel and give feedback
By submitting this form, you are agreeing to ourTerms of UseandPrivacy Policy.