README.md

February 18, 2026 ยท View on GitHub

logo

pulse-action

GitHub release (latest by date)
build lint

A GitHub Action for sending a Rootly pulse

Powered by rootly-cli.

Inputs

Input NameDescriptionRequired
summarySummary of the pulseYes
api_keyRootly API keyYes
servicesServices associated with the pulse. Separate with commas.No
environmentsEnvironments associated with the pulse. Separate with commas.No
labelsLabels associated with the pulse. Separate with commas and separate key-value pair with = (no spaces before or after =).No
sourceSource of the pulseNo
refsRefs associated with the pulse. Separate with commas and separate key-value pair with = (no spaces before or after =).No

Example

name: Deploy Website

on: push

jobs:
  pulse:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - run: make deploy
      - name: rootly-pulse
        uses: rootlyhq/pulse-action@master
        with:
          api_key: ${{ secrets.ROOTLY_API_KEY }}
          summary: Deploy Website
          environments: production # Not required
          services: elasticsearch-prod # Not required
          labels: platform=ubuntu,version=2 # Not required
          source: k8s # Not required
          refs: sha=${{ github.sha }} # Not required