Add GitHub API integration to fetch workflow schedules #49
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add schedule field to Cronitor PUT request when workflow has a cron schedule
- Fetch workflow file content via GitHub API to extract schedule
- Change monitor key format from `{repo_id}-{workflow_id}` to `gh-{slugified-name}`
- Add @actions/github dependency for API calls
- Update actions/checkout from v3 to v4 - Update actions/setup-node from v3.5.0 to v4 - Update actions/upload-artifact from v3 to v4
- Export slugify, extractSchedule, getMonitorState, getKey for testing - Add index.test.js with 15 tests covering: - slugify: space conversion, special char removal, hyphen handling - extractSchedule: cron parsing from workflow YAML - getMonitorState: action/conclusion state mapping - getKey: key generation with gh- prefix - Only run main function when executed directly (not when imported)
- Add key_format input: "slugified" (default) or "legacy"
- Default uses new gh-{slugified-name} format
- Legacy format (repo-id-workflow-id) available for existing users
- Split getKey into getLegacyKey and getSlugifiedKey helpers
- Add tests for both key format functions
- Step values (*/15 * * * *) - Ranges and lists (0,30 9-17 * * 1-5)
aflanagan
force-pushed
the
claude/add-cronitor-schedule-s0MGD
branch
2 times, most recently
from
a137b09 to
a7a51cc
Compare
- 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
aflanagan
force-pushed
the
claude/add-cronitor-schedule-s0MGD
branch
from
a7a51cc to
3b17b3c
Compare
- Rename getLegacyKey to getIdKey - Update key_format option from 'legacy' to 'id' - Simplify changelog wording
- Set Cronitor API version to 2025-11-28 - Rename extractSchedule to extractSchedules, returns array - Use 'schedules' (plural) in API payload - Add test for multiple cron schedules
- Upgrade @actions/github from 5.1.1 to 7.0.0 - Add undici override to fix remaining vulnerability - All npm audit vulnerabilities resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds GitHub API integration to the Cronitor GitHub Action, enabling it to automatically fetch and report workflow schedule information to Cronitor monitors.
Key Changes
@actions/githubdependency to interact with GitHub's REST APIextractSchedule()function that parses YAML workflow files to find cron schedulesgetWorkflowSchedule()function that:{repo-id}-{workflow-id}togh-{slugified-workflow-name}for better readabilityslugify()utility function to convert workflow names into URL-safe keysschedulefield when availableImplementation Details
putMonitorDetails()callgithub_tokenis provided or the API call fails, the action continues without schedule information (non-blocking)dist/licenses.txt