Skip to content

Update deployment target in Agents CLI command - #2233

Merged
joefernandez merged 2 commits into
google:mainfrom
cfisher440:patch-1
Sep 19, 2026
Merged

joefernandez merged 2 commits into
google:mainfrom
cfisher440:patch-1

Conversation

@cfisher440

Copy link
Copy Markdown
Contributor

agent_engine is not a valid option. It has to be either agent_runtime, cloud_run, gke, or none.

agent_engine is not a valid option. It has to be either `agent_runtime`, `cloud_run`, `gke`, or `none`.
@netlify

netlify Bot commented Sep 14, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for adk-docs-preview ready!

Name Link
🔨 Latest commit 8c58709
🔍 Latest deploy log https://app.netlify.com/projects/adk-docs-preview/deploys/6aae0e142df84f0008c681e7
😎 Deploy Preview https://deploy-preview-2233--adk-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@google-cla

google-cla Bot commented Sep 14, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@joefernandez joefernandez left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

thanks for the update!

@joefernandez

Copy link
Copy Markdown
Collaborator

Technical review report

  • Review Score: 98
  • Overall assessment: 🟢 Low Risk
  • Summary reasoning: The change is a correct one-word bug fix. The old value agent_engine is not an accepted choice for --deployment-target in the currently released Agents CLI (v1.6.1); the flag is a click.Choice over DEPLOYMENT_TARGETS, whose keys are exactly agent_runtime, cloud_run, gke, none (template.py#L398-L415, wired in at cli_options.py#L86-L91). The documented command as it stands today therefore fails with a Click usage error; the PR makes it run. There is no alias mapping agent_engine to agent_runtime anywhere in the scaffold path.
  • Recommended action: Approve. The fix corrects a command that cannot execute as documented, and agent_runtime is the right replacement for a page about deploying to Agent Runtime. The only findings are two pre-existing staleness issues elsewhere on the same page, outside this diff.
  • Number of lines changed: XS, 1
  • Number of files changed: 1

🟢 Low risk items

  • Pre-existing, not in this diff — stale config file name. agents-cli.md:167 says "The command reads your deployment_target from pyproject.toml". In v1.6.1, agents-cli deploy dispatches on the target in agents-cli-manifest.yaml (cmd_deploy.py#L556, error text at #L148); the [tool.agents-cli] section in pyproject.toml is explicitly legacy and gets migrated out (upgrade.py#L763). Suggested change:

    ```suggestion
        The command reads your `deployment_target` from `agents-cli-manifest.yaml`
        and deploys
    ```
  • Pre-existing, not in this diff — stale generated-project listing. agents-cli.md:208 shows app/agent_engine_app.py in the post-scaffold tree. No file matching agent_engine_app* exists anywhere in the v1.6.1 scaffold templates, and the listing omits the agents-cli-manifest.yaml that the base template now writes (base_templates/_shared/agents-cli-manifest.yaml). Worth a follow-up refresh of that block; it does not block this PR.

Nothing else: the changed line is the only occurrence of a --deployment-target value in the repo, so no sibling page falls out of sync with this edit.

@joefernandez
joefernandez merged commit f653466 into google:main Sep 19, 2026
10 of 12 checks passed
zyantw pushed a commit to zyantw/adk-docs that referenced this pull request Sep 24, 2026
agent_engine is not a valid option. It has to be either `agent_runtime`, `cloud_run`, `gke`, or `none`.

Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
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