community.general.honeybadger_deployment module – Notify Honeybadger.io about app deployments

Note

This module is part of the community.general collection (version 10.0.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.honeybadger_deployment.

Synopsis

Parameters

Parameter

Comments

environment

string / required

The environment name, typically ‘production’, ‘staging’, etc.

repo

string

URL of the project repository

revision

string

A hash, number, tag, or other identifier showing what revision was deployed

token

string / required

API token.

url

string

Optional URL to submit the notification to.

Default: "https://api.honeybadger.io/v1/deploys"

user

string

The username of the person doing the deployment

validate_certs

boolean

If false, SSL certificates for the target url will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name: Notify Honeybadger.io about an app deployment
  community.general.honeybadger_deployment:
    token: AAAAAA
    environment: staging
    user: ansible
    revision: b6826b8
    repo: 'git@github.com:user/repo.git'

Authors

  • Benjamin Curtis (@stympy)