activitysmith-github-action/action.yml at main · ActivitySmithHQ/activitysmith-github-action · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
name: ActivitySmith.com
author: "ActivitySmithHQ"
description: "Send push notifications, drive Live Activities, update widget metrics, and set app icon badge counts directly from GitHub workflows"

inputs:
  action:
    description: "Choose the action to perform: send_push_notification, stream_live_activity, end_live_activity_stream, start_live_activity, update_live_activity, end_live_activity, update_metric_value, or update_app_icon_badge_count."
    required: true
  api-key:
    description: "The authentication value used with the ActivitySmith API."
    required: true
  errors:
    description: "Set true to fail the step when ActivitySmith cannot complete the operation. The default false reports ok=false and lets the workflow continue."
    required: false
    default: "false"
  live-activity-id:
    description: "ID of the live activity (required for update/ending)"
    required: false
  stream-key:
    description: "Stable stream key for stream_live_activity and end_live_activity_stream."
    required: false
  metric-key:
    description: "Metric key for update_metric_value."
    required: false
  payload:
    description: "Request body content using JSON or YAML. Required unless action is end_live_activity_stream. Supports the current ActivitySmith API payload, including notification tags; stats, metrics, segmented_progress, progress, alert, and timer Live Activities; widget metric values; and app icon badge counts."
    required: false
  channels:
    description: "Optional comma-separated channel names to target for send_push_notification, stream_live_activity, start_live_activity, and update_app_icon_badge_count."
    required: false
  payload-delimiter:
    description: "Field separator for nested attributes in the input payload."
    required: false
  payload-file-path:
    description: "Path to a file containing a valid input payload made of JSON or YAML."
    required: false

outputs:
  ok:
    description: "If the request completed without returning errors."
  response:
    description: "A JSON stringified version of the ActivitySmith API response."
  time:
    description: "The Unix epoch time that the step completed."
  live_activity_id:
    description: "The live activity ID returned with start_live_activity or stream_live_activity."
  operation:
    description: "The operation returned by stream actions, such as started, updated, rotated, noop, paused, or ended."

runs:
  using: node24
  main: dist/index.js

branding:
  icon: "zap"
  color: "black"