[unionai-docsy-agent]

What changed in the product and which signal asked for docs

flyte-sdk renamed flyte.deploy()'s dry-run keyword from dryrun to dry_run in flyteorg/flyte-sdk#1573 (commit c06a0a72). The change first shipped in v2.8.0. The old name still works, but from v2.8.0 it is a deprecated alias that raises a FutureWarning. Releases before v2.8.0 accept only dryrun.

Signal 3483 is the follow-up work left over when #1884 merged. Most of that work belongs in unionai/unionai-examples, not in this repo:

1. deploy_examples.py, deployment-plan fragment: change the assertion to len(deployments) == 1 and len(deployments[0].envs) == 2, then restore the embed on how-app-deployment-works.md.
2. deploy_examples.py, full-deployment fragment: remove the extra app.activate() call and change dryrun=False to dry_run=False.
3. activation_examples.py: remove or rewrite the activate-after-deployment fragment, which no page embeds any more.

None of those changes are in this PR. They have to land in unionai-examples first and then be picked up here with a submodule bump. Restoring the deployment-plan embed should wait for fix 1. If it were restored now, the page would show the wrong len(deployments) == 2 assertion.

Page changed

content/user-guide/apps/serve-and-deploy-apps/how-app-deployment-works.md, under Best practices:

• The "Use dry-run" item now says dry_run=True instead of dryrun=True. It also says that dry_run needs flyte v2.8.0 or later and that earlier versions take dryrun. From v2.8.0, dryrun is a deprecated alias that raises a FutureWarning. The item also notes that the "Example: Full deployment configuration" embed above it still uses dryrun, so readers aren't left with two keyword names on one page and no explanation.
• The list skipped item 6 (it went 5 → 7). Items 7–9 are renumbered 6–8.

Evidence

• In flyteorg/flyte-sdk, git tag --contains c06a0a72 lists v2.8.0 as the earliest tag.
• At v2.7.2, src/flyte/_deploy.py declares only dryrun: bool = False on deploy().
• At v2.8.0, the same file declares dry_run: bool = False and dryrun: bool | None = None. The docstring calls dryrun a "Deprecated alias for dry_run, kept for backwards compatibility". Later tags have the same signature, including v2.12.4, v2.12.5 and v2.13.0.
• Running against flyte==2.13.0, the latest release, inspect.signature(flyte.deploy) lists both parameters. Calling flyte.deploy(env, dryrun=True) raised FutureWarning: flyte.deploy(dryrun=...) is deprecated, use flyte.deploy(dry_run=...) instead.
• The September 2026 release notes in this repo (content/release-notes/2026-09.md) also record the deprecation.
• The full-deployment fragment in unionai-examples at the pinned submodule commit (fdf2e261) calls flyte.deploy(..., dryrun=False, ...).

Open questions / known gaps

• Until the unionai-examples change lands, the embedded "Example: Full deployment configuration" still shows dryrun=False and an unneeded app.activate(). The best-practices item points out the dryrun mismatch. Once fix 2 lands and the submodule is bumped, that sentence should be removed.
• An example is needed: the deployment-plan fragment, corrected as in item 1 above, before its embed goes back into the "Deployment plan" section.
• These docs don't set a minimum flyte SDK version for the 2.x guide as a whole. Because dry_run= raises a TypeError before v2.8.0, the item states the version condition directly. If the docs adopt a site-wide minimum of v2.8.0 or later, the version note can go.

Pre-flight review

Docsy's reviewer read this draft before it was opened and found 4 problems to fix. The draft was amended for them, and a check of the amendment found nothing left to fix.

Its optional suggestions, which the page doesn't need to be right; take them or not:

• content/user-guide/apps/serve-and-deploy-apps/how-app-deployment-works.md line 86: content/user-guide/tasks/task-deployment/deploy-command-options.md (around line 315) has a hand-written Python block in this repo, not an embed, that passes dryrun=False # Set to True for dry run to flyte.deploy(). Unlike the embedded example on this page, that block can be fixed in this PR with no unionai-examples change. A note: the analytics.deploy(dryrun=True) mention in factories/materialize.md is a different API, and this review didn't check it.

---

Docsy case 3483: https://docsy.apps.demo.hosted.unionai.cloud/cases/3483

_{Drafted by Docsy, Union.ai's documentation agent, from the product changes and requests in this case. Review it like any PR; close it if it's not wanted.}

[github-actions]

GHA build & deploy preview

Built by .github/workflows/build-pr.yml and deployed to the docs CF Pages project by .github/workflows/deploy-pr-preview.yml.

Branch alias	https://pr-1935-docsy-case-3483.docs-dog.pages.dev
This commit	https://30773314.docs-dog.pages.dev
Commit SHA	98aec6b1e61e6af4a7067f5081e40dbc5a2ec101

Updated automatically on every push.

[unionai-docsy-agent]

Docsy actions: what Docsy did on this PR, and at whose direction. Docsy adds a line for each.

• 2026-11-09 13:51 UTC · merged it (squash), after marking it ready for review, without an approving review · at the direction of Peeter Piegaze (ppiegaze)

[Copilot]

🟢 Approval recommended

No active review issues are reported for the deployment-guide compatibility clarification and numbering fixes.

No open issues 🎉

What changed in this PR

Updates the app deployment guide to recommend dry_run=True while explaining compatibility with older Flyte SDK releases.

Changes:

• Documents the v2.8.0 requirement, deprecated dryrun alias, and its continued use in the embedded example.
• Corrects the best-practices list numbering.

File	Description
content/​user-guide/​apps/​serve-and-deploy-apps/​how-app-deployment-works.md	Clarifies dry-run keyword compatibility and fixes list numbering.

_{Review effort: Balanced}