You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit a7a51cc
Browse filesBrowse the repository at this point in the historyBrowse files
- Update example to use @v8
- Add key_format parameter to docs
- Update github_token description (now used for schedule fetching)
- Add Changelog section documenting v8 changes
|``event``| Yes | Triggering event (passed from ``github.event``) |
45
45
|``cronitor_key``| Yes | Your Cronitor API key |
46
-
|``github_token``| No |To relay workflow logs, pass your ``GITHUB_TOKEN``|
46
+
|``github_token``| No |Used to fetch workflow schedules from your repo |
47
47
|``cronitor_group``| No | Add monitors to a Cronitor group |
48
48
|``cronitor_notify``| No | A notification list to use for alerts |
49
-
50
-
Note: Log relay is coming soon.
49
+
|``key_format``| No | Monitor key format: ``slugified`` (default) or ``legacy``|
51
50
52
51
## Monitoring Specific Workflows
53
52
By default, when you add the YAML for the Cronitor Monitoring Relay as an Action, it will be invoked automatically for every
@@ -73,5 +72,12 @@ After adding the Cronitor Relay yaml, your workflows will appear on your Cronito
73
72
dashboard, you will be able to customize alert preferences, including:
74
73
- Be alerted only if a workflow persistently fails
75
74
- Be alerted if a workflow does not run or complete at least once in a given time span.
76
-
- Be alerted on workflow execution time and avoid surprise charges from Github.
75
+
- Be alerted on workflow execution time and avoid surprise charges from Github.
76
+
77
+
## Changelog
78
+
79
+
### v8
80
+
- **Schedule sync**: Workflows with a `schedule` trigger now automatically sync their cron schedule to Cronitor (requires `github_token` to be passed, as shown in the example above).
81
+
- **Cleaner monitor keys**: Monitor keys now use a slugified workflow name format (`gh-my-workflow-name`) instead of numeric IDs.
82
+
- **Backwards compatibility**: Existing users can set `key_format: legacy` to keep using the old key format and preserve their existing monitors.
0 commit comments