An open API service indexing awesome lists of open source software.

https://github.com/mtchavez/airbrake-deploy

GitHub Action to Create Airbrake Deploys
https://github.com/mtchavez/airbrake-deploy

airbrake airbrake-github-action github-actions

Last synced: 5 months ago
JSON representation

GitHub Action to Create Airbrake Deploys

Awesome Lists containing this project

README

          

# Airbrake Deploy Github Action

Github action to create Airbrake Deploys for a project

## Inputs

### `project-id`

**Required** Airbrake Project ID.
Can be set up in env `$AIRBRAKE_PROJECT_ID`.

### `project-key`

**Required** Airbrake Project Key.
Can be set up in up in env `$AIRBRAKE_PROJECT_KEY`.

### `environment`

**Required** Airbrake Deploy Environment.
Can be set up in up in env `$AIRBRAKE_ENVIRONMENT`.
Example: `staging`

### `repository`

**Required** Airbrake Project Repository.
Can be set up in up in env `$AIRBRAKE_REPO`.
Example: `https://github.com${{ github.repo }}`.

### `revision`

**Required** Airbrake Deploy Revision.
Can be set up in up in env `$AIRBRAKE_REVISION`.
Example: Set as the commit SHA `${{ github.sha }}`.

### `user`

**Required** Airbrake Deploy User.
Can be set up in up in env `$AIRBRAKE_DEPLOY_USER`.
Example: Set as the committer `${{ github.actor }}`.

## Outputs

### `response`

The API response from Airbrake `{"id": "asdf1234asdf1234"}`

## Example usage

```yaml
uses: mtchavez/airbrake-deploy-github-action@v1
with:
project-id: ${{ env.AIRBRAKE_PROJECT_ID }}
project-key: ${{ secret.AIRBRAKE_PROJECT_KEY }}
environment: ${{ env.AIRBRAKE_ENVIRONMENT }}
repository: https://github.com${{ github.repo }}
revision: ${{ github.sha }}
user: ${{ github.actor }}
```