Skip to main content

GitHub

Use the Hotpot GitHub integration to create moments or page someone with GitHub Actions.

GitHub actions are commonly used to automate tasks like deploys. When that task fails, it may warrant an investigation and, therefore, a moment! You can track things like broken deploys or failing main branches. This page walks through an example of how to send Hotpot a moment upon an action failure.

To send Hotpot a moment upon an action failure:

  1. Get a Hotpot API key and add it as a secret to your GitHub action.

    This example uses a secret named HOTPOT_WEBHOOK_URL.

  2. Add the moment creation as a step:


  - name: Notify Hotpot on failure
    if: failure()
    env:
        HOTPOT_WEBHOOK_URL: ${{ secrets.HOTPOT_WEBHOOK_URL }}
    run: |
        curl -X POST -H 'Content-type: application/json' -d '{"name": "[Production] failed", "type": "Problem", "tags": ["production"], "source_url": "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}", "description": "Unable to deploy ${{ github.event.pull_request.html_url || github.event.head_commit.url }} This needs to be debugged and understood." }' ${{ env.HOTPOT_WEBHOOK_URL }}

Adjust the tags and contents to suit your needs.