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

# opslevel/report_deploy

Official CircleCI orb for OpsLevel - can be used to report a deploy for a service in OpsLevel.


## Commands

### report

This command will report a deploy event for an OpsLevel service by using the OpsLevel CLI.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `deployer_email` | string |  | The deployer email who created the event |
| `deployer_name` | string |  | The deployer name who created the event |
| `description` | string | deploy reported using opslevel circleci orb | The description or release notes for the event |
| `environment` | string | production | The environment for the event |
| `service` | string |  | The service alias for the event |

## Jobs

### report

This job will report a deploy event for an OpsLevel service by using the OpsLevel CLI.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `deployer_email` | string |  | The deployer email who created the event |
| `deployer_name` | string |  | The deployer name who created the event |
| `description` | string | deploy reported using opslevel circleci orb | The description or release notes for the event |
| `environment` | string | production | The environment for the event |
| `service` | string |  | The service alias for the event |

## Executors

### default

This executor uses a stable OpsLevel CLI container image for reporting deploys.


## Examples

### example

This example reports a deploy to OpsLevel and uses all settable fields.


```yaml
version: '2.1'
orbs:
  report_deploy: opslevel/report_deploy@1.0.0
workflows:
  report-deploy-event:
    jobs:
      - checkout
      - report_deploy/report:
          deployer_email: robot@example.com
          deployer_name: Robot
          description: deploy sent from a robot using the opslevel circleci orb
          environment: self_hosted
          service: <alias for the service being deployed>
```