Add guide for migrating Sidekiq job queues to Standalone Activities - #5202
Draft
brianmacdonald-temporal wants to merge 2 commits into
Draft
Add guide for migrating Sidekiq job queues to Standalone Activities#5202brianmacdonald-temporal wants to merge 2 commits into
brianmacdonald-temporal wants to merge 2 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview links
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a Ruby migration guide for converting Sidekiq jobs into Temporal Standalone Activities.
Changes:
- Adds the Sidekiq migration tutorial.
- Adds the guide to sidebar navigation.
- Adds a Ruby migration card to the Guides grid.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
docs/guides/sidekiq-to-standalone-activity.mdx |
Adds the migration guide. |
sidebars.js |
Adds sidebar navigation. |
src/components/GuidesGrid/guides-data.json |
Adds the guide card. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| id: sidekiq-to-standalone-activity | ||
| title: Migrate a Sidekiq job queue to a Temporal Standalone Activity | ||
| sidebar_label: Migrate from Sidekiq | ||
| description: Migrate Sidekiq background jobs to a Temporal Standalone Activity. |
| - The Temporal CLI, version 1.7.0 or higher (installed in Step 2). | ||
| - An existing Sidekiq job you want to migrate, or the sample job shown in Step 4 if you are following along from scratch. | ||
|
|
||
| ## Step 1: Set up your project directory |
Comment on lines
+6
to
+12
| keywords: | ||
| - sidekiq | ||
| - standalone activities | ||
| - ruby | ||
| - migration | ||
| - background jobs | ||
| - temporal |
|
|
||
| ## Conclusion | ||
|
|
||
| In this tutorial, you migrated a Sidekiq job to a Temporal Standalone Activity. You converted the job into an Activity, ran a Worker to execute it, started it fire-and-forget in place of `perform_async`, retrieved a return value that Sidekiq could never give you, replaced `sidekiq_options retry:` with a Retry Policy, and inspected your Activities in place of the Sidekiq Web UI — all without writing a single Workflow. Your jobs now survive Worker crashes, retry on well-defined policies, and remain queryable through the client and Web UI. |
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
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.
What does this PR do?
Adds a Ruby guide, Migrate a Sidekiq job queue to a Temporal Standalone Activity, that walks through converting a Sidekiq job into a Standalone Activity:
sidekiqprocess, Redis,perform_async,sidekiq_options retry:, Web UI) onto their Temporal equivalentsperform_asyncwithclient.start_activity(), and adds a return value viaclient.execute_activity()— something Sidekiq's fire-and-forget model can't providesidekiq_options retry: Nto a Retry Policy (with the total-attempts vs. retries adjustment:retry: 5->max_attempts: 6)client.list_activities()andclient.count_activities()in place of the Sidekiq Web UIAlso links the page from the Guides sidebar and adds a card to the Guides landing-page grid under the existing
Migrationtag.Notes to reviewers
Opened as a draft: the guide documents Standalone Activities, which are
publicPreviewinsrc/constants/featureReleaseTypes.js.All Temporal doc links are relative to satisfy
Temporal.RelativeLinks. Sidekiq-specific external links (sidekiq.org) remain absolute.Two review conventions from #5135 are already applied: core identifiers use
Id(Activity Id, Run Id) with generic "user identifier", and product name is "Temporal Service".