Skip to content

Docs changes for trigger types#3257

Open
mnafees wants to merge 9 commits intomainfrom
nafees/docs-changes
Open

Docs changes for trigger types#3257
mnafees wants to merge 9 commits intomainfrom
nafees/docs-changes

Conversation

@mnafees
Copy link
Member

@mnafees mnafees commented Mar 12, 2026

Description

Changes to the following in the Triggers section:

  • Scheduled Runs
  • Cron Runs
  • Bulk Runs
  • Webhooks

Type of change

  • Documentation change (pure documentation change)
  • New feature (non-breaking change which adds functionality)

@mnafees mnafees self-assigned this Mar 12, 2026
Copilot AI review requested due to automatic review settings March 12, 2026 20:36
@vercel
Copy link

vercel bot commented Mar 12, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
hatchet-docs Ready Ready Preview, Comment Mar 16, 2026 0:16am

Request Review

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the “Scheduled Runs” documentation and examples across SDKs, while adding new Go SDK scheduling capabilities and surfacing the language selector in the docs navbar.

Changes:

  • Refresh scheduled run examples (TS/Python/Go) to use “tomorrow at noon UTC” semantics and updated scheduled-run APIs.
  • Add Go SDK support for scheduling runs via Workflow.Schedule / StandaloneTask.Schedule and extend the Go schedules client with update + bulk ops.
  • Move the docs language selector into the navbar and adjust styling to reorder navbar items.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 14 comments.

Show a summary per file
File Description
sdks/typescript/src/v1/examples/simple/schedule.ts Updates v1 TS scheduled-runs example used for docs snippets.
examples/typescript/simple/schedule.ts Updates standalone TS example script mirroring docs.
sdks/python/examples/simple/schedule.py Updates Python SDK example for scheduling at tomorrow noon UTC.
examples/python/simple/schedule.py Updates standalone Python example mirroring docs.
sdks/go/workflow.go Adds Workflow.Schedule to create a scheduled run.
sdks/go/client.go Adds StandaloneTask.Schedule convenience wrapper.
sdks/go/features/schedules.go Adds schedules Update/BulkDelete/BulkUpdate REST helpers.
pkg/client/client.go Wires REST client into admin client construction.
pkg/client/admin.go Adds ScheduleWorkflowV1 on legacy client to return a workflow version.
sdks/go/examples/scheduled/main.go Expands Go scheduled-runs example with reschedule and bulk operations.
examples/go/scheduled/main.go Mirrors the Go scheduled-runs example under top-level examples.
frontend/docs/pages/v1/scheduled-runs.mdx Updates scheduled-runs docs content and adds Go tabs/snippets.
frontend/docs/theme.config.tsx Moves LanguageSelectorButton into navbar extra content.
frontend/docs/styles/global.css Adds CSS to reorder navbar items to place language selector earlier.
.golangci.yml Excludes sdks/go/examples/ (and formatting for Go examples) from golangci processing.
Comments suppressed due to low confidence (2)

examples/typescript/simple/schedule.ts:37

  • This example deletes scheduledRunId and then later uses the same ID for bulk delete / bulk reschedule calls. Running the script sequentially will likely fail after the delete. Consider reordering so delete happens last, or create separate scheduled runs for each standalone example block.
  // > Delete a Scheduled Run
  await hatchet.scheduled.delete(scheduledRunId);

  // > List Scheduled Runs
  const scheduledRuns = await hatchet.scheduled.list({});

  // > Bulk Delete Scheduled Runs
  await hatchet.scheduled.bulkDelete({
    scheduledRuns: [scheduledRunId],
  });

  // > Bulk Reschedule Scheduled Runs
  await hatchet.scheduled.bulkUpdate([
    { scheduledRun: scheduledRunId, triggerAt: new Date(Date.now() + 2 * 60 * 60 * 1000) },
  ]);

sdks/typescript/src/v1/examples/simple/schedule.ts:36

  • As written, this script deletes scheduledRunId and then later uses the same ID in bulk delete / bulk update calls. If someone runs the example end-to-end, those later calls will likely fail because the scheduled run has already been deleted. Consider either reordering (delete last) or creating a new scheduled run ID for each independent example block.
  // > Delete a Scheduled Run
  await hatchet.scheduled.delete(scheduledRunId);
  // !!

  // > List Scheduled Runs
  const scheduledRuns = await hatchet.scheduled.list({});
  // !!

  // > Bulk Delete Scheduled Runs
  await hatchet.scheduled.bulkDelete({
    scheduledRuns: [scheduledRunId],
  });

You can also share your feedback on Copilot code review. Take the survey.

@mnafees mnafees changed the title Changes to Scheduled Runs doc Docs changes for trigger types Mar 13, 2026
@mnafees mnafees added the documentation Improvements or additions to documentation label Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants