community.general.airbrake_deployment (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Notify airbrake about app deployments (see U(https://airbrake.io/docs/api/#deploys-v4)).

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Notify airbrake about an app deployment
  community.general.airbrake_deployment:
    project_id: '12345'
    project_key: 'AAAAAA'
    environment: staging
    user: ansible
    revision: '4.2'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Notify airbrake about an app deployment, using git hash as revision
  community.general.airbrake_deployment:
    project_id: '12345'
    project_key: 'AAAAAA'
    environment: staging
    user: ansible
    revision: 'e54dd3a01f2c421b558ef33b5f79db936e2dcf15'
    version: '0.2.0'

Inputs

    
url:
    default: https://api.airbrake.io/api/v4/projects/
    description:
    - Optional URL to submit the notification to. Use to send notifications to Airbrake-compliant
      tools like Errbit.
    required: false
    type: str

repo:
    description:
    - URL of the project repository
    required: false
    type: str

user:
    description:
    - The username of the person doing the deployment
    required: false
    type: str

version:
    description:
    - A string identifying what version was deployed
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: community.general

revision:
    description:
    - A hash, number, tag, or other identifier showing what revision from version control
      was deployed
    required: false
    type: str

project_id:
    description:
    - Airbrake PROJECT_ID
    required: true
    type: str
    version_added: 0.2.0
    version_added_collection: community.general

environment:
    description:
    - The airbrake environment name, typically 'production', 'staging', etc.
    required: true
    type: str

project_key:
    description:
    - Airbrake PROJECT_KEY.
    required: true
    type: str
    version_added: 0.2.0
    version_added_collection: community.general

validate_certs:
    default: true
    description:
    - If V(false), SSL certificates for the target url will not be validated. This should
      only be used on personally controlled sites using self-signed certificates.
    required: false
    type: bool