> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# honeybadger-io/deploy

Send deployment notifications to the Honeybadger API


## 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.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `api_key` | string | $HONEYBADGER_API_KEY | The Honeybadger project API key. |
| `environment` | string | production | The deployment environment. Defaults to production. |
| `repository` | string | $CIRCLE_REPOSITORY_URL | The URL to a repository, like git@github.com:user/repo.git. |
| `revision` | string | $CIRCLE_SHA1 | The revision being deployed. |
| `username` | string | $CIRCLE_USERNAME | The user who triggered the deployment. |

### 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


| Parameter | Type | Default | Description |
|---|---|---|---|
| `api_key` | string | $HONEYBADGER_API_KEY | The Honeybadger project API key. |
| `revision` | string | $CIRCLE_SHA1 | The revision being deployed. |
| `minified_url` | string |  | The URL of the minified file on your server. |
| `minified_file` | string |  | The local path of the unminified javascript file. |
| `source_map` | string |  | The local path of the source map. |
| `additional_source_files` | string |  | 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.
 |