Track CI and deployment workflows with ActivitySmith

WEBSITE

Overview

Use the official ActivitySmith GitHub Action to send Push Notifications and trigger Live Activities from your GitHub Actions workflows.

Usage

Start a Live Activity, update progress as your workflow runs, then end it on completion.

- name: Start live activity
  id: start_activity
  uses: ActivitySmithHQ/[email protected]
  with:
    action: start_live_activity
    api-key: ${{ secrets.ACTIVITYSMITH_API_KEY }}
    payload: |
      content_state:
        title: "API Deploy"
        subtitle: "build"
        number_of_steps: 3
        current_step: 1
        type: "segmented_progress"
        color: "yellow"

- name: Update live activity
  uses: ActivitySmithHQ/[email protected]
  with:
    action: update_live_activity
    api-key: ${{ secrets.ACTIVITYSMITH_API_KEY }}
    live-activity-id: ${{ steps.start_activity.outputs.live_activity_id }}
    payload: |
      content_state:
        title: "API Deploy"
        subtitle: "release switch and reload"
        current_step: 2

- name: End live activity
  if: ${{ always() && steps.start_activity.outputs.live_activity_id != '' }}
  uses: ActivitySmithHQ/[email protected]
  with:
    action: end_live_activity
    api-key: ${{ secrets.ACTIVITYSMITH_API_KEY }}
    live-activity-id: ${{ steps.start_activity.outputs.live_activity_id }}
    payload: |
      content_state:
        title: "API Deploy"
        subtitle: "completed"
        current_step: 3

Send a Push Notification on completion.

- name: Send push notification
  uses: ActivitySmithHQ/[email protected]
  with:
    action: send_push_notification
    api-key: ${{ secrets.ACTIVITYSMITH_API_KEY }}
    payload: |
      title: "Deployment completed"
      message: "main branch is now live in production"

Want the full production example? Read how I use ActivitySmith while deploying ActivitySmith.