Skip to content

docs: v0.0.76 release notes and component doc updates (schema 0.0.51) - #21

Merged
yilmaztayfun merged 1 commit into
mainfrom
f/v0-0-76-docs
Jul 27, 2026
Merged

docs: v0.0.76 release notes and component doc updates (schema 0.0.51)#21
yilmaztayfun merged 1 commit into
mainfrom
f/v0-0-76-docs

Conversation

@yilmaztayfun

@yilmaztayfun yilmaztayfun commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

What

Documentation for the v0.0.76 platform release (component schema 0.0.51), sourced from runtime domain classes, the @burgan-tech/vnext-schema schemas, and milestone #38.

New pages

  • blog/2026-07-27-v0-0-76.md — English release note (matches the v0.0.71 format), covering every milestone #38 issue.
  • docs/components/tasks/dapr-conversation.md — new Dapr Conversation task (type 20), full TR page + EN stub.
  • docs/how-to/resource-lock.md — new Resource Lock guide (Dapr lock.redis, Acquire/Release/Extend, automatic terminal cleanup, HTTP 409) + EN stub.

Edits

  • tasks/index.md (TR+EN): 19 → 20 task türü + new row.
  • tasks/trigger.md (TR+EN): types 11/12/13/14 converted to local anchor links; Get Instance (19) and GetInstances (15) added as cross-page list items.
  • functions/custom.md (TR+EN): varyByHeaders / varyByHeaderPrefixes cache fields + varyKey note.
  • workflow.md (TR+EN): config (functionCache.ttlSeconds) and resourceLock field rows across the attributes/start/transition/shared tables; timer → mappings#timer-mapping link; new Config and Resource Lock sections; wizard/summary view wording (#838).
  • sidebars.ts: registered both new pages.

Why

