GitHub Actions Integration

Integration with GitHub Actions to notify OpsLevel of any recent deploys for a service.

OpsLevel’s deploy integration lets you capture information about services’ deploys from your CI/CD systems

This GitHub Actions Deploy integration makes it even easier to start with OpsLevel and keep track of the deploy info coming from your GitHub project.

This integration leverages our OpsLevel CLI to perform deploy event submissions. You can read more about how it works on our GitHub repository and even download the CLI to test it out locally yourself. You can also read more about the action in our repository.

Add a GitHub Actions Deploy Integration

  1. In the OpsLevel app, click Integrations in the left sidebar.
  2. Click on the + New Integration button.
  3. Add the GitHub Actions deploy integration

GitHub Setup

The GitHub Action only has 1 required parameter OL_INTEGRATION_URL, which we recommend filling with a secret from your repositories secret configuration. The rest of the parameters have defaults which are retreived from the environment but you can override any of them.

NOTE: If the repository uses an opslevel.yml file, the service name will be pulled from there unless an override is provided.

1. Create a new project secret named OL_INTEGRATION_URL and set the value as the OpsLevel Webhook URL which can be copied from the GitHub Actions integration page in OpsLevel

GitHub Actions Webhook URL

You can use the action with any event trigger, but we recommend using it with the push to main branch event trigger so we can receive the relevent commit data.

2. In your GitHub repository’s workflow main.yml file, set the following:

Please refer to our releases page to ensure you are using the latest version of the action.

name: main

on:
  push:
    branches: [ main ]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:  
    - uses: actions/checkout@v2
    - uses: OpsLevel/[email protected]
      with:
        integrationId: $
        service: assistant_manager
        description: Assistant to the Manager. 
        environment: dev