Add one-time move to the versioning override API! by Shivs11 · Pull Request #808 · temporalio/api

Shivs11 · 2026-06-17T22:31:20Z

What changed?

WISOTT

Why?

So that operators can have a versioning override that is not sticky. The idea is that the next task of the workflow execution moves to the target version, after which the behaviour/version of the workflow are dictated by the worker response.

Breaking changes

No, since this is a new option that I am adding whose default value is false (it's opt-in)

Server PR

here

yiminc · 2026-06-17T22:50:13Z

    // Indicates whether to override the workflow to be AutoUpgrade or Pinned.
    oneof override {
        // Override the workflow to have Pinned behavior.
        PinnedOverride pinned = 3;


so this would continue to be sticky pin behavior? I think we need to update the doc so it is more clear. It would ignore even when SDK do CAN and wants change to AU to current version?

It would ignore even when SDK do CAN and wants change to AU to current version

yes, the PinnedOverride is meant to be sticky. As long as it exists on a workflow execution, it shall be pinned to a specific workflow execution

Sushisource

I think the comments do a great job explaining it all now.

github-actions · 2026-06-24T20:45:15Z

Opengrep — new findings

Severity	Location	Rule	Message
ERROR	`.github/workflows/create-release.yml:25`	`security.gha.missing-explicit-permissions-temporal`	No explicit `GITHUB_TOKEN` permissions found at the workflow or job level. Add a `permissions:` block at the workflow root (applies to all jobs) or per job with least privilege (e.g., `contents: read` and only specific writes like `pull-requests: write` if needed).
ERROR	`.github/workflows/create-release.yml:30`	`security.gha.missing-explicit-permissions-temporal`	No explicit `GITHUB_TOKEN` permissions found at the workflow or job level. Add a `permissions:` block at the workflow root (applies to all jobs) or per job with least privilege (e.g., `contents: read` and only specific writes like `pull-requests: write` if needed).
ERROR	`.github/workflows/create-release.yml:99`	`security.gha.missing-explicit-permissions-temporal`	No explicit `GITHUB_TOKEN` permissions found at the workflow or job level. Add a `permissions:` block at the workflow root (applies to all jobs) or per job with least privilege (e.g., `contents: read` and only specific writes like `pull-requests: write` if needed).
ERROR	`.github/workflows/trigger-api-go-update.yml:16`	`security.gha.missing-explicit-permissions-temporal`	No explicit `GITHUB_TOKEN` permissions found at the workflow or job level. Add a `permissions:` block at the workflow root (applies to all jobs) or per job with least privilege (e.g., `contents: read` and only specific writes like `pull-requests: write` if needed).

Suppress findings

Add a noopengrep comment on the line before the finding:

# noopengrep: <rule-id>

## Related issues  ## What changed? - WISOTT - For more information, you can also view the relevant PR's: 1. Server PR: temporalio/temporal#10763 2. API PR: temporalio/api#808 ## Checklist  **Stability** - [ ] Breaking changes are marked with 💥 in the PR title and release notes - [ ] Changes to JSON output (`-o json` / `-o jsonl`) are treated as breaking changes **Design** - [ ] This feature does not depend on Cloud-only APIs or behavior (it works against an OSS server) - [x] New commands follow `temporal <noun> <verb>` structure (e.g. `temporal workflow start`) - [x] New flags are named after the API concept, not the implementation mechanism (good: `--search-attribute`, bad: `--index-field`) - [x] New flags don't duplicate an existing flag that serves the same purpose - [x] New flags do not have short aliases without strong justification - [ ] Experimental features are marked with `(Experimental)` in `commands.yaml` **Help text** (see style guide at the top of `commands.yaml`) - [ ] All flags shown in help text and examples are implemented and functional - [ ] Summaries use sentence case and have no trailing period - [ ] Long descriptions end with a period and include at least one example invocation - [ ] Examples use long flags (`--namespace`, not `-n`), one flag per line - [ ] Placeholder values use `YourXxx` form (`YourWorkflowId`, `YourNamespace`) **Behavior** - [x] Results go to stdout; errors and warnings go to stderr - [x] Error messages are lowercase with no trailing punctuation **Tests** - [x] Added functional test(s) (`SharedServerSuite`) - [ ] Added unit test(s) (`func TestXxx`) where applicable ## Manual tests **Setup** Requires a server that includes temporalio/temporal#10763 and a workflow whose Task Queue is present in the target Worker Deployment Version. ```bash temporal server start-dev --headless temporal workflow start \ --type YourWorkflowType \ --task-queue YourTaskQueue \ --workflow-id YourWorkflowId ``` Use an existing Worker Deployment Version for the target: ```text Deployment name: YourDeploymentName Build ID: YourBuildId ``` **Happy path** ```bash temporal workflow update-options \ --workflow-id YourWorkflowId \ --versioning-override-behavior one_time \ --versioning-override-deployment-name YourDeploymentName \ --versioning-override-build-id YourBuildId ``` Expected output: ```text Update workflow options succeeded ``` Verify table output: ```bash temporal workflow describe \ --workflow-id YourWorkflowId ``` Expected: `OverrideBehavior` is `OneTime`, with `OverrideTargetVersionDeploymentName` and `OverrideTargetVersionBuildId` set. Verify JSON output: ```bash temporal workflow describe \ --workflow-id YourWorkflowId \ --output json ``` Expected: `versioningInfo.versioningOverride.oneTime.targetDeploymentVersion` contains the deployment name and build ID. **Error case** ```bash temporal workflow update-options \ --workflow-id YourWorkflowId \ --versioning-override-behavior one_time ``` Expected: ```text Error: missing deployment name and/or build id with 'one_time' behavior ``` ```bash echo $? ``` Expected: ```text 1 ``` **Composition** ```bash temporal workflow update-options \ --query 'WorkflowId = "YourWorkflowId"' \ --yes \ --versioning-override-behavior one_time \ --versioning-override-deployment-name YourDeploymentName \ --versioning-override-build-id YourBuildId ``` Expected: a batch update-options job is started. Use `temporal batch describe` to inspect the batch, then `temporal workflow describe` on an affected Workflow Execution to verify the one-time override.

Add one-time versioning override API

39d3ef8

Shivs11 requested review from a team June 17, 2026 22:31

Shivs11 added 3 commits June 17, 2026 18:38

Rename one-time versioning override type

4766bf7

Clarify one-time override routing comment

f9ce673

Clarify one-time override completion semantics

daa1442

yiminc reviewed Jun 17, 2026

View reviewed changes

rkannan82 reviewed Jun 18, 2026

View reviewed changes

Comment thread temporal/api/workflow/v1/message.proto

Shivs11 mentioned this pull request Jun 19, 2026

Add one-time move versioning override CLI support temporalio/cli#1093

Merged

17 tasks

Suppress linter for one-time override field

0553ec2

Shivs11 mentioned this pull request Jun 22, 2026

Add one-time versioning override SDK support temporalio/sdk-go#2414

Merged

rkannan82 approved these changes Jun 24, 2026

View reviewed changes

Sushisource approved these changes Jun 24, 2026

View reviewed changes

Clarify one-time override behavior

dd0cd16

Shivs11 and others added 2 commits June 24, 2026 16:51

Clarify override comment semantics

c24a2a0

Merge branch 'main' into ss/one-time-versioning-override-api

d52dd8a

Shivs11 merged commit 29fc423 into main Jun 25, 2026
4 checks passed

Shivs11 deleted the ss/one-time-versioning-override-api branch June 25, 2026 00:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add one-time move to the versioning override API!#808

Add one-time move to the versioning override API!#808
Shivs11 merged 8 commits into
mainfrom
ss/one-time-versioning-override-api

Shivs11 commented Jun 17, 2026 •

edited

Loading

Uh oh!

yiminc Jun 17, 2026

Uh oh!

Shivs11 Jun 17, 2026 •

edited

Loading

Uh oh!

Uh oh!

Sushisource left a comment

Uh oh!

github-actions Bot commented Jun 24, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

Shivs11 commented Jun 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yiminc Jun 17, 2026

Choose a reason for hiding this comment

Uh oh!

Shivs11 Jun 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Sushisource left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jun 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Opengrep — new findings

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Shivs11 commented Jun 17, 2026 •

edited

Loading

Shivs11 Jun 17, 2026 •

edited

Loading

github-actions Bot commented Jun 24, 2026 •

edited

Loading