v0.0.76 adds the Dapr Conversation task, function-cache vary-by headers (#839), the flow-level config.functionCache object (#846), production-ready distributed resource locks (#840/#845), and wizard-state read normalization (#838). The portal is the authoritative reference for these contracts and must reflect schema 0.0.51.

Notes for reviewers

  • Priority TR; EN mirrors are kept structurally in sync (table rows/counts) with prose-heavy pages left as translation-pending stubs, per convention.
  • CacheAside (type 18) is intentionally not presented as a v0.0.76 feature — it shipped with schema 0.0.50 (v0.0.71) and is already documented; keeping it out of the note keeps it accurate to milestone #38.
  • Issue numbers were pulled from the live milestone, not invented.
  • npm run build passes for both locales; no new broken-anchor warnings (the anchors reported by the build are all in pre-existing blog/archive / blog/migration posts).

🤖 Generated with Claude Code

Summary by Sourcery

Document v0.0.76 / schema 0.0.51 by adding AI Dapr Conversation task docs, distributed resource lock how-to and references, and updating workflow, task, and function docs for new cache and locking capabilities.

New Features:

  • Add release note page for runtime v0.0.76 and schema 0.0.51.
  • Document the new Dapr Conversation task type (20) in both TR and EN, and register it in the sidebar and task index.
  • Introduce Resource Lock how-to docs (TR with EN stub) and link resourceLock usage from workflow transition docs.

Enhancements:

  • Extend workflow documentation with flow-level config.functionCache cache tuning, wizard state behavior clarification, and distributed resource lock fields on transitions.
  • Update trigger task docs so type 11–14 entries link to page anchors and cross-reference GetInstances (15) and GetInstance (19) tasks.
  • Describe cache varyByHeaders / varyByHeaderPrefixes fields and their interaction with the varyKey(context) helper in custom function docs.

Summary by CodeRabbit

  • New Features

    • Added documentation for the Dapr Conversation task, enabling LLM and AI provider integrations.
    • Added request-header-based function cache variants.
    • Added distributed resource locking for workflow transitions, including conflict handling and automatic cleanup.
    • Added configurable workflow-level function cache TTL settings.
  • Bug Fixes

    • Documented fixes for content-type preservation, header normalization, and publish initialization mappings.
  • Documentation

    • Updated task references, Wizard state guidance, schema version details, and navigation links.

…ide, function cache & workflow config

Document the v0.0.76 release (schema 0.0.51) across the portal:

- blog: English release note for v0.0.76 covering all milestone #38 issues
  (Dapr Conversation #844, cache vary-by headers #839, config.functionCache
  #846, resource locks #840/#845, wizard-state reads #838, and fixes).
- tasks: new Dapr Conversation task (type 20) page + EN stub; index bumped
  to 20 task types; sidebar entry.
- trigger.md: local anchor links for types 11/12/13/14, Get Instance (19)
  and GetInstances (15) added as cross-page list items.
- functions/custom.md: varyByHeaders / varyByHeaderPrefixes cache fields.
- workflow.md: config (functionCache.ttlSeconds) + resourceLock field rows,
  timer -> mappings#timer-mapping link, Config and Resource Lock sections;
  wizard/summary view wording.
- how-to: new Resource Lock guide (Dapr lock.redis, Acquire/Release/Extend,
  automatic terminal cleanup, 409) + EN stub; sidebar entry.

EN mirrors kept structurally in sync; prose-heavy pages left as
translation-pending stubs. Build passes for both locales.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@yilmaztayfun
yilmaztayfun requested a review from a team July 27, 2026 13:22
@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@sourcery-ai

sourcery-ai Bot commented Jul 27, 2026

Copy link
Copy Markdown

Reviewer's Guide

Docs updates for v0.0.76 / schema 0.0.51: new Dapr Conversation task and Resource Lock how-to, workflow config+resourceLock fields, cache vary-by headers, wizard-state wording, trigger-task anchors, task-type count bump, English stubs, and sidebar wiring; plus a detailed release note blog post.

Sequence diagram for ResourceLock Acquire and automatic terminal cleanup

sequenceDiagram
    actor Client
    participant WorkflowRuntime
    participant ResourceLockStep
    participant ITransitionMapping
    participant DaprLockRedis
    participant InstanceCancellationService

    Client->>WorkflowRuntime: ExecuteTransition(instanceId, transitionKey)
    WorkflowRuntime->>ResourceLockStep: Execute(instanceId, transition, resourceLock)
    ResourceLockStep->>ITransitionMapping: Handler(ScriptContext)
    ITransitionMapping-->>ResourceLockStep: lockKey (string)
    ResourceLockStep->>DaprLockRedis: Acquire(lockKey, instanceId, ttlSeconds)

    alt lock acquired
        DaprLockRedis-->>ResourceLockStep: Success
        ResourceLockStep-->>WorkflowRuntime: Continue pipeline
        WorkflowRuntime-->>Client: Transition response (200)

        Note over InstanceCancellationService,DaprLockRedis: Later, when instance becomes terminal
        InstanceCancellationService->>DaprLockRedis: Release(lockKey, instanceId)
        DaprLockRedis-->>InstanceCancellationService: Success or LockDoesNotExist
    else conflict
        DaprLockRedis-->>ResourceLockStep: Conflict
        ResourceLockStep-->>WorkflowRuntime: ResourceLockConflict
        WorkflowRuntime-->>Client: HTTP 409 (Conflict)
    end
Loading

File-Level Changes

Change Details Files
Document workflow-level config.functionCache and transition-level resourceLock, including behavioral details and references.
  • Add attributes.config field row to the Turkish workflow attributes table, pointing to a new Config section.
  • Add resourceLock field rows to Turkish transition tables for start, state-level, and shared transitions, linking to the Resource Lock how-to.
  • Introduce Config and Resource Lock sections in the Turkish workflow page, describing functionCache.ttlSeconds behavior, cache scope, and resourceLock usage model.
  • Update English workflow overview to mention the optional config field and add a Resource Lock subsection summarizing behavior and linking to the how-to.
docs/components/workflow.md
i18n/en/docusaurus-plugin-content-docs/current/components/workflow.md
Clarify wizard state/view behavior in workflow docs to match runtime changes.
  • Remove the loop-prevention paragraph and augment the wizard-state example to say the state view should be used as summary or continuation screen.
  • Reference wizard states being treated like normal states in the release notes.
docs/components/workflow.md
blog/2026-07-27-v0-0-76.md
Add a new Dapr Conversation task type (20) and its documentation, and register it in navigation.
  • Increase task-type count from 19 to 20 in Turkish and English task index pages and add a DaprConversationTask row.
  • Create a Turkish Dapr Conversation task page with schema-based config fields, inputs structure, mapping example, property setters, and response format.
  • Add an English stub Dapr Conversation task page summarizing purpose and key config fields.
  • Wire the new task page into the Docusaurus sidebar under components/tasks.
docs/components/tasks/index.md
i18n/en/docusaurus-plugin-content-docs/current/components/tasks/index.md
docs/components/tasks/dapr-conversation.md
i18n/en/docusaurus-plugin-content-docs/current/components/tasks/dapr-conversation.md
sidebars.ts
Improve trigger task documentation by using local anchors and cross-linking query-side task pages.
  • Replace plain bullet list of trigger tasks with intra-page anchor links to each task’s section in Turkish docs.
  • Add cross-page links for GetInstances (15) and GetInstance (19) tasks with brief descriptions in Turkish.
  • Apply the same anchor-based list and cross-page links in the English trigger task docs.
docs/components/tasks/trigger.md
i18n/en/docusaurus-plugin-content-docs/current/components/tasks/trigger.md
Extend custom function cache docs to cover varyByHeaders/varyByHeaderPrefixes and their interaction with varyKey(context).
  • Add varyByHeaders and varyByHeaderPrefixes fields to the Turkish cache configuration table, along with a tip explaining they define the header set used by varyKey(context) and how instance-driven varyBy interacts.
  • Update the English custom functions cache field summary to mention varyByHeaders/varyByHeaderPrefixes and that they feed the varyKey(context) helper for per-header cache variants.
docs/components/functions/custom.md
i18n/en/docusaurus-plugin-content-docs/current/components/functions/custom.md
Introduce a Resource Lock how-to guide and link it from workflow and how-to sidebars, with an English stub mirroring key concepts.
  • Create a Turkish how-to page for Resource Lock covering general model, configuration, keyExpression, actions (Acquire/Release/Extend), automatic cleanup, conflict behavior, examples, and best practices.
  • Add an English stub how-to page summarizing Resource Lock purpose, where it runs, supported actions, conflict handling, and pointing to the Turkish page for details.
  • Register the Resource Lock how-to in the sidebar’s how-to section.
  • Link workflow transition docs (TR+EN) to the Resource Lock how-to for the resourceLock field.
docs/how-to/resource-lock.md
i18n/en/docusaurus-plugin-content-docs/current/how-to/resource-lock.md
docs/components/workflow.md
i18n/en/docusaurus-plugin-content-docs/current/components/workflow.md
sidebars.ts
Add an English release-note blog post for v0.0.76 that documents all milestone #38 issues and schema 0.0.51 changes.
  • Create blog post 2026-07-27-v0-0-76.md with overview, feature sections (Dapr Conversation, function cache vary-by, config.functionCache, resource locks, wizard states), fixes, configuration, referenced issues, and summary.
  • Ensure the release note matches v0.0.71 format, includes runtime/schema versions, and lists all related GitHub issues and helm chart PR.
  • Note that CacheAside (type 18) is not presented as a v0.0.76 feature because it shipped earlier.
blog/2026-07-27-v0-0-76.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 7417b861-f139-43b3-aef5-a0b0b2238a8a

📥 Commits

Reviewing files that changed from the base of the PR and between d91f6a4 and 71a35dd.

📒 Files selected for processing (14)
  • blog/2026-07-27-v0-0-76.md
  • docs/components/functions/custom.md
  • docs/components/tasks/dapr-conversation.md
  • docs/components/tasks/index.md
  • docs/components/tasks/trigger.md
  • docs/components/workflow.md
  • docs/how-to/resource-lock.md
  • i18n/en/docusaurus-plugin-content-docs/current/components/functions/custom.md
  • i18n/en/docusaurus-plugin-content-docs/current/components/tasks/dapr-conversation.md
  • i18n/en/docusaurus-plugin-content-docs/current/components/tasks/index.md
  • i18n/en/docusaurus-plugin-content-docs/current/components/tasks/trigger.md
  • i18n/en/docusaurus-plugin-content-docs/current/components/workflow.md
  • i18n/en/docusaurus-plugin-content-docs/current/how-to/resource-lock.md
  • sidebars.ts

📝 Walkthrough

Walkthrough

The documentation adds Dapr Conversation task type 20, header-based function-cache variants, flow-level cache configuration, distributed resource-lock guidance, Wizard state clarifications, workflow navigation updates, and v0.0.76 release notes in Turkish and English.

Changes

Documentation updates

Layer / File(s) Summary
Dapr Conversation task documentation
docs/components/tasks/dapr-conversation.md, docs/components/tasks/index.md, i18n/en/docusaurus-plugin-content-docs/current/components/tasks/*, sidebars.ts
Documents task type 20, configuration fields, mappings, response structure, examples, translations, task indexes, and sidebar entries.
Workflow and cache configuration
docs/components/functions/custom.md, i18n/en/docusaurus-plugin-content-docs/current/components/functions/custom.md, docs/components/workflow.md, i18n/en/docusaurus-plugin-content-docs/current/components/workflow.md, docs/components/tasks/trigger.md, i18n/en/docusaurus-plugin-content-docs/current/components/tasks/trigger.md
Documents header-based cache variants, varyKey(context), flow-level cache TTL settings, Wizard state behavior, transition fields, and linked task references.
Resource Lock guide
docs/how-to/resource-lock.md, i18n/en/docusaurus-plugin-content-docs/current/how-to/resource-lock.md, sidebars.ts
Documents lock configuration, deterministic keys, actions, automatic terminal cleanup, conflict handling, HTTP 409 responses, examples, and navigation.
v0.0.76 release notes
blog/2026-07-27-v0-0-76.md
Records the documented features, fixes, schema/runtime versions, referenced issues, container details, and release date.

Estimated code review effort: 2 (Simple) | ~15 minutes

Possibly related PRs

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch f/v0-0-76-docs

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.

@yilmaztayfun yilmaztayfun self-assigned this Jul 27, 2026
@yilmaztayfun
yilmaztayfun merged commit d72f62c into main Jul 27, 2026
3 of 4 checks passed

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • In the workflow component docs, the new config field is described both inline in the top-level attributes table and again in the dedicated "Config" section; consider aligning the wording and default details between those two places to avoid subtle divergences over time.
  • The wizard state section in workflow.md drops the explicit explanation about hasView being returned as false in the available transition list to prevent loops; if that behavior is still relevant, it may be worth retaining or rephrasing it alongside the new summary/wizard wording to avoid ambiguity for readers.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the workflow component docs, the new `config` field is described both inline in the top-level `attributes` table and again in the dedicated "Config" section; consider aligning the wording and default details between those two places to avoid subtle divergences over time.
- The wizard state section in `workflow.md` drops the explicit explanation about `hasView` being returned as `false` in the available transition list to prevent loops; if that behavior is still relevant, it may be worth retaining or rephrasing it alongside the new summary/wizard wording to avoid ambiguity for readers.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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.

1 participant