Method: Honeybadger::Agent#track_deployment

Defined in:
lib/honeybadger/agent.rb

#track_deployment(environment: nil, revision: nil, local_username: nil, repository: nil) ⇒ Boolean

Track a new deployment

Examples:

Honeybadger.track_deployment(revision: 'be2ceb6')

Parameters:

  • :environment (String) —

    The environment name. Defaults to the current configured environment.

  • :revision (String) —

    The VCS revision being deployed. Defaults to the currently configured revision.

  • :local_username (String) —

    The name of the user who performed the deploy.

  • :repository (String) —

    The base URL of the VCS repository. It should be HTTPS-style.

Returns:

  • (Boolean) —

    true if the deployment was successfully tracked and false otherwise.

[View source]

224
225
226
227
228
229
230
231
232
233
 
# File 'lib/honeybadger/agent.rb', line 224

def track_deployment(environment: nil, revision: nil, local_username: nil, repository: nil)
  opts = {
    environment: environment || config[:env],
    revision: revision || config[:revision],
    local_username: local_username,
    repository: repository
  }
  response = backend.track_deployment(opts)
  response.success?
end