Skip to content

Commit a7a51cc

Browse files
committed
Update README for v8 release
- 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
1 parent 403b14a commit a7a51cc

1 file changed

Lines changed: 11 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
name: Send Telemetry
2828
steps:
2929
- name: Send execution details to the Cronitor for Github Actions agent
30-
uses: cronitorio/monitor-github-actions@v7
30+
uses: cronitorio/monitor-github-actions@v8
3131
with:
3232
event: ${{ toJSON(github.event) }}
3333
github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -43,11 +43,10 @@ jobs:
4343
|---------------------|----------|----------------------------------------------------|
4444
| ``event`` | Yes | Triggering event (passed from ``github.event``) |
4545
| ``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 |
4747
| ``cronitor_group`` | No | Add monitors to a Cronitor group |
4848
| ``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`` |
5150

5251
## Monitoring Specific Workflows
5352
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
7372
dashboard, you will be able to customize alert preferences, including:
7473
- Be alerted only if a workflow persistently fails
7574
- 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.
7783

0 commit comments

Comments
 (0)