Scope Workflow determinism language in AI-integration docs; add advisory Vale rule - #5281
Conversation
…ory Vale rule Same scoping fix applied to the two AI-agent integration guides where the Workflow/Activity distinction matters most for authors, plus one placement judgment call: dropped "deterministic" from a one-line Code Exchange card blurb on the /ai landing page, since the term doesn't earn its place in top-of-funnel marketing copy. Also adds an advisory (non-CI-gating) Vale rule that flags bare "Workflow is/are/must be deterministic" and "Workflow determinism" so future contributions don't reintroduce the pattern this sweep fixes.
…over-correction google-adk.mdx: state the actionable rule (Workflow code can't touch network/clock/disk directly) instead of the abstract "is deterministic" framing, since that's what an integration author acts on. langgraph.mdx: the "Has non-deterministic behavior" bullet already explains the criterion in its parenthetical; the trailing sentence just repeated it, so it's gone. Also reverts an over-correction from the original scoping pass: the LangGraph-primitives table row for conditional edge functions was never a bare-Workflow violation (the subject is the specific function, already correctly scoped) — my earlier edit to "deterministic code" broke the sentence's parallel structure for no reason.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -67,7 +67,7 @@ agent's skills directory. | |||
| ### Temporal Developer skill | |||
There was a problem hiding this comment.
📝 [vale] <Temporal.Headings> reported by reviewdog 🐶
'Temporal Developer skill' should use sentence-style capitalization.
| expert-level knowledge of Temporal's programming model, including Workflow code determinism rules, Activity patterns, Retry | ||
| Policies, error handling, testing strategies, Worker configuration, versioning, and common gotchas. | ||
|
|
||
| ### Temporal Ops skill |
There was a problem hiding this comment.
📝 [vale] <Temporal.Headings> reported by reviewdog 🐶
'Temporal Ops skill' should use sentence-style capitalization.
📖 Docs PR preview links
|
…ism constraint Same correction as the other two branches. Also updates the advisory Vale rule's message to recommend "the Workflow Definition" instead of "Workflow code/logic," since that's now the standard being taught.
…eterminism-ai-and-vale
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 75dd309ddf
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
|
||
| The [Temporal Developer skill](https://github.com/temporalio/skill-temporal-developer) gives your AI coding agent | ||
| expert-level knowledge of Temporal's programming model, including Workflow determinism rules, Activity patterns, Retry | ||
| expert-level knowledge of Temporal's programming model, including Workflow Definition determinism rules, Activity patterns, Retry |
There was a problem hiding this comment.
This line adopts the new Workflow Definition-scoped terminology, but the same unscoped assertion remains in docs/develop/python/best-practices/error-handling.mdx:336, docs/develop/typescript/workflows/message-passing.mdx:269-272, docs/design-patterns/approval.mdx:815, docs/guides/durable-gaming-sessions.mdx:115-117, and docs/guides/entity-pattern-loyalty-points.mdx:79,932. Leaving these pages unchanged preserves the inconsistency this change is intended to remove and causes the new advisory rule to report existing instances immediately; update these collateral passages and headings to scope determinism to Workflow Definitions or Workflow code as appropriate.
AGENTS.md reference: AGENTS.md:L234-L242
Useful? React with 👍 / 👎.
2 participants
Summary
/ailanding page — the term doesn't carry its weight in top-of-funnel marketing copy.Temporal.DeterminismScope, that flags bare "Workflow is/are/must be deterministic" and "Workflow determinism" going forward, so future contributions don't reintroduce the pattern this sweep fixes.Test plan
vale --config .vale-ci.ini docs/clean on touched filesvale docs/run confirms the new rule doesn't false-positive on the many correctly-scoped "Workflow code" instances elsewhere in the repoyarn buildpasses