Create deployments from GitHub Actions

GitHub Actions is a great platform for building and releasing software. To notify elmah.io when you deploy a new version of your project, you will need an additional step in your build definition. Before you do that, start by creating new secrets:

  1. Go to your project on GitHub.

  2. Click the Settings tab.

  3. Click the Secrets navigation item.

  4. Click New repository secret.

  5. Name the secret ELMAH_IO_API_KEY.

  6. Insert your elmah.io API key in Value (Where is my API key?). Make sure to use an API key that includes the Deployments | Write permission (How to configure API key permissions).

  7. Click Add secret

  8. Do the same for your elmah.io log ID but name it ELMAH_IO_LOG_ID (Where is my log ID?).

  9. Insert the following step as the last one in your YAML build specification:

- name: Create Deployment on elmah.io
  uses: elmahio/[email protected]
  with:
    apiKey: ${{ secrets.ELMAH_IO_API_KEY }}
    version: ${{ github.run_number }}
    logId: ${{ secrets.ELMAH_IO_LOG_ID }}

The configuration will automatically notify elmah.io every time the build script is running. The build number (github.run_number) is used as the version for this sample, but you can modify this if you prefer another scheme.

Here's a full overview of properties:

Name Required Description
apiKey ✔️ An API key with permission to create deployments.
version ✔️ The version number of this deployment. The value of version can be a SemVer compliant string or any other syntax that you are using as your version numbering scheme. You can use ${{ github.run_number }} to use the build number as the version or you can pick another scheme or combine the two.
description Optional description of this deployment. Can be markdown or cleartext. The latest commit message can be used as the description by using ${{ github.event.head_commit.message }}.
userName The name of the person responsible for creating this deployment. This can be set manually or dynamically using the ${{ github.actor }} variable.
userEmail The email of the person responsible for creating this deployment. There doesn't seem to be a way to pull the email responsible for triggering the build through variables, why this will need to be set manually.
logId As default, deployments are attached to all logs of the organization. If you want a deployment to attach to a single log only, set this to the ID of that log.

This article was brought to you by the elmah.io team. elmah.io is the best error management system for .NET web applications. We monitor your website, alert you when errors start happening, and help you fix errors fast.

See how we can help you monitor your website for crashes Monitor your website