Honeybadger CircleCI Orb

The Honeybadger CircleCI Orb is used to notify the Honeybadger API from your CircleCI workflows.

To use this orb in your project, you need to enable two settings:

• Settings -> Security -> Allow uncertified orbs
• Settings -> Advanced Settings -> Enable build processing (preview)

Usage

Deployment Notifications

Sending deployment notifications to Honeybadger allows your team to associate spikes in errors to changes that were deployed.

You can add a job definition to circle.yml that invokes the notify_deploy command from this orb:

jobs:
  test:
    ...

  deploy:
    docker:
       - image: circleci/ruby:2.5.3-node-browsers
    steps:
      - run:
          ...
      - honeybadger/notify_deploy:
          api_key: YOUR_HONEYBADGER_API_KEY

Then include that job in your workflow:

workflows:
  test:
    jobs:
      - test
      - deploy:
          requires:
            - test

This will invoke the deploy job after the test job is completed.

Source Map Uploads

Uploading your source maps to Honeybadger makes error resolution faster by enabling the generation of stack traces from your original, un-minified Javascript code.

The upload_sourcemap command can be used in your workflow to send source maps to Honeybadger after they are generated by your build tools:

jobs:
  test:
    ...

  deploy:
    docker:
       - image: circleci/ruby:2.5.3-node-browsers
    steps:
      - run:
          ...
      - honeybadger/upload_sourcemap:
          api_key: YOUR_HONEYBADGER_API_KEY
          minified_url: https://example.com/assets/application.min.js
          minified_file: path/to/application.min.js
          source_map: path/to/application.js.map

More Info

See https://circleci.com/orbs/registry/orb/honeybadger-io/deploy for more info on the parameters you can use for these commands.