Skip to content

docs: Remove old idempotencyKey warning#3306

Merged
matt-aitken merged 2 commits intomainfrom
docs/remove-old-warning
Apr 1, 2026
Merged

docs: Remove old idempotencyKey warning#3306
matt-aitken merged 2 commits intomainfrom
docs/remove-old-warning

Conversation

@D-K-P
Copy link
Copy Markdown
Member

@D-K-P D-K-P commented Apr 1, 2026

No description provided.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Apr 1, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
trigger 🟢 Ready View Preview Apr 1, 2026, 10:56 AM

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 1, 2026

⚠️ No Changeset found

Latest commit: cc9ca95

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 1, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 6212a702-0f57-4e0c-827f-9f8fdf71714e

📥 Commits

Reviewing files that changed from the base of the PR and between 68e88d0 and cc9ca95.

📒 Files selected for processing (1)
  • docs/triggering.mdx
💤 Files with no reviewable changes (1)
  • docs/triggering.mdx

Walkthrough

This is a documentation update removing a warning block from docs/triggering.mdx. The removed warning stated that idempotencyKey is unavailable when using triggerAndWait or batchTriggerAndWait in SDK version 3.3.0+ due to a bug that could cause the parent task to get stuck. No other content, code, or public exports were modified in this change.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description is missing entirely. The template requires sections like Testing, Changelog, and Checklist, none of which are provided. Add a complete pull request description following the repository template, including the issue number, checklist, testing steps, and changelog information.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: removing an outdated idempotencyKey warning from the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/remove-old-warning

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@D-K-P D-K-P changed the title Remove old idempotencyKey warning (docs) Remove old idempotencyKey warning Apr 1, 2026
@D-K-P D-K-P changed the title (docs) Remove old idempotencyKey warning docs: Remove old idempotencyKey warning Apr 1, 2026
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

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

Devin Review found 1 potential issue.

⚠️ 1 issue in files not directly in the diff

⚠️ Stale idempotencyKey warning remains in .cursor/rules/writing-tasks.mdc after removal from docs (.cursor/rules/writing-tasks.mdc:1055)

The PR removes the warning about idempotencyKey not being available with triggerAndWait/batchTriggerAndWait from docs/triggering.mdx, but the identical stale warning still exists at .cursor/rules/writing-tasks.mdc:1055: "Not available with triggerAndWait or batchTriggerAndWait in v3.3.0+ due to a bug". Since the bug is now fixed (as evidenced by packages/trigger-sdk/src/v3/shared.ts:2378-2406 properly handling idempotencyKey in triggerAndWait_internal), this stale note in the cursor rules file will cause AI coding agents to give incorrect guidance, telling users they cannot use idempotency keys with triggerAndWait/batchTriggerAndWait when they actually can.

View 1 additional finding in Devin Review.

Open in Devin Review

@matt-aitken matt-aitken merged commit f75d4d6 into main Apr 1, 2026
11 checks passed
@matt-aitken matt-aitken deleted the docs/remove-old-warning branch April 1, 2026 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants